wiki.sine.space | sinespace

Difference between revisions of "Scripting/SGameObject"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/sgameobject")
 
(78 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The SGameObject class refers a single Game Object active within the scene.
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/sgameobject
 
+
==Members==
+
{{ScriptFunction|void|SubscribeToEvents|();|Causes this script to start listening to events on the object. Only use if you need to.}}
+
{{ScriptFunction|bool|Exists|{ get; }|Does this object still exist in the scene (returns false if the object has been deleted via Destroy();)}}
+
{{ScriptFunction|SGameObject|Duplicate|();|Copies the object and returns a reference to the copy. Equivalent to calling Instantiate() in Unity}}
+
{{ScriptFunction|SLight|Light|{ get; }|Returns a reference to a Light component on the object. Will return null if it does not exist.}}
+
{{ScriptFunction|SAnimator|Animator|{ get; }|Returns a reference to a Animator component on the object. Will return null if it does not exist.}}
+
{{ScriptFunction|SAudioSource|Audio|{ get; }|Returns a reference to a AudioSource component on the object. Will return null if it does not exist.}}
+
{{ScriptFunction|SRenderer|Renderer|{ get; }|Returns a reference to a Renderer component on the object. Will return null if it does not exist.}}
+
{{ScriptFunction|SRigidbody|Rigidbody|{ get; }|Returns a reference to a Rigidbody component on the object. Will return null if it does not exist.}}
+
{{ScriptFunction|SUIText|UIText|{ get; }|Returns a reference to a UI.Text component on the object. Will return null if it does not exist.}}
+
{{ScriptFunction|void|OnAwake|(Action callback)|Binds a event to the Awake() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|void|OnStart|(Action callback)|Binds a event to the Start() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|void|OnEnable|(Action callback)|Binds a event to the OnEnable() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|void|OnDisable|(Action callback)|Binds a event to the OnDisable() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|void|OnFixedUpdate|(Action callback)|Binds a event to the OnFixedUpdate() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|void|OnLateUpdate|(Action callback)|Binds a event to the OnLateUpdate() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|void|OnUpdate|(Action callback)|Binds a event to the OnUpdate() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|void|OnMouseDown|(Action callback)|Binds a event to the OnMouseDown() event. Requires SubscribeToEvents be called first.}}
+
{{ScriptFunction|bool|Active|{ get; set; }|Is this object Active in the scene)}}
+
{{ScriptFunction|int|Layer|{ get; set; }|Gets/Sets the object onto a particular layer (0-31)}}
+
{{ScriptFunction|string|Tag|{ get; }|Gets this objects Tag}}
+
{{ScriptFunction|string|Name|{ get; set; }|Gets/sets the name of this object}}
+
{{ScriptFunction|SGameObject|Parent|{ get; set; }|Gets/sets the parent GameObject of this object. Assign nil/null to set this as the root.}}
+
{{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}}
+
 
+
'''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|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|Right|{ get; }|Returns the right direction vector of this game object (red arrow)}}
+
{{ScriptFunction|void|Destroy|();|Schedules this object for deletion at the end of the frame}}
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 07:54, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/sgameobject