Urho3D::NetworkObject Class Reference

#include <Urho3D/Replica/NetworkObject.h>

Inheritance diagram for Urho3D::NetworkObject:

Public Member Functions
	NetworkObject (Context *context)
void	SetOwner (AbstractConnection *owner)
	Server-only: set owner connection which is allowed to send feedback for this object.
NetworkId	GetNetworkId () const
	Return current or last NetworkId. Return NetworkId::None if not registered.
ReplicationManager *	GetReplicationManager () const
NetworkId	GetParentNetworkId () const
NetworkObject *	GetParentNetworkObject () const
const ea::vector< WeakPtr< NetworkObject > > &	GetChildrenNetworkObjects () const
AbstractConnection *	GetOwnerConnection () const
unsigned	GetOwnerConnectionId () const
NetworkObjectMode	GetNetworkMode () const
bool	IsStandalone () const
bool	IsServer () const
bool	IsOwnedByThisClient () const
bool	IsReplicatedClient () const
void	UpdateObjectHierarchy ()
void	SetNetworkId (NetworkId networkId)
void	SetNetworkMode (NetworkObjectMode mode)
void	PrepareToRemove () override
Public Member Functions inherited from Urho3D::TrackedComponent< ReferencedComponentBase, NetworkObjectRegistry >
	TrackedComponent (Context *context)
NetworkObjectRegistry *	GetRegistry () const
bool	ShouldBeTrackedInRegistry () const override
void	ReconnectToRegistry () override
void	OnSetEnabled () override
Public Member Functions inherited from Urho3D::ReferencedComponentBase
	ReferencedComponentBase (Context *context)
void	SetReference (ComponentReference reference)
ComponentReference	GetReference () const
Public Member Functions inherited from Urho3D::TrackedComponentBase
	TrackedComponentBase (Context *context)
virtual bool	ShouldBeTrackedInRegistry () const
	Returns whether the component should be tracked by the registry.
void	SetIndexInArray (unsigned index)
unsigned	GetIndexInArray () const
bool	IsTrackedInRegistry () const
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
	~Component () override
	Destruct.
AttributeScopeHint	GetEffectiveScopeHint () const
bool	Save (Serializer &dest) const override
	Save as binary data. Return true if successful.
bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful.
bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful.
virtual void	GetDependencyNodes (ea::vector< Node * > &dest)
	Return the depended on nodes to order network updates.
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry.
virtual bool	HasAuxiliaryData () const
virtual void	SerializeAuxiliaryData (Archive &archive)
	Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
void	SetEnabled (bool enable)
void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned	GetID () const
Node *	GetNode () const
Scene *	GetScene () const
	Return the scene the node belongs to.
bool	IsEnabled () const
bool	IsEnabledEffective () const
ea::string	GetFullNameDebug () const
	Return full component name for debugging. Unique for each component in the scene. Slow!
Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.
template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.
unsigned	GetIndexInParent () const
	Return index of this component in the node.
Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.
	~Serializable () override
	Destruct.
virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual ObjectReflection *	GetReflection () const
	Return reflection used for serialization.
virtual const ea::vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.
void	SerializeInBlock (Archive &archive) override
	Serialize content from/to archive. May throw ArchiveException.
void	SerializeInBlock (Archive &archive, bool serializeTemporary)
virtual bool	Load (Deserializer &source)
	Load from binary data. Return true if successful.
virtual bool	LoadXML (const XMLElement &source)
	Load from XML data. Return true if successful.
virtual bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful.
virtual bool	Load (const ea::string &resourceName)
	Load from binary resource.
virtual bool	LoadXML (const ea::string &resourceName)
	Load from XML resource.
virtual bool	LoadJSON (const ea::string &resourceName)
	Load from JSON resource.
virtual bool	LoadFile (const ea::string &resourceName)
	Load from resource of automatically detected type.
virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual bool	SaveDefaultAttributes (const AttributeInfo &attr) const
	Return whether should save default-valued attributes into XML. Default false.
bool	SetAttribute (unsigned index, const Variant &value)
bool	SetAttribute (const ea::string &name, const Variant &value)
	Set attribute by name. Return true if successfully set.
void	SetInstanceDefault (bool enable)
	(Internal use) Set instance-level default flag.
