ShowOff:OnProjectileDestroy

From GECK
Jump to: navigation, search

An event handler added by the ShowOff NVSE Plugin version 1.50.

Description

This event runs whenever a projectile is about to be destroyed.

The event is flushed every time the game is loaded. Use a GetGameLoaded check or other method to re-register a handler.

Dispatched Args

GetSelf / GetSelfAlt will return the projectile reference that is about to be destroyed.

The args dispatched to handlers are:

  1. The projectile's source Actor reference.
  2. The projectile's source Weapon BaseForm.

Syntax

Use SetEventHandler / SetEventHandlerAlt with the event name "ShowOff:OnProjectileDestroy".

Handler Script

A skeleton handler script for this event:

scn OnProjectileDestroyUDF

begin Function { ref rProjOwner, ref rWeapon }
   ref rProjRef = GetSelfAlt  ;* GetSelf would do the same thing
   ; do code
end

Example

SetEventHandlerAlt "ShowOff:OnProjectileDestroy" OnProjectileDestroyUDF 1::Player

Will register OnProjectileDestroyUDF as an event handler for the event, and it should only be called if the projectile's owner is the Player.

See Also