RegisterForRadiationDamageEvent function - ScriptObject script

Found in:

Vanilla

voidfunctionRegisterForRadiationDamageEvent(ScriptObjectakTarget)Native

Description

Wiki Description

Registers this script to receive a single OnRadiationDamage event from the target.

Only the script that registers for an event will receive it. Other scripts attached to the same form, alias, or magic effect will not receive the event unless they also register for it.

Documentation Comment

Registers for a single radiation damage event from the specified target.
Targets can be actors, ref aliases, or ref collection aliases
Objects without registrations CANNOT receive radiation damage events!

Caveats

CK Wiki - Notes

Registration is removed after the first radiation damage received. You have to re-register to get another event.
Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.

Parameters

ScriptObjectakTarget
CK Wiki Description
The Actor, ReferenceAlias or RefCollectionAlias that is taking radiation damage.

Examples

; Register for when the player takes radiation damage
RegisterForRadiationDamageEvent(Game.GetPlayer())

Auto-Generated Example

ScriptObject myScriptObject__akTarget

myScriptObject__toCallFunctionOn.RegisterForRadiationDamageEvent(myScriptObject__akTarget)

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki