Emote - Revision history

MarkGrant: /* "blended" */

2020-11-03T17:36:32Z

‎"blended"

MarkGrant: blended

2020-11-03T17:36:08Z

blended

DeamonHunter: Added missing Variable, plus some updating.

2018-02-06T13:08:51Z

Added missing Variable, plus some updating.

DeamonHunter: Missed a couple properties.

2017-11-15T08:37:52Z

Missed a couple properties.

DeamonHunter: Changed heading name

2017-11-15T06:41:09Z

Changed heading name

DeamonHunter: Initial commit.

2017-11-15T06:39:32Z

Initial commit.

New page

[[Category:Modding]]
In Staxel, *.emote files are used play animations for characters. These can appear with or without an item, though most do not use items.

= Creating a *.treasure file =


= Config Options =
== "code" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which specifies what this Emote is.</code>'''

'''Default Value:''' No default value is specified. Always need to provide your own.

A string containing the code of the emote the blob will be referring to.

== "shortCode" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which specifies what this Emote is.</code>'''

'''Default Value:''' No default value is specified. Always need to provide your own.

A string containing the code of the emote the blob will be referring to. This is meant to be the short hand of the code, to make typing the code out easier.

== "animation" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>The timeline code of the specific animation, in the [[Bone Animation]] being used by the [[Body Type]].</code>'''

'''Default Value:''' No default value is specified. Always need to provide your own.

This is the animation that will get played by the emote.

== "categories" ==
'''Valid options ([[Modding_Key_Terms#List|List]] of [[Modding_Key_Terms#String|String]]): <code>A list of valid strings.</code>'''

'''Default Value:''' If not specified, will not have any user defined categories.

This is a list of strings which are used to identify what the emote actually is. These terms can all be searched for in the Catalogue/Creative Menu, but are also used in [[Totems]] and [[Achievements]]. Certain categories will appear under certain tabs in either menu. As such these are not used, unless the [[#Icon]] is specified. These include:

<code>"block", "door", "floor"/"flooring", "flower", "furniture", "light", "plant", "tool", "window", "misc", "red", "orange", "yellow", "green", "blue", "purple", "pink", "white", "black" and "brown"</code>

== "effect" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Effect]] file</code>'''

'''Default Value:''' If not provided, will not play any effects.

This is the effect that will immediately start playing as the emote plays.

== "icon" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>The relative path to a model file starting at the content folder.</code>'''

'''Default Value:''' If not specified, will not create an item for this emote.

This is the model that will be displayed for this emotes item. Adding this allows the item to appear in menu's for the player to use at any point.

== "ignoreHandedness" ==
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

'''Default Value:''' False.

Ignore the handedness of the bodytype. That is, whether or not the animation should flip when concerning left handed people to right handed people.

== "killSound" ==
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

'''Default Value:''' False.

Whether or not the sound will be killed off as the emote ends or is interrupted.

== "looped" ==
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

'''Default Value:''' False.

This determines if the animation, and the corresponding sounds and effects, will continue looping after completion.

'''Note''': Can't have both Looped and Sticky set to True.

== "nextInSequence" ==
This is an optional [[Modding_Key_Terms#Blob|Blob]] which can be added to the emote file. This blob contains the information to fill out another emote, which will play after the first emote completes. For example;
<pre>
{
//Emote for Golfing: Bring club upwards
"nextInSequence" : {
//Emote for Golfing: Swing at ball
}
}
</pre>

This sets up a golf swing using two different emotes, which one will play after the other. If you want to seperate these into two different files, head to [[#"nextInSequenceRef"]].

== "nextInSequenceRef" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>Another Emote's Code.</code>'''

'''Default Value:''' If not provided, will not go to any other emote.

This is the emote that will play immediately after this emote completes, similar to [[#"nextInSequence"]]. Use this property to avoid long files.

== "outOfBodyExperience" ==
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

'''Default Value:''' False.

Whether or not the camera will stay locked to it's position rather than following the head. Useful for times such as getting into bed which could be nauseating.

=== "searchable" ===
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False</code>'''

'''Default Value:''' If not specified, will default to False.

This option specifies if the object whether the object will show up when it is searched for in the shop catalogue or the creative inventory. As such this is not used, unless the [[#Icon]] is specified. This is useful for objects with auto tiling info, as you only want a single version of that tile appearing.

== "sound" ==
'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Sound]] file</code>'''

'''Default Value:''' If not provided, will not play any sounds.

This is the sound that will immediately start playing as the emote plays.

== "sticky" ==
'''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''

'''Default Value:''' False.

This determines if the animation will "stick" after completing. Sticking refers to if the very end of the animation stays as it is. For example, if you make the throwing animation sticky, after it completes the hand will stay in the throwing position, compared to going back to the idle animation.

'''Note''': Can't have both Looped and Sticky set to True.

← Older revision		Revision as of 17:36, 3 November 2020
Line 253:		Line 253:


−	'''Unknown action'''	+	''Unknown action''

← Older revision		Revision as of 17:36, 3 November 2020
Line 245:		Line 245:

	'''Note''': Can't have both Looped and Sticky set to True.		'''Note''': Can't have both Looped and Sticky set to True.
		+
		+
		+	== "blended" ==
		+	'''Valid options ([[Modding_Key_Terms#Bool\|Bool]]): <code>True or False.</code>'''
		+
		+	'''Default Value:''' If not specified, will default to False.
		+
		+
		+	'''Unknown action'''

@@ Line 116: / Line 116: @@
 '''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Effect]] file</code>'''
-'''Default Value:''' If not provided, will not play any effects.
+'''Default Value:''' If not specified, will not play any effects.
@@ Line 129: / Line 129: @@
 This is the model that will be displayed for this emotes item. Adding this allows the item to appear in menu's for the player to use at any point.
@@ Line 143: / Line 152: @@
 '''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False.
+'''Default Value:''' If not specified, will default to False.
 Whether or not the sound will be killed off as the emote ends or is interrupted.
@@ Line 151: / Line 160: @@
 '''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False.
+'''Default Value:''' If not specified, will default to False.
@@ Line 176: / Line 185: @@
 '''Valid options ([[Modding_Key_Terms#String|String]]): <code>Another Emote's Code.</code>'''
-'''Default Value:''' If not provided, will not go to any other emote.
+'''Default Value:''' If not specified, will not go to any other emote.
@@ Line 185: / Line 194: @@
 '''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False.
+'''Default Value:''' If not specified, will default to False.
@@ Line 203: / Line 212: @@
 '''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string containing the code to a [[Sound]] file</code>'''
-'''Default Value:''' If not provided, will not play any sounds.
+'''Default Value:''' If not specified, will not play any sounds.
@@ Line 212: / Line 221: @@
 '''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False.
+'''Default Value:''' If not specified, will default to False.
@@ Line 221: / Line 230: @@
 '''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False.
+'''Default Value:''' If not specified, will default to False.
@@ Line 230: / Line 239: @@
 '''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False.</code>'''
-'''Default Value:''' False.
+'''Default Value:''' If not specified, will default to False.

@@ Line 102: / Line 102: @@
 <code>"block", "door", "floor"/"flooring", "flower", "furniture", "light", "plant", "tool", "window", "misc", "red", "orange", "yellow", "green", "blue", "purple", "pink", "white", "black" and "brown"</code>
@@ Line 182: / Line 191: @@
-=== "searchable" ===
+== "searchable" ==
 '''Valid options ([[Modding_Key_Terms#Bool|Bool]]): <code>True or False</code>'''
@@ Line 198: / Line 207: @@
 This is the sound that will immediately start playing as the emote plays.

@@ Line 3: / Line 3: @@
-= Creating a *.treasure file =
+= Creating a *.emote file =
 <!--
 Treasure files tend to become quite large as more items are needed but in reality these files don't require much thought. Below is a common case for these files;