NetworkObject Methods
The NetworkObject type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
ConfigureNetworkInput |
Configures the network input behavior.
|
|
|
ExecuteNetworkProcess |
Executes the network processing if the network has been initialized and the instance was identified.
|
|
|
GetBehaviorMode |
Retrieves the current behavior mode.
|
|
|
GetClient |
Retrieves the client associated with this network element.
|
|
|
GetInput<(Of <<'(T>)>>) |
Retrieves the input value of a specified type and name.
|
|
|
GetNetworkElement |
Retrieves the network element associated with the current instance.
|
|
|
GetNetworkId |
Retrieves the network ID associated with the network element.
|
|
|
GetTransport |
Retrieves the current network transport instance.
|
|
|
HasEvent |
Checks if an event with the specified event code is present.
|
|
|
HasNetworkElement |
Checks if the network element has been created.
|
|
|
InitializeSerializableAttributes |
Initializes the serializable attributes for position, rotation, and scale synchronization.
|
|
|
InitializeSynchonizedFields |
This method create all network variables from variables flagged to be synchronized
|
|
|
InternalNetworkAwake |
Called when the network is being initialized.
This is a virtual method that can be overridden by derived classes to perform custom actions upon network awakening.
|
|
|
InternalNetworkFixedUpdate |
Called at a fixed time interval determined by the physics engine.
This is a virtual method that can be overridden by derived classes to perform custom actions in sync with the physics engine's update cycle.
|
|
|
InternalNetworkLateUpdate |
Called after all Update functions have been called.
This is a virtual method that can be overridden by derived classes to perform custom actions after the network update phase, such as post-processing actions.
|
|
|
InternalNetworkStart |
Called when the network starts.
This is a virtual method that can be overridden by derived classes to perform custom actions at the start of the network lifecycle.
|
|
|
InternalNetworkUpdate |
Called every frame while the network is active.
This is a virtual method that can be overridden by derived classes to perform custom actions during the network update phase.
|
|
|
InvokeEvent |
Invokes an event with the specified event code and passes a data stream to it.
|
|
|
IsNetworkInitialized |
Checks if the network has been initialized.
|
|
|
IsOwner |
Checks if the current instance is the owner of the network element.
|
|
|
IsPlayer |
Checks if this network element represents a player.
|
|
|
RegisterEvent |
Registers a callback action for a specific event code.
|
|
|
RegisterInput<(Of <<'(T>)>>) |
Registers an input with a specified name and type.
|
|
|
RegisterSynchronizedVariable |
Register a network variuable to be synchronized on clients
|
|
|
Send |
This will send a messages targered to this object on network
This event will be redirected to the target network object
|
|
|
SendObjectEvent |
This will send a messages targered to this object on network
This event will be redirected to the target network object
|
|
|
SetAnimationDefaultStatus |
Sets the default status for animations.
|
|
|
SetAnimationLayerCount |
Sets the count of animation layers.
|
|
|
SetBehaviorMode |
Sets the behavior mode for the network element and updates the element if it exists.
|
|
|
SetClient |
Sets the client associated with this network element.
|
|
|
SetDeliveryMode |
Sets the delivery mode for the network element and updates the element if it exists.
|
|
|
SetIdentified |
Sets the identified state of the network element.
|
|
|
SetIsPlayer |
Sets the state indicating whether this network element represents a player.
|
|
|
SetNetworkId |
Sets the network ID for the network element if it exists.
|
|
|
SetRemoteControlsEnabled |
Enables or disables remote controls.
|
|
|
SetSendRate |
Sets the send rate and updates the network element's active rate if it exists.
|
|
|
SetSyncAnimation |
Sets the synchronization state for animations.
|
|
|
SetSyncAnimationMode |
Sets the synchronization mode for animations.
|
|
|
SetSyncParticles |
Sets the synchronization state for particles.
|
|
|
SetTransport |
Sets the network transport and updates the transport for the network element if it exists.
|
|
|
StartNetwork |
Initializes the network by creating network elements and registering the object with the internal network executor.
|
|
|
UnregisterEvent |
Unregisters a previously registered event using its event code.
|
|
|
WasIdentified |
Checks if the network element has been identified.
|