Pool::at - Revision history

Shr0x: Pool list

2024-11-10T12:07:36Z

Pool list

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

	~~==Available Entity Pools==~~		{{Pool_list}}
	~~In RAGEMP serverside JavaScript, the following entity pools are used to manage different in-game elements:~~
	* '''mp.players''' — Manages all player entities.
	* '''mp.vehicles''' — Manages all vehicle entities.
	* '''mp.objects''' — Manages all world object entities.
	* '''mp.colshapes''' — Manages all collision shapes.
	* '''mp.markers''' — Manages all map markers.
	* '''mp.checkpoints''' — Manages all checkpoints.
	* '''mp.labels''' — Manages all text labels.
	* '''mp.blips''' — Manages all map blips.
	* '''mp.pickups''' — Manages item pickups in the world.

	==Summary==		==Summary==

Shr0x at 11:31, 10 November 2024

2024-11-10T11:31:48Z

← Older revision		Revision as of 11:31, 10 November 2024
Line 1:		Line 1:
	~~This function is used to return an element from a pool at an ID.~~		{{ServersideJsFunction}}
			{{JSContainer\|

	==Syntax==		==Available Entity Pools==
	<~~pre~~>		In RAGEMP serverside JavaScript, the following entity pools are used to manage different in-game elements:
	~~Entity~~ pool.at(~~Number ID~~)		* '''mp.players''' — Manages all player entities.
	</~~pre~~>		* '''mp.vehicles''' — Manages all vehicle entities.
	===~~Returns~~===		* '''mp.objects''' — Manages all world object entities.
	An entity with the selected ID from a pool, or undefined if entity with ~~this~~ ID ~~does not exists~~.		* '''mp.colshapes''' — Manages all collision shapes.
			* '''mp.markers''' — Manages all map markers.
			* '''mp.checkpoints''' — Manages all checkpoints.
			* '''mp.labels''' — Manages all text labels.
			* '''mp.blips''' — Manages all map blips.
			* '''mp.pickups''' — Manages item pickups in the world.

			==Summary==
			The `pool.at` function returns an entity from a specified pool by its ID. It is useful for accessing specific entities such as players, vehicles, or objects by their unique server-side ID.

			===Syntax===
			<syntaxhighlight lang="javascript">
			pool.at(id)
			</syntaxhighlight>

			===Return value===
			An entity with the selected ID from a pool, or `undefined` if no entity exists with that ID.

	===Required Arguments===		===Required Arguments===
	*'''ID:''' ~~Element~~ ID~~, what you need get~~ from the pool.		*'''id:''' {{RageType\|Number}} — The ID of the element to retrieve from the pool.
	==Example==
	This example ~~will return~~ a player by ID and ~~output his~~ name in the console.		==Example==
	~~{{ServersideCode\|~~		This example retrieves a player by ID and outputs their name to the console if they exist.
	<~~pre~~>
			<syntaxhighlight lang="javascript">
	let player = mp.players.at(1488);		let player = mp.players.at(1488);
	if (player) {		if (player) {
	console.log(`Player with id 1488 ~~have~~ nickname ${player.name}`);		console.log(`Player with ID 1488 has nickname ${player.name}`);
	} else {		} else {
	console.log(`Player with id 1488 does not exist...`);		console.log(`Player with ID 1488 does not exist...`);
	};		}
	</~~pre~~>		</syntaxhighlight>

	}}		}}

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

SugarD-x: Another grammatical error was fixed.

2021-08-04T23:27:37Z

Another grammatical error was fixed.

← Older revision		Revision as of 23:27, 4 August 2021
Line 18:		Line 18:
	console.log(`Player with id 1488 have nickname ${player.name}`);		console.log(`Player with id 1488 have nickname ${player.name}`);
	} else {		} else {
	console.log(`Player by id 1488 does not exist...`);		console.log(`Player with id 1488 does not exist...`);
	};		};
	</pre>		</pre>

SugarD-x: A grammatical error was fixed.

2021-08-04T23:27:14Z

A grammatical error was fixed.

← Older revision		Revision as of 23:27, 4 August 2021
Line 18:		Line 18:
	console.log(`Player with id 1488 have nickname ${player.name}`);		console.log(`Player with id 1488 have nickname ${player.name}`);
	} else {		} else {
	console.log(`Player by id 1488 does not ~~exists~~...`);		console.log(`Player by id 1488 does not exist...`);
	};		};
	</pre>		</pre>

Ragempdev: Reverted edits by YnnhoJ (talk) to last revision by Rootcause

2020-05-28T20:27:18Z

Reverted edits by YnnhoJ (talk) to last revision by Rootcause

← Older revision		Revision as of 20:27, 28 May 2020
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''ID~~/Entity~~:''' Element, what you need get from the pool.		*'''ID:''' Element ID, what you need get from the pool.
	==Example==		==Example==
	This example will return a player by ID and output his name in the console.		This example will return a player by ID and output his name in the console.

YnnhoJ at 17:09, 28 May 2020

2020-05-28T17:09:56Z

← Older revision		Revision as of 17:09, 28 May 2020
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''ID:''' Element ID, what you need get from the pool.		*'''ID/Entity:''' Element, what you need get from the pool.
	==Example==		==Example==
	This example will return a player by ID and output his name in the console.		This example will return a player by ID and output his name in the console.

Rootcause at 11:16, 26 October 2018

2018-10-26T11:16:51Z

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

	==Syntax==		==Syntax==
	<~~syntaxhighlight lang="javascript"~~>		<pre>
	Entity pool.at(Number ID)		Entity pool.at(Number ID)
	</~~syntaxhighlight~~>		</pre>
	===Returns===		===Returns===
	An entity with the selected ID from a pool, or undefined if entity with this ID does not exists.		An entity with the selected ID from a pool, or undefined if entity with this ID does not exists.

Rootcause: Replaced HTML with template

2018-10-26T11:16:13Z

Replaced HTML with template

← Older revision		Revision as of 11:16, 26 October 2018
Line 12:		Line 12:
	==Example==		==Example==
	This example will return a player by ID and output his name in the console.		This example will return a player by ID and output his name in the console.
	~~<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="1"~~>
	let player = mp.players.at(1488);		let player = mp.players.at(1488);
	if (player) {		if (player) {
Line 21:		Line 20:
	console.log(`Player by id 1488 does not exists...`);		console.log(`Player by id 1488 does not exists...`);
	};		};
	</~~syntaxhighlight~~>		</pre>
	~~</div>~~		}}

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

Ragempdev at 20:47, 6 December 2017

2017-12-06T20:47:56Z

← Older revision		Revision as of 20:47, 6 December 2017
Line 6:		Line 6:
	</syntaxhighlight>		</syntaxhighlight>
	===Returns===		===Returns===
	An entity with the selected ID from a pool, or ~~false~~ if entity with this ID does not exists.		An entity with the selected ID from a pool, or undefined if entity with this ID does not exists.

	===Required Arguments===		===Required Arguments===

SaudBako: /* Fixed writing while keeping the same meaning */

2017-12-05T03:32:17Z

Fixed writing while keeping the same meaning

← Older revision		Revision as of 03:32, 5 December 2017
Line 6:		Line 6:
	</syntaxhighlight>		</syntaxhighlight>
	===Returns===		===Returns===
	~~Return a~~ entity with selected ID, from a pool~~. Or~~ false, if entity with this ID not exists.		An entity with the selected ID from a pool, or false if entity with this ID does not exists.

	===Required Arguments===		===Required Arguments===
	*'''ID:''' Element ID, what you need get from the pool.		*'''ID:''' Element ID, what you need get from the pool.