SetOnCrippledLimbEventHandler
From GECK
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 has one of his limbs crippled.
When invoked, the script is passed with the Actor as the calling reference ("this"), and a single argument: an integer indicating which limb was crippled:
0 Head 1 Torso 2 Left Hand 3 Right Hand 4 Left Leg 5 Right Leg 6 Brain
Syntax
SetOnCrippledLimbEventHandler handlerScript:ref setORremove:1/0 actorOrList:ref
Example
SetOnCrippledLimbEventHandler OnCrippledLimbUDF 1 SomeActor
Sets the OnCrippledLimbUDF script as a handler to be invoked when SomeActor becomes crippled.
SetOnCrippledLimbEventHandler OnCrippledLimbUDF 0 SomeActor
Removes the OnCrippledLimbUDF script as a handler of the above.
Notes
- As the third argument, either a single reference, or a FormList of references may be passed.
Handler Script
A skeleton handler script for this event:
scn OnCrippledLimbUDF
int iWhichLimb
ref rActorRef
begin Function {iWhichLimb}
set rActorRef to this
(code)
end
