AtomicNET : AtomicEngine Namespace

AObject Class

Base class for objects with type identification, subsystem access and event sending/receiving capability.

Syntax

public class AObject : RefCounted

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 RefCounted.

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

[read-only]
Category string . Documentation for this section has not yet been entered.
[read-only]
Context Context . Documentation for this section has not yet been entered.
[read-only]
EventSender AObject . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeName string . Documentation for this section has not yet been entered.
[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.

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.)
static
csb_Atomic_AObject_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
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.
GetContext () : Context
Return execution context.
GetEventSender () : AObject
Return active event sender. Null outside event handling.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetSubsystem (StringHash) : AObject
Return subsystem by type.
static
GetSubsystem<T> () : T
Documentation for this section has not yet been entered.
override
GetTypeName () : string
Return type name.
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
static
GetTypeNameStatic () : string
Documentation for this section has not yet been entered.
HasEventHandlers () : bool
Return whether has subscribed to any event.
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender.
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type.
override
IsObject () : bool
Documentation for this section has not yet been entered.
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
static
IsTypeOf (StringHash) : bool
Check current type is type of specified type.
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.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered.
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered.
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered.
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered.
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered.
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered.
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered.
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event.
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered.
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event.
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered.
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

AObject Constructor

Documentation for this section has not yet been entered.

Syntax

public AObject ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

AObject Constructor

Construct.

Syntax

public AObject (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

Category Property

Documentation for this section has not yet been entered.

Syntax

public string Category { get; }

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

Context Property

Documentation for this section has not yet been entered.

Syntax

public Context Context { get; }

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_AObject_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_AObject_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

EventSender Property

Documentation for this section has not yet been entered.

Syntax

public AObject EventSender { get; }

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

GetCategory Method

Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.

Syntax

public string GetCategory ()

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

GetContext Method

Return execution context.

Syntax

public Context GetContext ()

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

GetEventSender Method

Return active event sender. Null outside event handling.

Syntax

public AObject GetEventSender ()

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

GetSubsystem Method

Return subsystem by type.

Syntax

public AObject GetSubsystem (StringHash type)

Parameters

type
Documentation for this section has not yet been entered.

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

GetSubsystem<T> Generic Method

Documentation for this section has not yet been entered.

Syntax

public static T GetSubsystem<T> ()
where T : AtomicEngine.AObject

Type Parameters

T
Documentation for this section has not yet been entered.

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

GetTypeName Method

Return type name.

Syntax

public override string GetTypeName ()

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

GetTypeNameStatic Method

Documentation for this section has not yet been entered.

Syntax

public static string GetTypeNameStatic ()

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

HasEventHandlers Method

Return whether has subscribed to any event.

Syntax

public bool HasEventHandlers ()

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

HasSubscribedToEvent Method

Return whether has subscribed to an event without specific sender.

Syntax

public bool HasSubscribedToEvent (StringHash eventType)

Parameters

eventType
Documentation for this section has not yet been entered.

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

HasSubscribedToEvent Method

Return whether has subscribed to a specific sender's event.

Syntax

public bool HasSubscribedToEvent (AObject sender, StringHash eventType)

Parameters

sender
Documentation for this section has not yet been entered.
eventType
Documentation for this section has not yet been entered.

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

IsInstanceOf Method

Check current instance is type of specified type.

Syntax

public bool IsInstanceOf (StringHash type)

Parameters

type
Documentation for this section has not yet been entered.

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

IsObject Method

Documentation for this section has not yet been entered.

Syntax

public override bool IsObject ()

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

IsTypeOf Method

Check current type is type of specified type.

Syntax

public static bool IsTypeOf (StringHash type)

Parameters

type
Documentation for this section has not yet been entered.

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

SendEvent Method

Documentation for this section has not yet been entered.

Syntax

public void SendEvent (string eventType, ScriptVariantMap eventData)

Parameters

eventType
Documentation for this section has not yet been entered.
eventData
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

SubscribeToEvent Method

Documentation for this section has not yet been entered.

Syntax

public void SubscribeToEvent (string eventType, EventDelegate eventDelegate)

Parameters

eventType
Documentation for this section has not yet been entered.
eventDelegate
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

SubscribeToEvent Method

Documentation for this section has not yet been entered.

Syntax

public void SubscribeToEvent (uint eventType, EventDelegate eventDelegate)

Parameters

eventType
Documentation for this section has not yet been entered.
eventDelegate
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

SubscribeToEvent Method

Documentation for this section has not yet been entered.

Syntax

public void SubscribeToEvent (AObject sender, string eventType, EventDelegate eventDelegate)

Parameters

sender
Documentation for this section has not yet been entered.
eventType
Documentation for this section has not yet been entered.
eventDelegate
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

SubscribeToEvent Method

Documentation for this section has not yet been entered.

Syntax

public void SubscribeToEvent (AObject sender, uint eventType, EventDelegate eventDelegate)

Parameters

sender
Documentation for this section has not yet been entered.
eventType
Documentation for this section has not yet been entered.
eventDelegate
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

SubscribeToEvent<T> Generic Method

Documentation for this section has not yet been entered.

Syntax

public void SubscribeToEvent<T> (NativeEventDelegate<T> eventDelegate)
where T : AtomicEngine.NativeEventData

Type Parameters

T
Documentation for this section has not yet been entered.

Parameters

eventDelegate
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

SubscribeToEvent<T> Generic Method

Documentation for this section has not yet been entered.

Syntax

public void SubscribeToEvent<T> (AObject sender, NativeEventDelegate<T> eventDelegate)
where T : AtomicEngine.NativeEventData

Type Parameters

T
Documentation for this section has not yet been entered.

Parameters

sender
Documentation for this section has not yet been entered.
eventDelegate
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

TypeName Property

Documentation for this section has not yet been entered.

Syntax

public string TypeName { get; }

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

TypeNameStatic Property

Documentation for this section has not yet been entered.

Syntax

public string TypeNameStatic { get; }

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

UnsubscribeFromAllEvents Method

Documentation for this section has not yet been entered.

Syntax

public void UnsubscribeFromAllEvents ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

UnsubscribeFromEvent Method

Unsubscribe from an event.

Syntax

public void UnsubscribeFromEvent (StringHash eventType)

Parameters

eventType
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

UnsubscribeFromEvent Method

Documentation for this section has not yet been entered.

Syntax

public void UnsubscribeFromEvent (uint eventType)

Parameters

eventType
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

UnsubscribeFromEvent Method

Unsubscribe from a specific sender's event.

Syntax

public void UnsubscribeFromEvent (AObject sender, StringHash eventType)

Parameters

sender
Documentation for this section has not yet been entered.
eventType
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

UnsubscribeFromEvent<T> Generic Method

Documentation for this section has not yet been entered.

Syntax

public void UnsubscribeFromEvent<T> ()
where T : AtomicEngine.NativeEventData

Type Parameters

T
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

UnsubscribeFromEventReceiver Method

Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object)

Syntax

public void UnsubscribeFromEventReceiver (AObject receiver)

Parameters

receiver
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

UnsubscribeFromEvents Method

Unsubscribe from a specific sender's events.

Syntax

public void UnsubscribeFromEvents (AObject sender)

Parameters

sender
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