Difference between revisions of "SetOnAnimActionEventHandler"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Jazzisparis
(Created page with "{{Function |origin = JIP |summary = Sets/removes the specified '''UDF Script''' as a handler that will be invoked in the event the specified '''Actor''' starts performing th...")
 
imported>Jazzisparis
Line 2: Line 2:
  |origin = JIP
  |origin = JIP
  |summary = Sets/removes the specified '''UDF Script''' as a handler that will be invoked in the event the specified '''Actor''' starts performing the specified '''Animation Action''' (see [[GetAnimAction]]).
  |summary = Sets/removes the specified '''UDF Script''' as a handler that will be invoked in the event the specified '''Actor''' starts performing the specified '''Animation Action''' (see [[GetAnimAction]]).
When invoked, the script is passed with the '''Actor''' as the calling reference ("<i>this</i>"), and a single argument: the performed '''Animation Action''' (0-13).
When invoked, the script is passed with the '''Actor''' as the calling reference ("<i>this</i>"), and a single argument: the performed '''Animation Action''' (0-13).
  |name = SetOnAnimActionEventHandler
  |name = SetOnAnimActionEventHandler

Revision as of 18:04, 24 January 2017

< [[::Category:Functions|Category:Functions]]

A function added by the JIP NVSE Plugin.

Description

Sets/removes the specified UDF Script as a handler that will be invoked in the event the specified Actor starts performing the specified Animation Action (see GetAnimAction).

When invoked, the script is passed with the Actor as the calling reference ("this"), and a single argument: the performed Animation Action (0-13).

Syntax

[help]
SetOnAnimActionEventHandler handlerScript:ref setORremove:1/0 actor:ref animAction:int{0-13}

Example

SetOnAnimActionEventHandler OnAnimActionUDF 1 SomeActor 2

Sets the OnAnimActionUDF script as a handler to be invoked when SomeActor starts performing the Attack action.

SetOnAnimActionEventHandler OnAnimActionUDF 0 SomeActor 2

Removes the OnAnimActionUDF script as a handler of the above.

Handler Script

A skeleton handler script for this event:

scn	OnAnimActionUDF

int	iAnimAction
ref	rActorRef

begin Function {iAnimAction}

	set rActorRef to this

	(code)

end

See Also