FrameworkZ API - FrameworkZ.Optimizations

Home / FrameworkZ.Optimizations Module

FrameworkZ.Optimizations

module

Optimizations module for FrameworkZ. Provides various performance enhancements.

0
Functions
30
Methods
4
Fields

📋 On This Page

Fields

4
FrameworkZ.Optimizations 📋 table
Optimizations module for FrameworkZ. Provides various performance enhancements.
Initial value: {}
FrameworkZ.Optimizations.Config ❓ unknown inferred
Initial value: { -- Player synchronization settings SyncInterval = 100, -- Ticks between sync updates (100 ticks = ~1 second) PositionSyncThreshold = 2.0, -- Minimum distance moved before forcing position sync -- Bandwidth optimization EnableDeltaSync = true, -- Only send changed data EnableCompression = true, -- Compress large data packets MaxPacketSize = 1024, -- Maximum packet size in bytes
FrameworkZ.Optimizations.IsInitialized ✅ boolean inferred
Initial value: false
FrameworkZ.Optimizations.Metrics 📋 table inferred
Initial value: { packetsSent = 0, packetsReceived = 0, bytesSent = 0, bytesReceived = 0, syncErrors = 0, resyncs = 0 }

Methods

30

FrameworkZ.Optimizations:ApplyFullSync(update)

method
Apply full sync update (client-side)

FrameworkZ.Optimizations:ApplyPositionUpdate(update)

method
Apply position update (client-side)

FrameworkZ.Optimizations:ApplyStatsUpdate(update)

method
Apply stats update (client-side)

FrameworkZ.Optimizations:ApplySyncUpdate(update)

method
Apply a sync update (client-side)

FrameworkZ.Optimizations:CalculateDistance(pos1, pos2)

method
Calculate distance between two positions

FrameworkZ.Optimizations:CleanupCache()

method
Clean up old cache entries

FrameworkZ.Optimizations:CompressData(data)

method
Compress data for transmission

FrameworkZ.Optimizations:EnableClientPrediction()

method
Enable client-side prediction

FrameworkZ.Optimizations:EstimateDataSize(data)

method
Estimate size of data in bytes

FrameworkZ.Optimizations:GetMetrics()

method
Get current metrics

FrameworkZ.Optimizations:HandleClientSync(command, player, args)

method
Handle client sync requests (server-side)

FrameworkZ.Optimizations:HandleServerSync(command, args)

method
Handle sync updates from server (client-side)

FrameworkZ.Optimizations:Initialize()

method
Initialize the optimizations module

FrameworkZ.Optimizations:InitializeClient()

method
Initialize client-side optimizations

FrameworkZ.Optimizations:InitializeServer()

method
Initialize server-side optimizations

FrameworkZ.Optimizations:InterpolatePosition(player, update)

method
Interpolate position for smooth movement

FrameworkZ.Optimizations:OnPlayerMove(player)

method
Handle player movement events

FrameworkZ.Optimizations:OnPlayerUpdate(player)

method
Handle player update events

FrameworkZ.Optimizations:OnTick()

method
Main tick update loop

FrameworkZ.Optimizations:PerformFullResync()

method
Perform a full resync of all players

FrameworkZ.Optimizations:ProcessBatchQueue()

method
Process the batch queue

FrameworkZ.Optimizations:QueuePositionSync(player)

method
Queue a position sync for a player

FrameworkZ.Optimizations:RequestFullResync(username)

method
Request a full resync from server (client-side)

FrameworkZ.Optimizations:ResetMetrics()

method
Reset metrics

FrameworkZ.Optimizations:SendBatchUpdate(batch)

method
Send a batched update to clients

FrameworkZ.Optimizations:SendFullPlayerSync(player)

method
Send full player sync data

FrameworkZ.Optimizations:SendSyncUpdate(data)

method
Send a single sync update

FrameworkZ.Optimizations:Shutdown()

method
Shutdown the optimizations module

FrameworkZ.Optimizations:UpdateCacheTimestamp(username)

method
Update cache timestamp

FrameworkZ.Optimizations:UpdateMetrics()

method
Update and log metrics