CreateFire - Revision history

Skully: Fixed English and clarified explanation of size argument.

2021-09-08T01:53:18Z

Fixed English and clarified explanation of size argument.

← Older revision		Revision as of 01:53, 8 September 2021
Line 12:		Line 12:

	===Optional Arguments===		===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~~.		*'''size:''' a float value indicating the size of the initial patch of fire, this value also affects the duration of how long the fire remains.

	===Returns===		===Returns===

2016-08-26T13:28:28Z

← Older revision		Revision as of 13:28, 26 August 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
			[[Image:Fire.png\|thumb\|200px\|Fire with default size (1.8)]]

	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.		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.

2015-02-17T01:01:05Z

← Older revision		Revision as of 01:01, 17 February 2015
Line 21:		Line 21:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function burn(commandName, theSize)		local function burn(commandName, theSize)
	if tonumber(theSize) then		if tonumber(theSize) then
	local x, y, z = getElementPosition(getLocalPlayer())		local x, y, z = getElementPosition(getLocalPlayer())

2014-05-17T10:59:13Z

Example

← Older revision		Revision as of 10:59, 17 May 2014
Line 22:		Line 22:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function burn(commandName, theSize)		function burn(commandName, theSize)
	if theSize then		if tonumber(theSize) then
	local x, y, z = getElementPosition(getLocalPlayer())		local x, y, z = getElementPosition(getLocalPlayer())
	createFire(x, y, z, theSize)		createFire(x, y, z, tonumber(theSize))
	outputChatBox("Burn, buuuuurn >:]")		outputChatBox("Burn, buuuuurn >:]")
	else		else

2014-05-17T10:32:43Z

Example

← Older revision		Revision as of 10:32, 17 May 2014
Line 18:		Line 18:
	== Example ==		== Example ==

	~~<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.		This example adds a /fire command, which creates a patch of fire in the position of the player that types it.

Line 33:		Line 32:
	addCommandHandler("fire", burn)		addCommandHandler("fire", burn)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==
	{{Client fire functions}}		{{Client fire functions}}

2014-05-17T10:28:58Z

← Older revision		Revision as of 10:28, 17 May 2014
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 ~~the~~ fire.		*'''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'' ~~otherwise~~. There can be a maximum of 60 active fires.		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">
	~~Command for creating Clientside Fire on~~ the ~~Players Position~~.		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">

2010-05-03T21:11:59Z

← Older revision		Revision as of 21:11, 3 May 2010
Line 23:		Line 23:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function burn(commandName, theSize)		function burn(commandName, theSize)
	~~local thePlayer = getLocalPlayer()~~
	if theSize then		if theSize then
	local x, y, z = getElementPosition(~~thePlayer~~)		local x, y, z = getElementPosition(getLocalPlayer())
	createFire(x, y, z, theSize)		createFire(x, y, z, theSize)
	outputChatBox("Burn, buuuuurn >:]"~~, thePlayer~~)		outputChatBox("Burn, buuuuurn >:]")
	else		else
	outputChatBox("Syntax: /fire <size>"~~, thePlayer~~)		outputChatBox("Syntax: /fire <size>")
	end		end
	end		end

2010-05-03T21:11:32Z

← Older revision		Revision as of 21:11, 3 May 2010
Line 22:		Line 22:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function burn(~~player,~~ commandName, ~~height~~)		function burn(commandName, theSize)
	if ~~height~~ then		local thePlayer = getLocalPlayer()
	x, y, z = ~~getPlayerPosition~~(~~player~~)		if theSize then
	createFire(x, y, z, ~~height~~)		local x, y, z = getElementPosition(thePlayer)
	outputChatBox("Burn ~~motherfucker~~, buuuuurn >:]", ~~player~~)		createFire(x, y, z, theSize)
			outputChatBox("Burn, buuuuurn >:]", thePlayer)
	else		else
	outputChatBox("Syntax: /fire <~~height~~>", ~~player~~)		outputChatBox("Syntax: /fire <size>", thePlayer)
	end		end
	end		end

2010-05-02T10:15:53Z

← Older revision		Revision as of 10:15, 2 May 2010
Line 33:		Line 33:
	addCommandHandler("fire", burn)		addCommandHandler("fire", burn)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Client fire functions}}		{{Client fire functions}}

2010-05-02T02:17:59Z

Example

← Older revision		Revision as of 02:17, 2 May 2010
Line 19:		Line 19:

	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	Command for creating Clientside Fire.		Command for creating Clientside Fire on the Players Position.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">