AtomicNET : AtomicEngine Namespace

NetworkPriority Class

%Network interest management settings component.

Syntax

public class NetworkPriority : Component

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from Component.

Public Constructors

Documentation for this section has not yet been entered.
Construct.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

AlwaysUpdateOwner bool . Documentation for this section has not yet been entered.
AnimationEnabled bool . Documentation for this section has not yet been entered. (Inherited from Animatable.)
[write-only]
AnimationTime float . Documentation for this section has not yet been entered. (Inherited from Animatable.)
BasePriority float . Documentation for this section has not yet been entered.
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
DistanceFactor float . Documentation for this section has not yet been entered.
Enabled bool . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
EnabledEffective bool . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
ID uint . Documentation for this section has not yet been entered. (Inherited from Component.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
MinPriority float . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Node Node . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
NumAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
NumNetworkAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
ObjectAnimation ObjectAnimation . Documentation for this section has not yet been entered. (Inherited from Animatable.)
[read-only]
Scene Scene . Documentation for this section has not yet been entered. (Inherited from Component.)
Temporary bool . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
AllocateNetworkState ()
Allocate network attribute state. (Inherited from Serializable.)
ApplyAttributes ()
Apply attribute changes that can not be applied immediately. Called after scene load or a network update. (Inherited from Serializable.)
CleanupConnection (Connection)
Clean up all references to a network connection that is about to be removed. (Inherited from Component.)
static
csb_Atomic_NetworkPriority_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
DrawDebugGeometry (DebugRenderer, bool)
Visualize the component as debug geometry. (Inherited from Component.)
GetAlwaysUpdateOwner () : bool
Return whether updates to owner should be sent always at full rate.
GetAnimationEnabled () : bool
Return animation enabled. (Inherited from Animatable.)
GetAttributeAnimation (string) : ValueAnimation
Return attribute animation. (Inherited from Animatable.)
GetAttributeAnimationSpeed (string) : float
Return attribute animation speed. (Inherited from Animatable.)
GetAttributeAnimationTime (string) : float
Return attribute animation time position. (Inherited from Animatable.)
GetAttributeAnimationWrapMode (string) : WrapMode
Return attribute animation wrap mode. (Inherited from Animatable.)
GetBasePriority () : float
Return base priority.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetComponent (StringHash) : Component
Return component in the same scene node by type. If there are several, returns the first. (Inherited from Component.)
GetComponent<T> (bool) : T
Documentation for this section has not yet been entered. (Inherited from Component.)
GetComponents (Vector<Component>, StringHash)
Return components in the same scene node by type. (Inherited from Component.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetDependencyNodes (Vector<Node>)
Return the depended on nodes to order network updates. (Inherited from Component.)
GetDistanceFactor () : float
Return priority reduction distance factor.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetID () : uint
Return ID. (Inherited from Component.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetInterceptNetworkUpdate (string) : bool
Return whether an attribute's network updates are being intercepted. (Inherited from Serializable.)
GetMinPriority () : float
Return minimum priority.
GetNode () : Node
Return scene node. (Inherited from Component.)
GetNumAttributes () : uint
Return number of attributes. (Inherited from Serializable.)
GetNumNetworkAttributes () : uint
Return number of network replication attributes. (Inherited from Serializable.)
GetObjectAnimation () : ObjectAnimation
Return object animation. (Inherited from Animatable.)
GetScene () : Scene
Return the scene the node belongs to. (Inherited from Component.)
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsEnabled () : bool
Return whether is enabled. (Inherited from Component.)
IsEnabledEffective () : bool
Return whether is effectively enabled (node is also enabled.) (Inherited from Component.)
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsTemporary () : bool
Return whether is temporary. (Inherited from Serializable.)
Load (Deserializer, bool) : bool
Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. (Inherited from Serializable.)
override
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Component.)
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Serializable.)
OnSetEnabled ()
Handle enabled/disabled state change. (Inherited from Component.)
PrepareNetworkUpdate ()
Prepare network update by comparing attributes and marking replication states dirty as necessary. (Inherited from Component.)
ReadDeltaUpdate (Deserializer) : bool
Read and apply a network delta update. Return true if attributes were changed. (Inherited from Serializable.)
ReadLatestDataUpdate (Deserializer) : bool
Read and apply a network latest data update. Return true if attributes were changed. (Inherited from Serializable.)
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
Remove ()
Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. (Inherited from Component.)
RemoveAttributeAnimation (string)
Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer. (Inherited from Animatable.)
RemoveInstanceDefault ()
Remove instance's default values if they are set previously. (Inherited from Serializable.)
RemoveObjectAnimation ()
Remove object animation. Same as calling SetObjectAnimation with a null pointer. (Inherited from Animatable.)
ResetToDefault ()
Reset all editable attributes to their default values. (Inherited from Serializable.)
override
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Component.)
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Serializable.)
SaveDefaultAttributes () : bool
Return whether should save default-valued attributes into XML. Default false. (Inherited from Serializable.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAlwaysUpdateOwner (bool)
Set whether updates to owner should be sent always at full rate. Default true.
SetAnimationEnabled (bool)
Set automatic update of animation, default true. (Inherited from Animatable.)
SetAnimationTime (float)
Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttributeAnimation (string, ValueAnimation, WrapMode, float)
Set attribute animation. (Inherited from Animatable.)
SetAttributeAnimationSpeed (string, float)
Set attribute animation speed. (Inherited from Animatable.)
SetAttributeAnimationTime (string, float)
Set attribute animation time position manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttributeAnimationWrapMode (string, WrapMode)
Set attribute animation wrap mode. (Inherited from Animatable.)
SetBasePriority (float)
Set base priority. Default 100 (send updates at full frequency.)
SetDistanceFactor (float)
Set priority reduction distance factor. Default 0 (no effect.)
SetEnabled (bool)
Set enabled/disabled state. (Inherited from Component.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetInterceptNetworkUpdate (string, bool)
Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction. (Inherited from Serializable.)
SetMinPriority (float)
Set minimum priority. Default 0 (no updates when far away enough.)
SetObjectAnimation (ObjectAnimation)
Set object animation. (Inherited from Animatable.)
SetTemporary (bool)
Set temporary flag. Temporary objects will not be saved. (Inherited from Serializable.)
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)
WriteInitialDeltaUpdate (Serializer, byte)
Write initial delta network update. (Inherited from Serializable.)
WriteLatestDataUpdate (Serializer, byte)
Write a latest data network update. (Inherited from Serializable.)

Member Details

NetworkPriority Constructor

Documentation for this section has not yet been entered.

Syntax

public NetworkPriority ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NetworkPriority Constructor

Construct.

Syntax

public NetworkPriority (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AlwaysUpdateOwner Property

Documentation for this section has not yet been entered.

Syntax

public bool AlwaysUpdateOwner { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BasePriority Property

Documentation for this section has not yet been entered.

Syntax

public float BasePriority { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_NetworkPriority_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_NetworkPriority_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

DistanceFactor Property

Documentation for this section has not yet been entered.

Syntax

public float DistanceFactor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAlwaysUpdateOwner Method

Return whether updates to owner should be sent always at full rate.

Syntax

public bool GetAlwaysUpdateOwner ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetBasePriority Method

Return base priority.

Syntax

public float GetBasePriority ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDistanceFactor Method

Return priority reduction distance factor.

Syntax

public float GetDistanceFactor ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMinPriority Method

Return minimum priority.

Syntax

public float GetMinPriority ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

MinPriority Property

Documentation for this section has not yet been entered.

Syntax

public float MinPriority { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetAlwaysUpdateOwner Method

Set whether updates to owner should be sent always at full rate. Default true.

Syntax

public void SetAlwaysUpdateOwner (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetBasePriority Method

Set base priority. Default 100 (send updates at full frequency.)

Syntax

public void SetBasePriority (float priority)

Parameters

priority
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetDistanceFactor Method

Set priority reduction distance factor. Default 0 (no effect.)

Syntax

public void SetDistanceFactor (float factor)

Parameters

factor
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetMinPriority Method

Set minimum priority. Default 0 (no updates when far away enough.)

Syntax

public void SetMinPriority (float priority)

Parameters

priority
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0