Pool::forEach - Revision history

Shr0x: Pool list

2024-11-10T12:10:24Z

Pool list

← Older revision		Revision as of 12:10, 10 November 2024
Line 2:		Line 2:
	{{JSContainer\|		{{JSContainer\|

	~~==Available Entity Pools==~~		{{Pool_list}}

	* '''mp.players''' - Pool of all connected players
	* '''mp.vehicles''' - Pool of all active vehicles
	* '''mp.objects''' - Pool of all world objects
	* '''mp.peds''' - Pool of all non-player characters (peds)
	* '''mp.markers''' - Pool of all markers in the game
	* '''mp.blips''' - Pool of all blips on the map
	* '''mp.checkpoints''' - Pool of all checkpoints
	* '''mp.colshapes''' - Pool of all collision shapes
	* '''mp.labels''' - Pool of all text labels in the world

	==Summary==		==Summary==

Shr0x at 11:58, 10 November 2024

2024-11-10T11:58:13Z

← Older revision		Revision as of 11:58, 10 November 2024
Line 1:		Line 1:
	~~This~~ function ~~is used for calling~~ a function for ~~each element in~~ a pool.		{{ServersideJsFunction}}
			{{JSContainer\|

			==Available Entity Pools==

			* '''mp.players''' - Pool of all connected players
			* '''mp.vehicles''' - Pool of all active vehicles
			* '''mp.objects''' - Pool of all world objects
			* '''mp.peds''' - Pool of all non-player characters (peds)
			* '''mp.markers''' - Pool of all markers in the game
			* '''mp.blips''' - Pool of all blips on the map
			* '''mp.checkpoints''' - Pool of all checkpoints
			* '''mp.colshapes''' - Pool of all collision shapes
			* '''mp.labels''' - Pool of all text labels in the world

			==Summary==
			The `pool.forEach` function iterates over each element in a pool, applying a specified function to each entity. It’s useful for actions that involve every entity within a pool, such as broadcasting messages, modifying player states, or destroying all vehicles.

	==Syntax==		==Syntax==
	<~~pre~~>		<syntaxhighlight lang="javascript">
	pool.forEach(Function callingFunction);		pool.forEach(Function callingFunction)
	</~~pre~~>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''callingFunction:''' Function~~, what will be called~~.		*'''callingFunction:''' {{RageType\|Function}} — A function to apply to each entity in the pool.

	==Example #1==		==Examples==
	This example ~~will generate text with~~ all player nicknames.		===Example #1===
			This example collects and returns a string of all player nicknames on the server.

	{{ServersideCode\|		{{ServersideCode\|
	<~~pre~~>		<syntaxhighlight lang="javascript">
	let getNicknamesText = () => {		let getNicknamesText = () => {
	let text = ``;		let text = ``;
	mp.players.forEach(		mp.players.forEach((player) => {
	(player~~, id~~) => {		text = text === `` ? player.name : `${text}, ${player.name}`;
	text = text == `` ? player.name : `${text} , ${player.name}`;		});
	}		return text;
	);
	return text;
	};		};

	~~let blahBlah~~ = getNicknamesText();		const nicknameText = getNicknamesText();
	console.log(~~blahBlah~~ != `` ? ~~blahBlah~~ : `~~Server not have~~ players.`);		console.log(nicknameText !== `` ? nicknameText : `No players online.`);
	</~~pre~~>		</syntaxhighlight>
	}}		}}

	==Example #2==		===Example #2===
	This example ~~will add~~ a command to remove all server ~~vehicles by~~ forEach.		This example adds a command to remove all vehicles on the server using `forEach`.

	{{ServersideCode\|		{{ServersideCode\|
	<~~pre~~>		<syntaxhighlight lang="javascript">
	mp.events.addCommand(`removeAll`,		mp.events.addCommand("removeAll", (player) => {
	(player) => {		mp.vehicles.forEach((vehicle) => {
	mp.vehicles.forEach(		vehicle.destroy();
	(vehicle) => {		});
	vehicle.destroy();		mp.players.broadcast(`${player.name} has destroyed all vehicles!`);
	}		});
	);		</syntaxhighlight>
	mp.players.broadcast(`${player.name} ~~DESTROY ALL CARS~~!`);
	}
	);
	</~~pre~~>
	}}		}}
	==Example #3==
	This example ~~will teleport~~ a player ~~that~~ types ~~the command~~ /port to the player ~~whose name he writes as 1st argument~~.		===Example #3===
			This example teleports a player who types `/port <name>` to the location of the specified player.

	{{ServersideCode\|		{{ServersideCode\|
	<~~pre~~>		<syntaxhighlight lang="javascript">
	mp.events.addCommand('port', (player, name) => {		mp.events.addCommand("port", (player, name) => {
	mp.players.forEach(_player => {		mp.players.forEach((_player) => {
	if(_player.name === name)		if (_player.name === name) player.position = _player.position;
	player.position = _player.position;		});
	});
	});		});
	</~~pre~~>		</syntaxhighlight>
			}}

	}}		}}
	==See Also==		==See Also==
	{{EntityPool_function}}		{{EntityPool_function}}
			[[Category:Serverside API]]

Almeidowski: Adding a third and easier to understand example

2020-09-02T11:35:09Z

Adding a third and easier to understand example

← Older revision		Revision as of 11:35, 2 September 2020
Line 44:		Line 44:
	</pre>		</pre>
	}}		}}
			==Example #3==
			This example will teleport a player that types the command /port to the player whose name he writes as 1st argument.
			{{ServersideCode\|
			<pre>
			mp.events.addCommand('port', (player, name) => {
			mp.players.forEach(_player => {
			if(_player.name === name)
			player.position = _player.position;
			});
			});
			</pre>
			}}
	==See Also==		==See Also==
	{{EntityPool_function}}		{{EntityPool_function}}

Rootcause: Replaced HTML with template

2018-10-26T11:56:00Z

Replaced HTML with template

← Older revision		Revision as of 11:56, 26 October 2018
Line 2:		Line 2:

	==Syntax==		==Syntax==
	<~~syntaxhighlight lang="javascript"~~>		<pre>
	pool.forEach(Function callingFunction);		pool.forEach(Function callingFunction);
	</~~syntaxhighlight~~>		</pre>
	===Required Arguments===		===Required Arguments===
	*'''callingFunction:''' Function, what will be called.		*'''callingFunction:''' Function, what will be called.
Line 11:		Line 11:
	This example will generate text with all player nicknames.		This example will generate text with all player nicknames.

	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~		<pre>
	<~~syntaxhighlight lang="javascript" highlight="3-7"~~>
	let getNicknamesText = () => {		let getNicknamesText = () => {
	let text = ``;		let text = ``;
Line 26:		Line 25:
	let blahBlah = getNicknamesText();		let blahBlah = getNicknamesText();
	console.log(blahBlah != `` ? blahBlah : `Server not have players.`);		console.log(blahBlah != `` ? blahBlah : `Server not have players.`);
	</~~syntaxhighlight~~>		</pre>
	~~</div>~~		}}

	==Example #2==		==Example #2==
	This example will add a command to remove all server vehicles by forEach.		This example will add a command to remove all server vehicles by forEach.
	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~		<pre>
	<~~syntaxhighlight lang="javascript" highlight="3-7"~~>
	mp.events.addCommand(`removeAll`,		mp.events.addCommand(`removeAll`,
	(player) => {		(player) => {
Line 44:		Line 42:
	}		}
	);		);
	</~~syntaxhighlight~~>		</pre>
	~~</div>~~		}}

	==See Also==		==See Also==
	{{EntityPool_function}}		{{EntityPool_function}}

SalwadoR: Undo revision 7304 by SalwadoR (talk)

2017-09-26T15:24:41Z

Undo revision 7304 by SalwadoR (talk)

← Older revision		Revision as of 15:24, 26 September 2017
Line 13:		Line 13:
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
	<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript" highlight="3">		<syntaxhighlight lang="javascript" highlight="3-7">
	let getNicknamesText = () => {		let getNicknamesText = () => {
	let text = ``;		let text = ``;
Line 33:		Line 33:
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
	<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript" highlight="3">		<syntaxhighlight lang="javascript" highlight="3-7">
	mp.events.addCommand(`removeAll`,		mp.events.addCommand(`removeAll`,
	(player) => {		(player) => {

SalwadoR at 15:23, 26 September 2017

2017-09-26T15:23:33Z

← Older revision		Revision as of 15:23, 26 September 2017
Line 13:		Line 13:
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
	<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript" highlight="3-7">		<syntaxhighlight lang="javascript" highlight="3">
	let getNicknamesText = () => {		let getNicknamesText = () => {
	let text = ``;		let text = ``;
Line 33:		Line 33:
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
	<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript" highlight="3-7">		<syntaxhighlight lang="javascript" highlight="3">
	mp.events.addCommand(`removeAll`,		mp.events.addCommand(`removeAll`,
	(player) => {		(player) => {

SalwadoR at 15:22, 26 September 2017

2017-09-26T15:22:33Z

← Older revision		Revision as of 15:22, 26 September 2017
Line 13:		Line 13:
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
	<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" highlight="3-7">
	let getNicknamesText = () => {		let getNicknamesText = () => {
	let text = ``;		let text = ``;

SalwadoR at 15:22, 26 September 2017

2017-09-26T15:22:09Z

← Older revision		Revision as of 15:22, 26 September 2017
Line 33:		Line 33:
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
	<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript" highlight="3-7">
	mp.events.addCommand(`removeAll`,		mp.events.addCommand(`removeAll`,
	(player) => {		(player) => {

SalwadoR at 14:56, 26 September 2017

2017-09-26T14:56:29Z

← Older revision		Revision as of 14:56, 26 September 2017
Line 3:		Line 3:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	~~void~~ pool.forEach(~~function~~ callingFunction);		pool.forEach(Function callingFunction);
	</syntaxhighlight>		</syntaxhighlight>
	===Required Arguments===		===Required Arguments===

CurtisVL: Small fix

2017-09-20T10:08:54Z

Small fix

← Older revision		Revision as of 10:08, 20 September 2017
Line 1:		Line 1:
	This function is used for calling a function for each element a in pool.		This function is used for calling a function for each element in a pool.

	==Syntax==		==Syntax==