CreateExplosion: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">createExplosion ( x, y, z, type, player creator )</syntaxhighlight>  
<syntaxhighlight lang="lua">createExplosion ( x, y, z, type, [ player creator ] )</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
Line 10: Line 10:
*'''Z:''' A Float value that specifies the Z coordinate where the object is spawned at in the GTASA world
*'''Z:''' A Float value that specifies the Z coordinate where the object is spawned at in the GTASA world
*'''Type:''' A Whole number specifying the explosion type
*'''Type:''' A Whole number specifying the explosion type
===Optional Arguments===
*'''Creator:''' The explosions simulated creator, responsible for it.
*'''Creator:''' The explosions simulated creator, responsible for it.



Revision as of 22:15, 8 June 2006

Creates an explosion of a certain type at a specified location using x,y,z.

Syntax

createExplosion ( x, y, z, type, [ player creator ] )

Required Arguments

  • X: A Float value that specifies the X coordinate where the object is spawned at in the GTASA world
  • Y: A Float value that specifies the Y coordinate where the object is spawned at in the GTASA world
  • Z: A Float value that specifies the Z coordinate where the object is spawned at in the GTASA world
  • Type: A Whole number specifying the explosion type

Optional Arguments

  • Creator: The explosions simulated creator, responsible for it.

Example

Explain what the example does here

root = getRootElement ()
addEventHandler ( "onPlayerSpawn", root, "onPlayerSpawn" )
function onPlayerSpawn ( spawnpoint )
  createExplosion ( getEntityPosition ( source ), 6, source )
end

See Also