pluginbase.Objects.Syncable Namespace Reference

Namespaces
namespace	Entity
namespace	Validators
namespace	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
	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
	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
	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

SyncableBy

enum pluginbase.Objects.Syncable.SyncableBy : byte

strong

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

                           : byte
    {
        Unknown = 0,

        Owner = 1,

        ServerOnly = 2,

        Anyone = 3
    }

SyncableEndpoint

enum pluginbase.Objects.Syncable.SyncableEndpoint

strong

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

    {
        Unknown = 0,

        Client = 1,

        Server = 2,

        Both = Client | Server
    }

SyncableMode

enum pluginbase.Objects.Syncable.SyncableMode : int

strong

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

                             : int
    {
        ModifySync = 0,

        AlwaysSync,

        LowPriority,

        LowPriorityVariableSync,
    }

WatchableEncodeMode

enum pluginbase.Objects.Syncable.WatchableEncodeMode

strong

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

    {
        NormalPriority=0,

        LowPriority,

        BothPriority,

        Full,
    }