effect_play_on_script_object(navpoint_name, object_name[, object_tag[, looping[, sync_flags[, nth_vehicle_tag]]]]) |
|
Parameters: |
navpoint_name | | (string) name of the VFX object's navpoint (the effect will not spawn here, but we still need to go through the mision effect pipelien) |
object_name | | (string) name of the object |
object_tag | | (string, optional) name of the object tag to attach to effect to |
looping | | (boolean, optional) set to true to loop the effect indefinitely (defaults to false) |
sync_flags | | (integer, optional) synchronization type (MULTI_SYNC_LOCAL = affects local player, MULTI_SYNC_REMOTE = affects remote player, or MULTI_SYNC_ALL = affects both players; defaults to MULTI_SYNC_ALL) |
nth_vehicle_tag | | (integer, optional) nth vehicle tag to use (only valid for vehicle tags) (defaults to 1) |
|
Returns: |
(integer) handle of the effect, or -1 if unable to start the effect |
|
Description: |
Play an effect attached to an object |
|
|
back to index | SR3 Script Action Documentation Last updated: Tue, 09 Aug 2011 11:32:15 |