Eventlist Command Reference: Difference between revisions
No edit summary |
|||
| Line 16: | Line 16: | ||
== Animation Control == | == Animation Control == | ||
====ANIM==== | ====ANIM==== | ||
''Usage: '''ANIM:<animation name> | ''Usage'': '''ANIM:<animation name>'''<br> | ||
''Alt. Usage: '''<animation name>''' | ''Alt. Usage'': '''<animation name>'''<br> | ||
This command will stop the last animation, and start the specified animation in its place. It will play on all avatars and movers defined by the group where it is used. | |||
<br><br> | |||
''Example:'' | ''Example:'' | ||
0.0|ANIM:TheRobot | 0.0|ANIM:TheRobot | ||
| Line 23: | Line 26: | ||
0.0|TheRobot | 0.0|TheRobot | ||
==== OSTART ==== | ==== OSTART ==== | ||
''Usage: '''OSTART:<animation name>''' | ''Usage'': '''OSTART:<animation name>'''<br><br> | ||
This command is used to start an animation without ending the current animation already in effect. It is useful for specific hand motions, lip motions, designed to overlay on top of other animations. It can also be used to hide an animation 'in the background' so that it can be revealed later, appearing as if it started in the middle of its natural sequence. This command was formerly called 'overlayanim'. | |||
''Example:'' | ''Example:'' | ||
0.0|OSTART:OverheadClap | 0.0|OSTART:OverheadClap | ||
==== OSTOP ==== | ==== OSTOP ==== | ||
''Usage'': '''OSTOP:<animation name>'''<br><br> | |||
This command is used to stop an animation. Typically it is used to stop playing an overlay animation started with the "OSTART" command. This command was formerly called 'overlaystop'. | |||
''Example:'' | |||
4.0|OSTOP:OverheadClap | |||
==== CLEARANIM ==== | ==== CLEARANIM ==== | ||
''Usage: '''CLEARANIM'''''<br><br> | |||
This command is used to stop all playing animations. Typically it is useful to forceably stop other animations that might have been started by something other than metaharper show tools, for example props, clothing, huds, or vehicles that have their own animations. | |||
''Example:'' | |||
0.0|CLEARANIM | |||
==== ANIMCACHE ==== | ==== ANIMCACHE ==== | ||
''Usage: '''ANIMCACHE'''''<br><br> | |||
This command will quickly cause and avatar to play every animation in the performance engine's inventory. It is useful to pre-upload animations to nearby viewers, ahead of a performance, avoiding future upload latency.<br> | |||
''Example:'' | |||
0.0|ANIMCACHE | |||
== Time Control == | == Time Control == | ||
Revision as of 02:08, 10 August 2024
Welcome
The following contains all the native commands currently supported by the 7.x series MST Performance Engines. For a context of how to use the eventlist to program sequences of comands, see the timeline scheduling section in the MST documentation.
Format of this Reference Guide
In many cases these commands have the same names as their lowercase chat command equivalents. In general using the uppercase versions will offer a speed increase over a traditional chat cmmand. For example
0.0|MOVESTART myMoverName
will be faster than the equivalent chat command:
0.0|SAY:8:movestart myMoverName
All commands are meant to have a time to run in front of them. In the examples they are all "0.0", but in a typical eventlist this number will be a specific number of seconds to wait to execute the commands, either in the format of "<number of seconds to execute this comamnd>" such as "3.0", or "+<number of seconds to wait after the previous command>" such as "+3.0".
Animation Control
ANIM
Usage: ANIM:<animation name>
Alt. Usage: <animation name>
This command will stop the last animation, and start the specified animation in its place. It will play on all avatars and movers defined by the group where it is used.
Example:
0.0|ANIM:TheRobot
Example #2:
0.0|TheRobot
OSTART
Usage: OSTART:<animation name>
This command is used to start an animation without ending the current animation already in effect. It is useful for specific hand motions, lip motions, designed to overlay on top of other animations. It can also be used to hide an animation 'in the background' so that it can be revealed later, appearing as if it started in the middle of its natural sequence. This command was formerly called 'overlayanim'.
Example:
0.0|OSTART:OverheadClap
OSTOP
Usage: OSTOP:<animation name>
This command is used to stop an animation. Typically it is used to stop playing an overlay animation started with the "OSTART" command. This command was formerly called 'overlaystop'.
Example:
4.0|OSTOP:OverheadClap
CLEARANIM
Usage: CLEARANIM
This command is used to stop all playing animations. Typically it is useful to forceably stop other animations that might have been started by something other than metaharper show tools, for example props, clothing, huds, or vehicles that have their own animations.
Example:
0.0|CLEARANIM
ANIMCACHE
Usage: ANIMCACHE
This command will quickly cause and avatar to play every animation in the performance engine's inventory. It is useful to pre-upload animations to nearby viewers, ahead of a performance, avoiding future upload latency.
Example:
0.0|ANIMCACHE