CreateFire: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
{{Client function}} | {{Client function}} | ||
Creates a patch of fire that will spread a bit and die out after a while. | Creates a patch of fire that will spread a bit and die out after a while. Because it's a client side only function, other players won't see it, so custom events or custom objects will be needed to make a fire visible to some players. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''x, y, z:''' coordinates of | *'''x, y, z:''' the coordinates when the initial patch of fire will be created. | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
*'''size:''' the size of the initial fire. | *'''size:''' a float value indicating the size of the initial patch of fire. It will also make the fire to stay alive more or less time. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if successful, ''false'' | Returns ''true'' if successful, ''false'' if bad arguments were passed or the limit of active fires was reached. There can be a maximum of 60 active fires. | ||
== Example == | == Example == | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
This example adds a /fire command, which creates a patch of fire in the position of the player that types it. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
Revision as of 10:28, 17 May 2014
Creates a patch of fire that will spread a bit and die out after a while. Because it's a client side only function, other players won't see it, so custom events or custom objects will be needed to make a fire visible to some players.
Syntax
bool createFire ( float x, float y, float z [, float size = 1.8 ] )
Required Arguments
- x, y, z: the coordinates when the initial patch of fire will be created.
Optional Arguments
- size: a float value indicating the size of the initial patch of fire. It will also make the fire to stay alive more or less time.
Returns
Returns true if successful, false if bad arguments were passed or the limit of active fires was reached. There can be a maximum of 60 active fires.
Example
Click to collapse [-]
ClientThis example adds a /fire command, which creates a patch of fire in the position of the player that types it.
function burn(commandName, theSize)
if theSize then
local x, y, z = getElementPosition(getLocalPlayer())
createFire(x, y, z, theSize)
outputChatBox("Burn, buuuuurn >:]")
else
outputChatBox("Syntax: /fire <size>")
end
end
addCommandHandler("fire", burn)
See Also