|
|
| (31 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | The SScene class represents the region the user is currently in.
| + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/scene/sscene |
| − | | + | |
| − | ==Members==
| + | |
| − | {{ScriptFunction|SGameObject|Find|(string name);|Finds a single Game Object matching 'Name' and returns it. Can use '/' characters to designate a path (e.g. 'Parent/Child' returns Child with 'Parent')|5e
| + | |
| − | <pre> hand = Space.Scene.Find("Hand");
| + | |
| − | --This returns the GameObject named Hand.
| + | |
| − | | + | |
| − | hand = Space.Scene.Find("/Hand");
| + | |
| − | --This returns the GameObject named Hand.
| + | |
| − | --Hand must not have a parent in the Hierarchy view.
| + | |
| − | | + | |
| − | hand = Space.Scene.Find("/Monster/Arm/Hand");
| + | |
| − | --This returns the GameObject named Hand, | + | |
| − | --which is a child of Arm > Monster.
| + | |
| − | --Monster must not have a parent in the Hierarchy view.
| + | |
| − | | + | |
| − | hand = Space.Scene.Find("Monster/Arm/Hand");
| + | |
| − | --This returns the GameObject named Hand,
| + | |
| − | --which is a child of Arm > Monster. </pre>}}
| + | |
| − | {{ScriptFunction|SAvatar|PlayerAvatar|{ get; }|Returns the current player avatar. If this script is calling this upon initialisation, the Player may not exist yet, and you will want to wait a few frames until the avatar is present before continuing.}}
| + | |
| − | {{ScriptFunction|SAvatar|Avatars[]|{ get; }|Returns a list of Avatars in the scene}}
| + | |
| − | {{ScriptFunction|SGameObject|Objects[]|{ get; }|Returns a list of Objects in the scene. '''IMPORTANT: This function is slow, you should cache the result and avoid calling this every frame.'''}}
| + | |
| − | {{ScriptFunction|SGameObject|CreateGameObject|(string name);|Creates a new empty game object with the name 'Name' and returns a reference}}
| + | |
| − | {{ScriptFunction|SGameObject|CreateGameObject|([[Scripting/SResource|SResource]] resource);|Creates a game object from the specified resource}}
| + | |
| − | {{ScriptFunction|string|Name|{ get; }|Returns the name of the current region}}
| + | |
| − | {{ScriptFunction|string|Url|{ get; }|Returns the URL of the current region}}
| + | |
| − | {{ScriptFunction|long|Owner|{ get; }|Returns the avatar ID of the regions owner}}
| + | |
| − | {{ScriptFunction|bool|PlayerIsOwner|{ get; }|Returns whether the current player is the owner of the region}}
| + | |
| − | {{ScriptFunction|void|OnPlayerJoin|(Action<[[Scripting/SAvatar|SAvatar]]> callback)|Event which fires whenever a player joins the region}}
| + | |
| − | {{ScriptFunction|void|OnPlayerLeave|(Action<long> callback)|Event which fires whenever a player leaves the region}}
| + | |
| − | | + | |
| − | {{Scripting Navbox}}
| + | |
