|
|
| Line 1: |
Line 1: |
| − | | + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/types/savatarappearance |
| − | =Public Member Functions=
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|LoadOutfit|(int outfitID);|Changes the current Avatar's outfit to outfitID. For a player Avatar, this only works on white-label grid. For NPC avatars, this works on all grids.|5=<pre>Space.Host.ExecutingObject.AvatarAppearance.LoadOutfit(160)</pre>|6=<pre>--this script toggles between 3 different outfits when NPC Statue object is clicked
| + | |
| − | --[Object needs to have an NPC Statue component]
| + | |
| − | | + | |
| − | outfits = {4134388, 4134385, 4134386}
| + | |
| − | currentOutfit = 0
| + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | | + | |
| − | | + | |
| − | function OnClickFunction()
| + | |
| − | if currentOutfit == #outfits then
| + | |
| − | currentOutfit = 1
| + | |
| − | else
| + | |
| − | currentOutfit = currentOutfit + 1
| + | |
| − | end
| + | |
| − | | + | |
| − | thisObject.AvatarAppearance.LoadOutfit(outfits[currentOutfit])
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.AddClickable()
| + | |
| − | thisObject.Clickable.OnClick(OnClickFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|ResetOutfit|();|Changes the current Avatar's outfit and resets it to outfitID 0. For a player Avatar, this only works on white-label grid. For NPC avatars, this works on all grids. |5=<pre>Space.Host.ExecutingObject.AvatarAppearance.ResetOutfit()</pre>|6=<pre>--this script makes a UIButton reset an NPC statue outfit when clicked
| + | |
| − | --[UIButton object needs to be linked in scripting runtime references with name "button1"]
| + | |
| − | --[Object needs to have an NPC Statue component]
| + | |
| − | | + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | refButton = Space.Host.GetReference("button1")
| + | |
| − | | + | |
| − | function OnClickFunction()
| + | |
| − | thisObject.AvatarAppearance.ResetOutfit()
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | refButton.UIButton.OnClick(OnClickFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|ResetOutfitToTemplate|(int outfitID);|Changes the current Avatar's outfit to outfitID only if the player running this code already owns that outfit. For a player Avatar, this only works on white-label grid. For NPC avatars, this works on all grids.|5=<pre>Space.Host.ExecutingObject.AvatarAppearance.ResetOutfitToTemplate(10001)</pre>|6=<pre>--this script toggles between 3 different outfits when NPC Statue object is clicked
| + | |
| − | --[Object needs to have an NPC Statue component]
| + | |
| − | --For this function, the player needs to own this outfit. Use LoadOutfit if player might not own it
| + | |
| − | | + | |
| − | outfits = {4134388, 4134385, 4134386}
| + | |
| − | currentOutfit = 0
| + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | | + | |
| − | | + | |
| − | function OnClickFunction()
| + | |
| − | if currentOutfit == #outfits then
| + | |
| − | currentOutfit = 1
| + | |
| − | else
| + | |
| − | currentOutfit = currentOutfit + 1
| + | |
| − | end
| + | |
| − | | + | |
| − | thisObject.AvatarAppearance.ResetOutfitToTemplate(outfits[currentOutfit])
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.AddClickable()
| + | |
| − | thisObject.Clickable.OnClick(OnClickFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|float|GetSlider|(SAppearanceSlider slider);|Return the value of Appearance Sliders.|5=<pre>FaceLength = Space.Host.ExecutingObject.AvatarAppearance.GetSlider(AppearanceSlider.FaceLength)</pre>|6=<pre>--this script updates a UIText with the current Face Length of the npc
| + | |
| − | | + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | uiText = Space.Host.GetReference("thetext").UIText --Add this object with UIText component as reference in Scripting Runtime
| + | |
| − | | + | |
| − | OnUpdateFunction = function()
| + | |
| − | uiText.Text = thisObject.AvatarAppearance.GetSlider(AppearanceSlider.FaceLength)
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdateFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|float|GetHeight|();|Return height of avatar.|5=<pre>height = Space.Host.ExecutingObject.AvatarAppearance.GetHeight()</pre>|6=<pre>--this script updates a UIText with the height of this NPC statue
| + | |
| − | | + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | uiText = Space.Host.GetReference("thetext").UIText --Add this object with UIText component as reference in Scripting Runtime
| + | |
| − | | + | |
| − | OnUpdateFunction = function()
| + | |
| − | uiText.Text = thisObject.AvatarAppearance.GetHeight()
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdateFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|SColor|GetSkinTone|();|Return skin tone of avatar.|5=<pre>SkinTone = Space.Host.ExecutingObject.AvatarAppearance.GetSkinTone()</pre>|6=<pre>--this script updates a UIText with the current Skin Tone of the npc
| + | |
| − | | + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | uiText = Space.Host.GetReference("thetext").UIText --Add this object with UIText component as reference in Scripting Runtime
| + | |
| − | | + | |
| − | OnUpdateFunction = function()
| + | |
| − | uiText.Text = thisObject.AvatarAppearance.GetSkinTone().ToString()
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdateFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|SColor|GetEyeTone|();|Return eye tone of avatar.|5=<pre> EyeTone = Space.Host.ExecutingObject.AvatarAppearance.GetEyeTone()</pre>|6=<pre>--this script updates a UIText with the current Eye Tone of the npc
| + | |
| − | | + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | uiText = Space.Host.GetReference("thetext").UIText --Add this object with UIText component as reference in Scripting Runtime
| + | |
| − | | + | |
| − | OnUpdateFunction = function()
| + | |
| − | uiText.Text = thisObject.AvatarAppearance.GetEyeTone().ToString()
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdateFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | =Properties=
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|long|OutfitID|{ get; }|Return the current outfit id.|5=<pre>outfitID= Space.Host.ExecutingObject.AvatarAppearance.OutfitID</pre>|6=<pre>--this script updates a UIText with the current outfit ID of the npc
| + | |
| − | | + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | uiText = Space.Host.GetReference("thetext").UIText --Add this object with UIText component as reference in Scripting Runtime
| + | |
| − | | + | |
| − | OnUpdateFunction = function()
| + | |
| − | uiText.Text = thisObject.GameObject.AvatarAppearance.OutfitID
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdateFunction)
| + | |
| − | </pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|SGameObject|Skeleton|{ get; }|Return the GameObject of avatar skeleton.|5=<pre></pre>|6=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|Loaded|{ get; }|Returns true if the avatar is full loaded.|5=<pre>isLoaded= Space.Host.ExecutingObject.AvatarAppearance.Loaded</pre>|6=<pre>--this script updates a UIText with the loading status of the npc
| + | |
| − | | + | |
| − | thisObject = Space.Host.ExecutingObject
| + | |
| − | uiText = Space.Host.GetReference("thetext").UIText --Add this object with UIText component as reference in Scripting Runtime
| + | |
| − | | + | |
| − | OnUpdateFunction = function()
| + | |
| − | uiText.Text = thisObject.AvatarAppearance.Loaded
| + | |
| − | end
| + | |
| − | | + | |
| − | | + | |
| − | thisObject.OnUpdate(OnUpdateFunction)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{Scripting Navbox}}
| + | |
