Difference between revisions of "Scripting/SGameObject"

Revision as of 06:48, 17 January 2017 (view source) Sinewave (Talk | contribs) ← Older edit		Revision as of 08:22, 17 January 2017 (view source) Sinewave (Talk | contribs) Newer edit →
Line 26:		Line 26:
	{{ScriptFunction|SGameObject|Root|{ get; }|Gets the root of this object group - may be this object.}}		{{ScriptFunction|SGameObject|Root|{ get; }|Gets the root of this object group - may be this object.}}
	{{ScriptFunction|SGameObject|Children[]|{ get; }|Returns the list of direct children of this object}}		{{ScriptFunction|SGameObject|Children[]|{ get; }|Returns the list of direct children of this object}}
−		+	{{ScriptFunction|SVector|WorldPosition|{ get; set; }|Gets or sets the current position of this object relative to the scene}}
−	'''NOTE: Set/Get World Position, Local Position, World Rotation, Local Rotation, Local Scale to be moved to properties from functions, thus not documented here.'''	+	{{ScriptFunction|SVector|LocalPosition|{ get; set; }|Gets or sets the current position of this object relative to the objects parent, taking into account local position/scale/rotation}}
−		+	{{ScriptFunction|SQuaternion|WorldRotation|{ get; set; }|Gets or sets the current rotation of this object relative to the scene}}
		+	{{ScriptFunction|SQuaternion|LocalRotation|{ get; set; }|Gets or sets the current rotation of this object relative to the parent object}}
		+	{{ScriptFunction|SQuaternion|LocalScale|{ get; set; }|Gets or sets the current scale of this object relative to the parent}}
		+	{{ScriptFunction|SQuaternion|WorldScale|{ get; }|Gets the current scale of this object relative to the scene}}
	{{ScriptFunction|SVector|Forward|{ get; }|Returns the forward direction vector of this game object (blue arrow)}}		{{ScriptFunction|SVector|Forward|{ get; }|Returns the forward direction vector of this game object (blue arrow)}}
	{{ScriptFunction|SVector|Up|{ get; }|Returns the up direction vector of this game object (green arrow)}}		{{ScriptFunction|SVector|Up|{ get; }|Returns the up direction vector of this game object (green arrow)}}

---

Revision as of 08:22, 17 January 2017

The SGameObject class refers a single Game Object active within the scene.

Members

SubscribeToEvents

Causes this script to start listening to events on the object. Only use if you need to.

Exists

Does this object still exist in the scene (returns false if the object has been deleted via Destroy();)

Duplicate

Copies the object and returns a reference to the copy. Equivalent to calling Instantiate() in Unity

Light

Returns a reference to a Light component on the object. Will return null if it does not exist.

Animator

Returns a reference to a Animator component on the object. Will return null if it does not exist.

Audio

Returns a reference to a AudioSource component on the object. Will return null if it does not exist.

Renderer

Returns a reference to a Renderer component on the object. Will return null if it does not exist.

Rigidbody

Returns a reference to a Rigidbody component on the object. Will return null if it does not exist.

UIText

Returns a reference to a UI.Text component on the object. Will return null if it does not exist.

OnAwake

Binds a event to the Awake() event. Requires SubscribeToEvents be called first.

OnStart

Binds a event to the Start() event. Requires SubscribeToEvents be called first.

OnEnable

Binds a event to the OnEnable() event. Requires SubscribeToEvents be called first.

OnDisable

Binds a event to the OnDisable() event. Requires SubscribeToEvents be called first.

OnFixedUpdate

Binds a event to the OnFixedUpdate() event. Requires SubscribeToEvents be called first.

OnLateUpdate

Binds a event to the OnLateUpdate() event. Requires SubscribeToEvents be called first.

OnUpdate

Binds a event to the OnUpdate() event. Requires SubscribeToEvents be called first.

OnMouseDown

Binds a event to the OnMouseDown() event. Requires SubscribeToEvents be called first.

Active

Is this object Active in the scene)

Layer

Gets/Sets the object onto a particular layer (0-31)

Tag

Gets this objects Tag

Name

Gets/sets the name of this object

Parent

Gets/sets the parent GameObject of this object. Assign nil/null to set this as the root.

Root

Gets the root of this object group - may be this object.

Children[]

Returns the list of direct children of this object

WorldPosition

Gets or sets the current position of this object relative to the scene

LocalPosition

Gets or sets the current position of this object relative to the objects parent, taking into account local position/scale/rotation

WorldRotation

Gets or sets the current rotation of this object relative to the scene

LocalRotation

Gets or sets the current rotation of this object relative to the parent object

LocalScale

Gets or sets the current scale of this object relative to the parent

WorldScale

Gets the current scale of this object relative to the scene

Forward

Returns the forward direction vector of this game object (blue arrow)

Up

Returns the up direction vector of this game object (green arrow)

Right

Returns the right direction vector of this game object (red arrow)

Destroy

Schedules this object for deletion at the end of the frame

v · d · e Scripting Portal Common Reference Lua Guide Scripting/CSharp Key Classes Space Scene GameObject Avatar Inventory Host Physics (Rigidbody, Collider) Input CameraManager WebService Network Helper Classes SMath SString Scripting samples and tutorials Demo Radio Auto Complete Setup