Pool::forEach

From RAGE Multiplayer Wiki
Jump to navigation Jump to search

This function is used for calling a function for each element in a pool.

Syntax

pool.forEach(Function callingFunction);

Required Arguments

  • callingFunction: Function, what will be called.

Example #1

This example will generate text with all player nicknames.

Server-Side
let getNicknamesText = () => {
	let text = ``;
	mp.players.forEach(
		(player, id) => {
			text = text == `` ? player.name : `${text} , ${player.name}`;
		}
	);
	return text;
};

let blahBlah = getNicknamesText();
console.log(blahBlah != `` ? blahBlah : `Server not have players.`);

Example #2

This example will add a command to remove all server vehicles by forEach.

Server-Side
mp.events.addCommand(`removeAll`, 
	(player) => {
		mp.vehicles.forEach(
			(vehicle) => {
				vehicle.destroy();
			}
		);
		mp.players.broadcast(`${player.name} DESTROY ALL CARS!`);
	}
);

See Also