Animation-Event Message - Revision history

Pcas1986: Removed duplicated information

2020-07-03T06:18:16Z

Removed duplicated information

← Older revision		Revision as of 06:18, 3 July 2020
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 ~~''soundscript''~~ container in config.txt and does not require scripting.		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.

	~~Event~~ files		The structure and format of event files can be found here: [[FBX file format]]

	* Event files contain a list of the events you wish to intercept.		To use the posted message you should define a handler using:
	* The name of the event file must match the name of an animation (kin) file and are plain text files with an ".evt" extension.
	* The file should contain one or more event lines in the form:

	~~::<frame number> “Generic_Event” <minor message>~~
	~~::<frame number> “Generic_Event” <minor message>~~

	* Some 3D Editors may be capable of producing of producing event files automatically.

	* The first item is a frame number that should be in the range 000..999.
	* The second item is a name such as "Generic_Event". This value appears to be ignored by Trainz.
	* The third item will be the minor part of the message and the identifier used in your script as shown below.

	~~Sample event file:~~

	~~002 Generic_Event animstart~~
	~~045 Generic_Event do-something~~
	~~089 Generic_Event animstop~~

	* This example will result in the messages:
	~~:: ''Animation-Event, animstart'' being sent by the game whenever the animation plays past frame 2.~~
	~~:: ''Animation-Event, do-something'' whenever the animation plays past frame 45; and~~
	~~:: ''Animation-Event, animstop'' whenever the animation plays past frame 89.~~

	* It is best to avoid issuing events on the first or last frames since these are not always converted reliably into messages.

	* 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.		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.

Pcas1986: Rework to remove references to IM files and some clarification

2020-07-03T06:00:42Z

Rework to remove references to IM files and some clarification

← Older revision		Revision as of 06:00, 3 July 2020
Line 1:		Line 1:
	''~~This page refers to~~ the ~~legacy IM exporters. Please see~~ the ~~[[FBX file format]] page for up~~-~~to-date import/export details~~.''		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.

	Generic events can be linked to an animation key frame to give a measure of control over script timing. This is a different mechanism from Sound_Event, which interfaces with a ''soundscript'' container in config.txt and does not require scripting.		Event files

	~~When an animation file,~~ *~~.kin, is exported from Max, the exporter will make~~ a ~~query for an event file. Tick~~ the ~~box and~~ you ~~will be asked to browse~~ to ~~the file~~. The event ~~information is added to~~ the ~~contents~~ of ~~the new~~ animation.		* Event files contain a list of the events you wish to intercept.
			* The name of the event file must match the name of an animation (kin) file and are plain text files with an ".evt" extension.
			* The file should contain one or more event lines in the form:

	* ~~To produce an animation~~ event ~~which can be read by script you need to insert~~ a ~~line or lines similar to~~ that ~~below to~~ a ~~plain text file and~~ to ~~save it with an~~ *.~~evt~~ file ~~extension.~~		::<frame number> “Generic_Event” <minor message>
			::<frame number> “Generic_Event” <minor message>

			* Some 3D Editors may be capable of producing of producing event files automatically.

			* The first item is a frame number that should be in the range 000..999.
			* The second item is a name such as "Generic_Event". This value appears to be ignored by Trainz.
			* The third item will be the minor part of the message and the identifier used in your script as shown below.

			Sample event file:

	002 Generic_Event animstart		002 Generic_Event animstart
			045 Generic_Event do-something
			089 Generic_Event animstop

	* This example will result in the ~~message~~ ''Animation-Event,animstart'' being sent by the game whenever the animation plays past frame 2.		* This example will result in the messages:
			:: ''Animation-Event, animstart'' being sent by the game whenever the animation plays past frame 2.
			:: ''Animation-Event, do-something'' whenever the animation plays past frame 45; and
			:: ''Animation-Event, animstop'' whenever the animation plays past frame 89.

	* It is best to avoid issuing events on the first or last frames since these are not always converted reliably into messages.		* It is best to avoid issuing events on the first or last frames since these are not always converted reliably into messages.
	* To use the message you should define a handler using:
			* To use the posted message you should define a handler using:

	AddHandler(me,"Animation-Event","","AnimationHandler");		AddHandler(me,"Animation-Event","","AnimationHandler");
Line 17:		Line 38:
	void AnimationHandler(Message msg) {		void AnimationHandler(Message msg) {
	if (msg.minor == "animstart")		if (msg.minor == "animstart")
	Interface.Print("Animation has started");		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")		else if (msg.minor == "animstop")
	Interface.Print("Animation has completed");		Interface.Print("Animation has completed"); //action for the animstop event
	}		}

Line 26:		Line 49:

	==See Also==		==See Also==
			* [[FBX file format]]
	* [[List of Standard Messages]]		* [[List of Standard Messages]]

Windwalkr at 03:18, 7 November 2016

2016-11-07T03:18:45Z

← Older revision		Revision as of 03:18, 7 November 2016
Line 1:		Line 1:
			''This page refers to the legacy IM exporters. Please see the [[FBX file format]] page for up-to-date import/export details.''

	Generic events can be linked to an animation key frame to give a measure of control over script timing. This is a different mechanism from Sound_Event, which interfaces with a ''soundscript'' container in config.txt and does not require scripting.		Generic events can be linked to an animation key frame to give a measure of control over script timing. This is a different mechanism from Sound_Event, which interfaces with a ''soundscript'' container in config.txt and does not require scripting.

Windwalkr (legacy 2550) at 09:34, 25 March 2010

2010-03-25T09:34:18Z

← Older revision		Revision as of 09:34, 25 March 2010
Line 1:		Line 1:
	Generic events can be linked to an animation key frame to give a measure of control over script timing. This is a different mechanism from Sound_Event, which interfaces with a ''soundscript'' container in config.txt and does not require scripting.		Generic events can be linked to an animation key frame to give a measure of control over script timing. 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 file, *.kin, is exported from Max ~~or Gmax~~, the exporter will make a query for an event file. Tick the box and you will be asked to browse to the file. The event information is added to the contents of the new animation.		When an animation file, *.kin, is exported from Max, the exporter will make a query for an event file. Tick the box and you will be asked to browse to the file. The event information is added to the contents of the new animation.

	* To produce an animation event which can be read by script you need to insert a line or lines similar to that below to a plain text file and to save it with an *.evt file extension.		* To produce an animation event which can be read by script you need to insert a line or lines similar to that below to a plain text file and to save it with an *.evt file extension.

Windwalkr: 1 revision

2010-02-03T13:58:21Z

1 revision

← Older revision	Revision as of 13:58, 3 February 2010
(No difference)

Andi06 at 19:51, 3 July 2008

2008-07-03T19:51:48Z

New page

Generic events can be linked to an animation key frame to give a measure of control over script timing. 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 file, *.kin, is exported from Max or Gmax, the exporter will make a query for an event file. Tick the box and you will be asked to browse to the file. The event information is added to the contents of the new animation.

* To produce an animation event which can be read by script you need to insert a line or lines similar to that below to a plain text file and to save it with an *.evt file extension.

002 Generic_Event animstart

* This example will result in the message ''Animation-Event,animstart'' being sent by the game whenever the animation plays past frame 2.
* It is best to avoid issuing events on the first or last frames since these are not always converted reliably into messages.
* To use the 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");
else if (msg.minor == "animstop")
Interface.Print("Animation has completed");
}

* 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.

==See Also==
* [[List of Standard Messages]]