Animation-Event Message
From TrainzOnline
(Difference between revisions)
(Rework to remove references to IM files and some clarification) |
(Removed duplicated information) |
||
| Line 1: | Line 1: | ||
| − | Animation events are used to initiate some action, such as smoke effects, during an animation cycle that can be detected by script. This is a different mechanism from Sound_Event, which interfaces with a | + | Animation events are used to initiate some action, such as smoke effects, during an animation cycle that can be detected by script. This is a different mechanism from Sound_Event, which interfaces with a [["Soundscript" container]] in config.txt and does not require scripting. |
When an animation event occurs, the game engine will post a message in the form: | When an animation event occurs, the game engine will post a message in the form: | ||
"<major>, <minor>" | "<major>, <minor>" | ||
where the major part of the message is always "Animation-Event" and the minor part is a message of your choice. | where the major part of the message is always "Animation-Event" and the minor part is a message of your choice. | ||
| − | + | The structure and format of event files can be found here: [[FBX file format]] | |
| − | + | To use the posted message you should define a handler using: | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
AddHandler(me,"Animation-Event","","AnimationHandler"); | AddHandler(me,"Animation-Event","","AnimationHandler"); | ||
| Line 45: | Line 19: | ||
} | } | ||
| − | + | In practice the game engine often issues duplicate messages so you will need to ensure that you are not responding more often than necessary. One way of doing this is to use a boolean variable to keep track of what your script is doing and use this to ignore duplicating script actions. | |
Latest revision as of 16:18, 3 July 2020
Animation events are used to initiate some action, such as smoke effects, during an animation cycle that can be detected by script. This is a different mechanism from Sound_Event, which interfaces with a "Soundscript" container in config.txt and does not require scripting. When an animation event occurs, the game engine will post a message in the form: "<major>, <minor>" where the major part of the message is always "Animation-Event" and the minor part is a message of your choice.
The structure and format of event files can be found here: FBX file format
To use the posted message you should define a handler using:
AddHandler(me,"Animation-Event","","AnimationHandler");
void AnimationHandler(Message msg) {
if (msg.minor == "animstart")
Interface.Print("Animation has started"); //action for the animstart event
else if (msg.minor == "do-something")
Interface.Print("Do something here"); //action for the do-something event
else if (msg.minor == "animstop")
Interface.Print("Animation has completed"); //action for the animstop event
}
In practice the game engine often issues duplicate messages so you will need to ensure that you are not responding more often than necessary. One way of doing this is to use a boolean variable to keep track of what your script is doing and use this to ignore duplicating script actions.
