CreateExplosion: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
{{Info|Function|Server|1.0}} | {{Info|Function|Server|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Creates an explosion at the specified coordinates.}} | ||
{{FuncSyntax|CreateExplosion(explosionid, x, y, z [, dimension, soundExplosion, camShakeRadius, radialForce])}} | {{FuncSyntax|CreateExplosion(explosionid, x, y, z [, dimension, soundExplosion, camShakeRadius, radialForce])}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|explosionid| | {{FuncParam|explosionid|The explosion identifier.}} | ||
{{FuncParam|x| | {{FuncParam|x|The X axis}} | ||
{{FuncParam|y| | {{FuncParam|y|The Y axis}} | ||
{{FuncParam|z | | {{FuncParam|z |The Z axis}} | ||
{{FuncParam|dimension | | {{FuncParam|dimension |The dimension identifier}} | ||
{{FuncParam|soundExplosion| | {{FuncParam|soundExplosion|The sound of explosion}} | ||
{{FuncParam|camShakeRadius| | {{FuncParam|camShakeRadius|The camera shake radius}} | ||
{{FuncParamOptional|radialForce| | {{FuncParamOptional|radialForce|The radial force of the explosion}} | ||
{{FuncReturnValue|__EDIT_ME__}} | {{FuncReturnValue|__EDIT_ME__}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua> | |||
function cmd_burn(player, otherplayer) | |||
if (PlayerData[player].admin < 2) then | |||
return AddPlayerChat(player, "Insufficient permission") | |||
end | |||
if (otherplayer == nil) then | |||
return AddPlayerChat(player, "Usage: /burn <player>") | |||
end | |||
otherplayer = tonumber(otherplayer) | |||
if (not IsValidPlayer(otherplayer)) then | |||
return AddPlayerChat(player, "Selected player does not exist") | |||
end | |||
local x, y, z = GetPlayerLocation(otherplayer) | |||
CreateExplosion(9, x + 200.0, y + 8.0, z + 3.0, true, 1500.0, 1000000.0) | |||
AddPlayerChat(player, "You have burnt "..GetPlayerName(otherplayer).."("..otherplayer..")") | |||
end | |||
AddCommand("burn", cmd_burn) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
__EDIT_ME__ | __EDIT_ME__ |
Revision as of 15:26, 17 November 2019
Description
Creates an explosion at the specified coordinates.
Syntax
CreateExplosion(explosionid, x, y, z [, dimension, soundExplosion, camShakeRadius, radialForce])
Parameters
- explosionid
The explosion identifier. - x
The X axis - y
The Y axis - z
The Z axis - dimension
The dimension identifier - soundExplosion
The sound of explosion - camShakeRadius
The camera shake radius - radialForce (optional)
The radial force of the explosion
Return Value
- __EDIT_ME__
Example
function cmd_burn(player, otherplayer)
if (PlayerData[player].admin < 2) then
return AddPlayerChat(player, "Insufficient permission")
end
if (otherplayer == nil) then
return AddPlayerChat(player, "Usage: /burn <player>")
end
otherplayer = tonumber(otherplayer)
if (not IsValidPlayer(otherplayer)) then
return AddPlayerChat(player, "Selected player does not exist")
end
local x, y, z = GetPlayerLocation(otherplayer)
CreateExplosion(9, x + 200.0, y + 8.0, z + 3.0, true, 1500.0, 1000000.0)
AddPlayerChat(player, "You have burnt "..GetPlayerName(otherplayer).."("..otherplayer..")")
end
AddCommand("burn", cmd_burn)
See also
__EDIT_ME__