Fire::startScriptFire - Revision history

SugarD-x: "TODO: Example" category no longer needed.

2021-09-28T04:06:02Z

"TODO: Example" category no longer needed.

← Older revision		Revision as of 04:06, 28 September 2021
Line 29:		Line 29:
	{{Fire_s_function_c}}		{{Fire_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	~~[[Category:TODO: Example]]~~

SugarD-x: Removed redundant comment from example.

2020-11-13T17:43:50Z

Removed redundant comment from example.

← Older revision		Revision as of 17:43, 13 November 2020
Line 19:		Line 19:
	{{ClientsideCode\|		{{ClientsideCode\|
	<pre>		<pre>
	~~// Clientside event~~
	mp.events.add('StartFire', (posX, posY, posZ, maxChildren, isGasFire) => {		mp.events.add('StartFire', (posX, posY, posZ, maxChildren, isGasFire) => {
	// The fireId is a int		// The fireId is a int

SugarD-x: Fixed two typographical errors, changed example to use clearer text labels matching the ones used by the function definition.

2020-11-13T17:42:58Z

Fixed two typographical errors, changed example to use clearer text labels matching the ones used by the function definition.

← Older revision		Revision as of 17:42, 13 November 2020
Line 19:		Line 19:
	{{ClientsideCode\|		{{ClientsideCode\|
	<pre>		<pre>
	//~~Client~~ event		// Clientside event
	mp.events.add('StartFire', (posX, posY, posZ, ~~maxChilderen~~, ~~gasPowerd~~) => {		mp.events.add('StartFire', (posX, posY, posZ, maxChildren, isGasFire) => {
	// The fireId is a int		// The fireId is a int
	let fireId = mp.game.fire.startScriptFire(posX, posY, posZ, ~~maxChilderen~~, ~~gasPowerd~~);		let fireId = mp.game.fire.startScriptFire(posX, posY, posZ, maxChildren, isGasFire);
	});		});
	</pre>		</pre>

Rootcause: Replaced HTML with template

2018-10-26T13:03:36Z

Replaced HTML with template

← Older revision		Revision as of 13:03, 26 October 2018
Line 1:		Line 1:
	Starts a fire:<br><br>xyz: Location of fire<br>maxChildren: The max amount of times a fire can spread to other objects. Must be 25 or less, or the function will do nothing.<br>isGasFire: Whether or not the fire is powered by gasoline.		Starts a fire:<br><br>xyz: Location of fire<br>maxChildren: The max amount of times a fire can spread to other objects. Must be 25 or less, or the function will do nothing.<br>isGasFire: Whether or not the fire is powered by gasoline.

	==Syntax==		==Syntax==
	<~~syntaxhighlight lang="javascript"~~>mp.game.fire.startScriptFire(X, Y, Z, maxChildren, isGasFire);</~~syntaxhighlight~~>		<pre>
			mp.game.fire.startScriptFire(X, Y, Z, maxChildren, isGasFire);
			</pre>

	=== Required Arguments ===		=== Required Arguments ===
	*'''X:''' float		*'''X:''' float
Line 8:		Line 12:
	*'''maxChildren:''' int		*'''maxChildren:''' int
	*'''isGasFire:''' Boolean		*'''isGasFire:''' Boolean

	===Return value===		===Return value===
	*'''int'''		*'''int'''

	==Example==		==Example==
	<~~syntaxhighlight lang="javascript"~~>		{{ClientsideCode\|
			<pre>
	//Client event		//Client event
	mp.events.add('StartFire', (posX, posY, posZ,maxChilderen,gasPowerd) => {		mp.events.add('StartFire', (posX, posY, posZ, maxChilderen, gasPowerd) => {
	// The fireId is a int		// The fireId is a int
	let fireId = mp.game.fire.startScriptFire(posX, posY, posZ, maxChilderen, gasPowerd);		let fireId = mp.game.fire.startScriptFire(posX, posY, posZ, maxChilderen, gasPowerd);
	});		});
	</~~syntaxhighlight~~>		</pre>
			}}

	==See also==		==See also==

Spacefrog: /* Example */

2018-05-24T12:55:10Z

Example

← Older revision		Revision as of 12:55, 24 May 2018
Line 15:		Line 15:
	//Client event		//Client event
	mp.events.add('StartFire', (posX, posY, posZ,maxChilderen,gasPowerd) => {		mp.events.add('StartFire', (posX, posY, posZ,maxChilderen,gasPowerd) => {
	~~// Parameters float,float,float,int,boolean~~
	// The fireId is a int		// The fireId is a int
	let fireId = mp.game.fire.startScriptFire(posX, posY, posZ, maxChilderen, gasPowerd);		let fireId = mp.game.fire.startScriptFire(posX, posY, posZ, maxChilderen, gasPowerd);

Spacefrog: /* Example */

2018-05-24T12:53:49Z

Example

← Older revision		Revision as of 12:53, 24 May 2018
Line 12:		Line 12:
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	// ~~todo~~
			//Client event
			mp.events.add('StartFire', (posX, posY, posZ,maxChilderen,gasPowerd) => {
			// Parameters float,float,float,int,boolean
			// The fireId is a int
			let fireId = mp.game.fire.startScriptFire(posX, posY, posZ, maxChilderen, gasPowerd);
			});
	</syntaxhighlight>		</syntaxhighlight>

	==See also==		==See also==
	{{Fire_s_function_c}}		{{Fire_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:TODO: Example]]		[[Category:TODO: Example]]

Marty uploader: yay

2017-05-06T21:06:24Z

yay

← Older revision		Revision as of 21:06, 6 May 2017
Line 1:		Line 1:
	Starts a fire:<br><br>xyz: Location of fire<br>maxChildren: The max amount of times a fire can spread to other objects. Must be 25 or less, or the function will do nothing.<br>isGasFire: Whether or not the fire is powered by gasoline.		Starts a fire:<br><br>xyz: Location of fire<br>maxChildren: The max amount of times a fire can spread to other objects. Must be 25 or less, or the function will do nothing.<br>isGasFire: Whether or not the fire is powered by gasoline.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">fire.startScriptFire(X, Y, Z, maxChildren, isGasFire);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.game.fire.startScriptFire(X, Y, Z, maxChildren, isGasFire);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''X:''' float		*'''X:''' float
Line 12:		Line 12:
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	todo		// todo
	</syntaxhighlight>		</syntaxhighlight>
	==See also==		==See also==
	{{~~Fire_function_c~~}}		{{Fire_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:TODO: Example]]		[[Category:TODO: Example]]

Marty uploader: yay

2017-05-06T20:24:30Z

yay

New page

Starts a fire:<br><br>xyz: Location of fire<br>maxChildren: The max amount of times a fire can spread to other objects. Must be 25 or less, or the function will do nothing.<br>isGasFire: Whether or not the fire is powered by gasoline.
==Syntax==
<syntaxhighlight lang="javascript">fire.startScriptFire(X, Y, Z, maxChildren, isGasFire);</syntaxhighlight>
=== Required Arguments ===
*'''X:''' float
*'''Y:''' float
*'''Z:''' float
*'''maxChildren:''' int
*'''isGasFire:''' Boolean
===Return value===
*'''int'''
==Example==
<syntaxhighlight lang="javascript">
todo
</syntaxhighlight>
==See also==
{{Fire_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]