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

Namespaces

package  Entity
 
package  Validators
 
package  Watchers
 

Classes

class  BaseContext
 Base context for encoding and decoding More...
 
class  DecodeContext
 Context that describes how to decode the data in the syncable stream (mostly security stuff) More...
 
class  EncodeContext
 Context that defines how to encode the data within the syncables system More...
 
interface  INetSyncable
 An interface representing the base of a syncable network object More...
 
interface  INetWatcher
 An interface recognizing a class as being able to be watched More...
 
interface  IValidatedNetSyncable
 An interface that describes a syncable that has the ability to be validated and allows for validator attributes More...
 
interface  IValidator< in T >
 Interface for syncable objects that can have a validator attached to them More...
 
class  SyncableAttribute
 Marks a field within a class as a target to be synchronized More...
 
class  SyncableBase< T >
 The base class for any syncable More...
 
class  SyncableObject
 An object that acts as a base class for objects that want syncables as fields Most entities use this class More...
 
class  TypeSerializer
 Special type serializer that will work with plugins More...
 
class  ValidateAttribute
 Defines how validation occurs on a syncable More...
 
class  ValidatedSyncableBase< T, TBase >
 Base class helper for a syncable than can be validated More...
 

Enumerations

enum  WatchableEncodeMode { WatchableEncodeMode.NormalPriority =0, WatchableEncodeMode.LowPriority, WatchableEncodeMode.BothPriority, WatchableEncodeMode.Full }
 Under which mode is the encode context More...
 
enum  SyncableBy : byte { SyncableBy.Unknown = 0, SyncableBy.Owner = 1, SyncableBy.ServerOnly = 2, SyncableBy.Anyone = 3 }
 Enum to identify a target of a syncable More...
 
enum  SyncableEndpoint { SyncableEndpoint.Unknown = 0, SyncableEndpoint.Client = 1, SyncableEndpoint.Server = 2, SyncableEndpoint.Both = Client | Server }
 Enum representing the endpoint during synchronization More...
 
enum  SyncableMode : int { SyncableMode.ModifySync = 0, SyncableMode.AlwaysSync, SyncableMode.LowPriority, SyncableMode.LowPriorityVariableSync }
 The mode in which a syncable object will update over the network More...
 

Enumeration Type Documentation

Enum to identify a target of a syncable

Enumerator
Unknown 

Unknown/Undefiend

Owner 

The owner-client of the entity can sync, including the server

ServerOnly 

Only the server can sync

Anyone 

Anyone can sync this value

8  : byte
9  {
13  Unknown = 0,
14 
18  Owner = 1,
19 
23  ServerOnly = 2,
24 
28  Anyone = 3
29  }
Anyone can sync this value
The owner-client of the entity can sync, including the server

Enum representing the endpoint during synchronization

Attribute: Flags

Enumerator
Unknown 

Unknown/undefined

Client 

The client endpoint

Server 

The server endpoint

Both 

Both client and server

The mode in which a syncable object will update over the network

Enumerator
ModifySync 

Sync object only when it's modified (Default)

AlwaysSync 

Always send the updated value whenever data is passed

LowPriority 

Low priority modify sync

LowPriorityVariableSync 

Send updates over LP packets, while respecting the frequency

8  : int
9  {
13  ModifySync = 0,
14 
18  AlwaysSync,
19 
24 
29  }
Low network priority (UDP, etc)
Send updates over LP packets, while respecting the frequency
Sync object only when it's modified (Default)
Always send the updated value whenever data is passed

Under which mode is the encode context

Enumerator
NormalPriority 

Normal network priority

LowPriority 

Low network priority (UDP, etc)

BothPriority 

Both priorities

Full 

Full encoding of everything

10  {
15 
20 
25 
29  Full,
30  }
Low network priority (UDP, etc)
Full encoding of everything