void	SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
	(Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
virtual Variant	GetInstanceDefault (const ea::string &name) const
	(Internal use) Get instance-level default value.
void	ResetToDefault ()
	Reset all editable attributes to their default values.
void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.
void	SetTemporary (bool enable)
Variant	GetAttribute (unsigned index) const
Variant	GetAttribute (const ea::string &name) const
	Return attribute value by name. Return empty if not found.
Variant	GetAttributeDefault (unsigned index) const
Variant	GetAttributeDefault (const ea::string &name) const
	Return attribute default value by name. Return empty if not found.
unsigned	GetNumAttributes () const
void	CopyAttributes (const Serializable *source, bool resetToDefault=true)
	Copy all attributes from another serializable.
bool	IsTemporary () const
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.
Public Member Functions inherited from Urho3D::NetworkCallback
virtual void	InitializeStandalone ()
	Initialize object in standalone mode when neither server nor client is running.
virtual void	Update (float replicaTimeStep, float inputTimeStep)
	Process generic network update.
Public Member Functions inherited from Urho3D::ServerNetworkCallback
virtual void	InitializeOnServer ()
	Perform initialization. Called once.
virtual ea::optional< NetworkObjectRelevance >	GetRelevanceForClient (AbstractConnection *connection)
virtual void	UpdateTransformOnServer ()
	Called when world transform or parent of the object is updated in Server mode.
virtual void	WriteSnapshot (NetworkFrame frame, Serializer &dest)
	Write full snapshot.
virtual bool	PrepareReliableDelta (NetworkFrame frame)
	Prepare for reliable delta update and return update mask. If mask is zero, reliable delta update is skipped.
virtual void	WriteReliableDelta (NetworkFrame frame, Serializer &dest)
	Write reliable delta update. Delta is applied to previous delta or snapshot.
virtual bool	PrepareUnreliableDelta (NetworkFrame frame)
	Prepare for unreliable delta update and return update mask. If mask is zero, unreliable delta update is skipped.
virtual void	WriteUnreliableDelta (NetworkFrame frame, Serializer &dest)
	Write unreliable delta update.
virtual void	ReadUnreliableFeedback (NetworkFrame feedbackFrame, Deserializer &src)
	Read unreliable feedback from client.
Public Member Functions inherited from Urho3D::ClientNetworkCallback
virtual void	InitializeFromSnapshot (NetworkFrame frame, Deserializer &src, bool isOwned)
	Read full snapshot and initialize object. Called once.
virtual void	InterpolateState (float replicaTimeStep, float inputTimeStep, const NetworkTime &replicaTime, const NetworkTime &inputTime)
	Interpolate replicated state.
virtual void	ReadReliableDelta (NetworkFrame frame, Deserializer &src)
	Read reliable delta update. Delta is applied to previous reliable delta or snapshot message.
virtual void	ReadUnreliableDelta (NetworkFrame frame, Deserializer &src)
	Read unreliable delta update.
virtual bool	PrepareUnreliableFeedback (NetworkFrame frame)
	Prepare for unreliable feedback and return feedback mask. If mask is zero, unreliable feedback is skipped.
virtual void	WriteUnreliableFeedback (NetworkFrame frame, Serializer &dest)
	Write unreliable feedback from client.

Static Public Member Functions
static void	RegisterObject (Context *context)
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
NetworkObject *	GetOtherNetworkObject (NetworkId networkId) const
void	SetParentNetworkObject (NetworkId parentNetworkId)
void	OnNodeSet (Node *previousNode, Node *currentNode) override
void	OnMarkedDirty (Node *node) override
	Handle scene node transform dirtied.
Protected Member Functions inherited from Urho3D::TrackedComponent< ReferencedComponentBase, NetworkObjectRegistry >
void	OnSceneSet (Scene *scene) override
Protected Member Functions inherited from Urho3D::Component
virtual void	OnNodeSetEnabled (Node *node)
	Handle scene node enabled status changing.
void	SetID (unsigned id)
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
void	DoAutoRemove (AutoRemoveMode mode)
	Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.

Private Member Functions
	URHO3D_OBJECT (NetworkObject, ReferencedComponentBase)
NetworkObject *	FindParentNetworkObject () const
void	AddChildNetworkObject (NetworkObject *networkObject)
void	RemoveChildNetworkObject (NetworkObject *networkObject)

Private Attributes
NetworkObjectMode	networkMode_ {}
	ReplicationManager corresponding to the NetworkObject.
WeakPtr< AbstractConnection >	ownerConnection_ {}
WeakPtr< NetworkObject >	parentNetworkObject_
ea::vector< WeakPtr< NetworkObject > >	childrenNetworkObjects_

Additional Inherited Members
Protected Attributes inherited from Urho3D::Component
Node *	node_
	Scene node.
unsigned	id_
	Unique ID within the scene.
bool	networkUpdate_
	Network update queued flag.
bool	enabled_
	Enabled flag.
Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMap >	instanceDefaultValues_
	Attribute default value at each instance level.
bool	setInstanceDefault_
	When true, store the attribute value as instance's default value (internal use only).
bool	temporary_
	Temporary flag.
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Base component of Network-replicated object.

Each NetworkObject has ID unique within the owner Scene. Derive from NetworkObject to have custom network logic. Don't create more than one NetworkObject per Node.

Hierarchy is updated after NetworkObject node is dirtied.

Member Function Documentation

GetNetworkMode()

NetworkObjectMode Urho3D::NetworkObject::GetNetworkMode ( ) const

inline

Return network mode. Network mode is configured only after InitializeOnServer and InitializeFromSnapshot callbacks. Before these callbacks the object is considered Standalone. This is useful to prevent changes in already initialized objects.

OnNodeSet()

void Urho3D::NetworkObject::OnNodeSet ( Node *  previousNode, Node *  currentNode  )

overrideprotectedvirtual

Component implementation

Reimplemented from Urho3D::Component.

PrepareToRemove()

void Urho3D::NetworkObject::PrepareToRemove ( )

overridevirtual

Implement ClientNetworkCallback.

Reimplemented from Urho3D::ClientNetworkCallback.

UpdateObjectHierarchy()

void Urho3D::NetworkObject::UpdateObjectHierarchy

(

)

Internal API for ReplicationManager.

Member Data Documentation

parentNetworkObject_

WeakPtr<NetworkObject> Urho3D::NetworkObject::parentNetworkObject_

private

NetworkObject hierarchy

---

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

• Urho3D/Replica/NetworkObject.h
• Urho3D/Replica/NetworkObject.cpp