Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Objects.Syncable.SyncableAttribute Class Reference

Marks a field within a class as a target to be synchronized More...

Inheritance diagram for pluginbase.Objects.Syncable.SyncableAttribute:

Public Member Functions

 SyncableAttribute (SyncableBy syncableSecurity, SyncableMode mode=SyncableMode.ModifySync)
 Initializes a new instance of the pluginbase.Objects.Syncable.SyncableAttribute class. More...
 

Properties

int UpdateFrequency [get, set]
 Updates per second. Will not go higher than 15 (or max server FPS) Update frequency of the field. Only available on low-priority, variable-frequency mode More...
 
SyncableBy SyncableBy [get, set]
 Important to the server only: Who can change the values More...
 
bool LowPriority [get]
 Whether or not the property can be sync'd via low priority. If true, data COULD be sent over LP if all other data is also marked LP-enabled More...
 
SyncableMode Mode [get, set]
 When and how to sync More...
 

Detailed Description

Marks a field within a class as a target to be synchronized

Attribute: AttributeUsage(AttributeTargets.Field, AllowMultiple = false)

Constructor & Destructor Documentation

pluginbase.Objects.Syncable.SyncableAttribute.SyncableAttribute ( SyncableBy  syncableSecurity,
SyncableMode  mode = SyncableMode.ModifySync 
)

Initializes a new instance of the pluginbase.Objects.Syncable.SyncableAttribute class.

Parameters
syncableSecuritySyncable security.
modeMode.
57  {
58  SyncableBy = syncableSecurity;
59  UpdateFrequency = 5;
60  Mode = mode;
61  }
SyncableMode Mode
When and how to sync
Definition: SyncableAttribute.cs:49
SyncableBy SyncableBy
Important to the server only: Who can change the values
Definition: SyncableAttribute.cs:26
int UpdateFrequency
Updates per second. Will not go higher than 15 (or max server FPS) Update frequency of the field...
Definition: SyncableAttribute.cs:18

Property Documentation

bool pluginbase.Objects.Syncable.SyncableAttribute.LowPriority
get

Whether or not the property can be sync'd via low priority. If true, data COULD be sent over LP if all other data is also marked LP-enabled

true if low priority enabled; otherwise, false.

SyncableMode pluginbase.Objects.Syncable.SyncableAttribute.Mode
getset

When and how to sync

The mode.

SyncableBy pluginbase.Objects.Syncable.SyncableAttribute.SyncableBy
getset

Important to the server only: Who can change the values

The syncable by.

int pluginbase.Objects.Syncable.SyncableAttribute.UpdateFrequency
getset

Updates per second. Will not go higher than 15 (or max server FPS) Update frequency of the field. Only available on low-priority, variable-frequency mode

The update frequency.


The documentation for this class was generated from the following file: