explosion_create(explosion_name, obj_name[, owner_name[, use_source[, vfx_nav_name[, random_offset]]]])

Parameters:
explosion_name (string) name of the explosion type
obj_name (string) name of the object
owner_name (string, optional) name of the owner (i.e.: who is responsible for starting the explosion) (defaults to nil)
use_source (boolean, optional) set to true if it is the object itself that is exploding, or false if the explosion is coming from something else (defaults to true)
vfx_nav_name (string, optional) name of the VFX navpoint that references the VFX that the explosion plays (for explosions that reference VFX that are loaded by the mission)
random_offset (float, optional) if > 0, the explosion will be created in a random position this distance from the target object (defaults to 0)
 
Returns:
none

Description:
Create an explosion on an object.

returns: Handle to the VFX object that was creates as a result of the explosion

 

back to indexSR3 Script Action Documentation
Last updated: Tue, 09 Aug 2011 11:32:15