CreateExplosion: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
| mNo edit summary | |||
| Line 3: | Line 3: | ||
| ==Syntax==   | ==Syntax==   | ||
| <syntaxhighlight lang="lua">createExplosion ( float x, float y, float z, int type, [ player creator ] )</syntaxhighlight>   | <syntaxhighlight lang="lua">bool createExplosion ( float x, float y, float z, int type, [ player creator ] )</syntaxhighlight>   | ||
| ===Required Arguments===   | ===Required Arguments===   | ||
| Line 11: | Line 11: | ||
| *'''type:''' A integer specifying the explosion type. Valid types are: | *'''type:''' A integer specifying the explosion type. Valid types are: | ||
| {{Explosions}} | {{Explosions}} | ||
| ===Returns=== | |||
| Returns ''true'' if the explosion was created, ''false'' if invalid parameters were passed. | |||
| ===Optional Arguments=== | ===Optional Arguments=== | ||
Revision as of 13:33, 13 April 2007
Creates an explosion of a certain type at a specified point in the world.
Syntax
bool createExplosion ( float x, float y, float z, int type, [ player creator ] )
Required Arguments
- x: A float value that specifies the X coordinate where the object is spawned at in the world
- y: A float value that specifies the Y coordinate where the object is spawned at in the world
- z: A float value that specifies the Z coordinate where the object is spawned at in the world
- type: A integer specifying the explosion type. Valid types are:
- 0: Grenade
- 1: Molotov
- 2: Rocket
- 3: Rocket Weak
- 4: Car
- 5: Car Quick
- 6: Boat
- 7: Heli
- 8: Mine
- 9: Object
- 10: Tank Grenade
- 11: Small
- 12: Tiny
 
Returns
Returns true if the explosion was created, false if invalid parameters were passed.
Optional Arguments
- creator: The explosion's simulated creator, responsible for it.
Example
This code will create an explosion at the player's position when they spawn.
root = getRootElement () addEventHandler ( "onPlayerSpawn", root, "onPlayerSpawn" ) function onPlayerSpawn ( spawnpoint ) createExplosion ( getElementPosition ( source ), 6, source ) end
See Also