(Fixed the markup error in Active, Name, Duplicate code examples) |
|||
| Line 3: | Line 3: | ||
=Members= | =Members= | ||
==Miscellaneous== | ==Miscellaneous== | ||
| − | {{ScriptFunction|bool|Active|{ get; set; }|Is this object Active in the scene|Object.Active = true;}} | + | {{ScriptFunction|bool|Active|{ get; set; }|Is this object Active in the scene|5= Object.Active = true;}} |
{{ScriptFunction|int|Layer|{ get; set; }|Gets/Sets the object onto a particular layer (0-31)|Space.Log("This object is on the layer " .. Object.Layer);}} | {{ScriptFunction|int|Layer|{ get; set; }|Gets/Sets the object onto a particular layer (0-31)|Space.Log("This object is on the layer " .. Object.Layer);}} | ||
{{ScriptFunction|string|Tag|{ get; }|Gets this objects Tag|Space.Log("Object Tag is " .. Object.Tag);}} | {{ScriptFunction|string|Tag|{ get; }|Gets this objects Tag|Space.Log("Object Tag is " .. Object.Tag);}} | ||
| − | {{ScriptFunction|string|Name|{ get; set; }|Gets/sets the name of this object|Object.Name = "Hello World!";}} | + | {{ScriptFunction|string|Name|{ get; set; }|Gets/sets the name of this object|5= Object.Name = "Hello World!";}} |
{{ScriptFunction|bool|Exists|{ get; }|Does this object still exist in the scene (returns false if the object has been deleted via Destroy();)|if(!Object.Exists) return;}} | {{ScriptFunction|bool|Exists|{ get; }|Does this object still exist in the scene (returns false if the object has been deleted via Destroy();)|if(!Object.Exists) return;}} | ||
| − | {{ScriptFunction|SGameObject|Duplicate|();|Copies the object and returns a reference to the copy. Equivalent to calling Instantiate() in Unity|local copy = Object.Duplicate();}} | + | {{ScriptFunction|SGameObject|Duplicate|();|Copies the object and returns a reference to the copy. Equivalent to calling Instantiate() in Unity|5= local copy = Object.Duplicate();}} |
{{ScriptFunction|void|Destroy|();|Schedules this object for deletion at the end of the frame|Object.Destroy();}} | {{ScriptFunction|void|Destroy|();|Schedules this object for deletion at the end of the frame|Object.Destroy();}} | ||
The SGameObject class refers a single Game Object active within the scene.
Is this object Active in the scene
Gets/Sets the object onto a particular layer (0-31)
Gets this objects Tag
Gets/sets the name of this object
Does this object still exist in the scene (returns false if the object has been deleted via Destroy();)
Copies the object and returns a reference to the copy. Equivalent to calling Instantiate() in Unity
Schedules this object for deletion at the end of the frame
Returns a reference to a Light component on the object. Will return null if it does not exist.
Returns a reference to a Animator component on the object. Will return null if it does not exist.
Returns a reference to a AudioSource component on the object. Will return null if it does not exist.
Returns a reference to a Renderer component on the object. Will return null if it does not exist.
Returns a reference to a Rigidbody component on the object. Will return null if it does not exist.
Returns a reference to a UI.Text component on the object. Will return null if it does not exist.
Causes this script to start listening to events on the object. Only use if you need to.
Binds a event to the Awake() event. Requires SubscribeToEvents be called first.
Binds a event to the Start() event. Requires SubscribeToEvents be called first.
Binds a event to the OnEnable() event. Requires SubscribeToEvents be called first.
Binds a event to the OnDisable() event. Requires SubscribeToEvents be called first.
Binds a event to the OnFixedUpdate() event. Requires SubscribeToEvents be called first.
Binds a event to the OnLateUpdate() event. Requires SubscribeToEvents be called first.
Binds a event to the OnUpdate() event. Requires SubscribeToEvents be called first.
Binds a event to the OnMouseDown() event. Requires SubscribeToEvents be called first.
Gets/sets the parent GameObject of this object. Assign nil/null to set this as the root.
Gets the root of this object group - may be this object.
Returns the list of direct children of this object
Gets or sets the current position of this object relative to the scene
Gets or sets the current position of this object relative to the objects parent, taking into account local position/scale/rotation
Gets or sets the current rotation of this object relative to the scene
Gets or sets the current rotation of this object relative to the parent object
Gets or sets the current scale of this object relative to the parent
Gets the current scale of this object relative to the scene
Returns the forward direction vector of this game object (blue arrow)
Returns the up direction vector of this game object (green arrow)
Returns the right direction vector of this game object (red arrow)
| ||||||||||||||