urho3d/Extras/LuaScript/pkgs/Network/NetworkPriority.pkg

$#include "NetworkPriority.h"

/// %Network interest management settings component.
class NetworkPriority : public Component
{
public:
    /// Set base priority. Default 100 (send updates at full frequency.)
    void SetBasePriority(float priority);
    /// Set priority reduction distance factor. Default 0 (no effect.)
    void SetDistanceFactor(float factor);
    /// Set minimum priority. Default 0 (no updates when far away enough.)
    void SetMinPriority(float priority);
    /// Set whether updates to owner should be sent always at full rate. Default true.
    void SetAlwaysUpdateOwner(bool enable);
    
    /// Return base priority.
    float GetBasePriority() const { return basePriority_; }
    /// Return priority reduction distance factor.
    float GetDistanceFactor() const { return distanceFactor_; }
    /// Return minimum priority.
    float GetMinPriority() const { return minPriority_; }
    /// Return whether updates to owner should be sent always at full rate.
    bool GetAlwaysUpdateOwner() const { return alwaysUpdateOwner_; }
    
    /// Increment and check priority accumulator. Return true if should update. Called by Connection.
    bool CheckUpdate(float distance, float& accumulator);
};