Object

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.Object
Namespace	Electron2D
Kind	class
Category	Core

Overview

Represents the object type.

Syntax

public class Electron2D.Object

Remarks

This type is part of the Electron2D 0.1.0 Preview public API.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
Electron2D.Object()	Constructor	Initializes a new instance of the Object type.
AddUserSignal(System.String)	Method	Adds the user signal value.
CallDeferred(System.String, System.Object[])	Method	Executes the call deferred operation.
Connect(System.String, Electron2D.Callable, Electron2D.ConnectFlags)	Method	Executes the connect operation.
Disconnect(System.String, Electron2D.Callable)	Method	Executes the disconnect operation.
EmitSignal(System.String, System.Object[])	Method	Executes the emit signal operation.
Free()	Method	Executes the free operation.
GetInstanceId()	Method	Gets the instance id value.
HasSignal(System.String)	Method	Checks whether signal is available.
IsConnected(System.String, Electron2D.Callable)	Method	Checks whether connected is true.
IsInstanceValid(Electron2D.Object)	Method	Checks whether instance valid is true.
IsQueuedForDeletion()	Method	Checks whether queued for deletion is true.
ToString()	Method	Executes the to string operation.
Tr(System.String, System.String)	Method	Translates a message through the process-wide translation server.

Member Details

Electron2D.Object()

Kind: Constructor

public Electron2D.Object()

Summary

Initializes a new instance of the Object type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

AddUserSignal(System.String)

Kind: Method

public System.Void AddUserSignal(System.String)(System.String signal)

Summary

Adds the user signal value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• signal: The signal value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

CallDeferred(System.String, System.Object[])

Kind: Method

public System.Object CallDeferred(System.String, System.Object[])(System.String method, System.Object[] args)

Summary

Executes the call deferred operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• method: The method value.
• args: The args value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

Connect(System.String, Electron2D.Callable, Electron2D.ConnectFlags)

Kind: Method

public Electron2D.Error Connect(System.String, Electron2D.Callable, Electron2D.ConnectFlags)(System.String signal, Electron2D.Callable callable, Electron2D.ConnectFlags flags)

Summary

Executes the connect operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• signal: The signal value.
• callable: The callable value.
• flags: The flags value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

Disconnect(System.String, Electron2D.Callable)

Kind: Method

public System.Void Disconnect(System.String, Electron2D.Callable)(System.String signal, Electron2D.Callable callable)

Summary

Executes the disconnect operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• signal: The signal value.
• callable: The callable value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

EmitSignal(System.String, System.Object[])

Kind: Method

public Electron2D.Error EmitSignal(System.String, System.Object[])(System.String signal, System.Object[] args)

Summary

Executes the emit signal operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• signal: The signal value.
• args: The args value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

Free()

Kind: Method

public System.Void Free()()

Summary

Executes the free operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

GetInstanceId()

Kind: Method

public System.UInt64 GetInstanceId()()

Summary

Gets the instance id value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The current instance id value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

HasSignal(System.String)

Kind: Method

public System.Boolean HasSignal(System.String)(System.String signal)

Summary

Checks whether signal is available.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• signal: The signal value.

Returns

true when the condition is met; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

IsConnected(System.String, Electron2D.Callable)

Kind: Method

public System.Boolean IsConnected(System.String, Electron2D.Callable)(System.String signal, Electron2D.Callable callable)

Summary

Checks whether connected is true.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• signal: The signal value.
• callable: The callable value.

Returns

true when the condition is met; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

IsInstanceValid(Electron2D.Object)

Kind: Method

public static System.Boolean IsInstanceValid(Electron2D.Object)(Electron2D.Object instance)

Summary

Checks whether instance valid is true.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• instance: The instance value.

Returns

true when the condition is met; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

IsQueuedForDeletion()

Kind: Method

public System.Boolean IsQueuedForDeletion()()

Summary

Checks whether queued for deletion is true.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

true when the condition is met; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

ToString()

Kind: Method

public System.String ToString()()

Summary

Executes the to string operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Object

Tr(System.String, System.String)

Kind: Method

public System.String Tr(System.String, System.String)(System.String message, System.String context)

Summary

Translates a message through the process-wide translation server.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• message: The source message key to translate.
• context: The optional message context.

Returns

The translated message, or message when no registered translation can resolve it.

Exceptions

• System.ArgumentNullException: Thrown when message or context is null.

Thread Safety

This method is safe to call from any thread as long as registered translation resources are not mutated concurrently.

Since

This method is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Translation
• Electron2D.TranslationServer