|
|
(46 intermediate revisions by 2 users not shown) |
Line 1: |
Line 1: |
− | The SAvatar class refers a single player avatar active within the scene. This only contains active players with a valid network connection, and does not include NPCs.
| + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/savatar |
− | | + | |
− | =Members=
| + | |
− | | + | |
− | | + | |
− | {{ScriptFunction|void|Detach|();|Detaches the avatar from whatever it may be attached to (only works for the player avatar), including chairs, vehicles and so forth.|5=<pre>Space.Scene.PlayerAvatar.Detach()</pre>}}
| + | |
− | | + | |
− | {{ScriptFunction|void|AttachTo|(SGameObject target);|Attaches the player to the target game object, keeping the avatar fixed in its current position/rotation relative to the target object (e.g. for use in Vehicles)|5=<pre>Space.Scene.PlayerAvatar.AttachTo(targetObject)</pre>}}
| + | |
− | | + | |
− | {{ScriptFunction|SGameObject|FindBone|(string bone);|Retrieves the specified bone.|5=
| + | |
− | <b>-- Best used with non humanoid models</b><br>
| + | |
− | local bone = Space.Scene.PlayerAvatar.FindBone("Hips/Spine/Chest/LeftShoulder"); -- Gets the bone by path<br>
| + | |
− | Space.Log(bone.Name); -- Prints the retrieved bones name, which will match the last name in the path specified.<br>
| + | |
− | | + | |
− | <b>or</b>
| + | |
− | | + | |
− | <b>-- Best used with humanoid models</b><br>
| + | |
− | local bone = Space.Scene.PlayerAvatar.FindBone("LeftShoulder"); -- Gets bone by UnityEngine.HumanTrait.BoneName[]<br>
| + | |
− | Space.Log(bone.Name); -- Prints the bone name of the corresponding search parameter, which when using a default avatar, it will print "LeftShoulder"<br>
| + | |
− | | + | |
− | --[[<br>
| + | |
− | <b>UnityEngine.HumanTrait.BoneName[]</b>
| + | |
− | | + | |
− | <b>Body</b>: Hips, Spine, Chest, UpperChest<br>
| + | |
− | <b>Head</b>: Neck, Jaw, Head, LeftEye, RightEye<br>
| + | |
− | | + | |
− | <b>Left Arm</b>: LeftShoulder, LeftUpperArm, LeftLowerArm, LeftHand<br>
| + | |
− | <b>Left Leg</b>: LeftUpperLeg, LeftLowerLeg, LeftFoot, LeftToes<br>
| + | |
− | | + | |
− | <b>Right Arm</b>: RightShoulder, RightUpperArm, RightLowerArm, RightHand<br>
| + | |
− | <b>Right Leg</b>: RightUpperLeg, RightLowerLeg, RightFoot, RightToes<br>
| + | |
− | | + | |
− | <b>Left Hand (Thumb)</b>: LeftThumbProximal, LeftThumbIntermediate, LeftThumbDistal<br>
| + | |
− | <b>Left Hand (Index)</b>: LeftIndexProximal, LeftIndexIntermediate, LeftIndexDistal<br>
| + | |
− | <b>Left Hand (Middle)</b>: LeftMiddleProximal, LeftMiddleIntermediate, LeftMiddleDistal<br>
| + | |
− | <b>Left Hand (Ring)</b>: LeftRingProximal, LeftRingIntermediate, LeftRingDistal<br>
| + | |
− | <b>Left Hand (Little)</b>: LeftLittleProximal, LeftLittleIntermediate, LeftLittleDistal<br>
| + | |
− | | + | |
− | <b>Right Hand (Thumb)</b>: RightThumbProximal, RightThumbIntermediate, RightThumbDistal<br>
| + | |
− | <b>Right Hand (Index)</b>: RightIndexProximal, RightIndexIntermediate, RightIndexDistal<br>
| + | |
− | <b>Right Hand (Middle)</b>: RightMiddleProximal, RightMiddleIntermediate, RightMiddleDistal<br>
| + | |
− | <b>Right Hand (Ring)</b>: RightRingProximal, RightRingIntermediate, RightRingDistal<br>
| + | |
− | <b>Right Hand (Little)</b>: RightLittleProximal, RightLittleIntermediate, RightLittleDistal<br>
| + | |
− | ]]}}
| + | |
− | | + | |
− | | + | |
− | ==Properties==
| + | |
− | {{ScriptFunction|string|Username|{ get; }|Returns the players current username (note: this can be changed by players for a small fee)|5=<pre>playerUsername = Space.Scene.PlayerAvatar.Username</pre>}}
| + | |
− | | + | |
− | {{ScriptFunction|string|Title|{ get; }|Returns the players current title|5=<pre>playerTitle = Space.Scene.PlayerAvatar.Title</pre>}}
| + | |
− | | + | |
− | {{ScriptFunction|long|ID|{ get; }|Returns the players user ID, please note if you store these, this is a 'long' value not a 'int'.|5=<pre>playerID = Space.Scene.PlayerAvatar.ID</pre>}}
| + | |
− | | + | |
− | {{ScriptFunction|SGameObject|GameObject|{ get; }|Returns a reference to the players GameObject|5=<pre>playerObject = Space.Scene.PlayerAvatar.GameObject</pre>}}
| + | |
− | | + | |
− | {{Scripting Navbox}}
| + | |