Peds::new - Revision history

Brzys at 12:12, 14 November 2021

2021-11-14T12:12:14Z

← Older revision		Revision as of 12:12, 14 November 2021
Line 1:		Line 1:
			{{Note\|Updated docs on creating peds: [[Ped::Ped]].}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, dimension);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, dimension);</syntaxhighlight>

Micaww at 07:07, 10 November 2019

2019-11-10T07:07:19Z

← Older revision		Revision as of 07:07, 10 November 2019
Line 18:		Line 18:
	);		);
	</syntaxhighlight>		</syntaxhighlight>
	~~== ==~~

	==Legacy Syntax Variation==		==Legacy Syntax Variation==

Micaww at 07:06, 10 November 2019

2019-11-10T07:06:36Z

← Older revision		Revision as of 07:06, 10 November 2019
Line 7:		Line 7:
	*'''dimension:''' int		*'''dimension:''' int
	===Return value===		===Return value===
	*'''Ped ~~handle or~~ object'''		*'''Ped object'''

	~~This function relies on the 'entityStreamIn' event to handle the Ped's streamInEvent. If you do not have this event in your script, you can find it below.~~

	==Example==		==Example==
	~~{{ClientSide}}~~
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	let ~~Ped~~ = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, mp.players.local.dimension);		let ped = mp.peds.new(
			mp.game.joaat('MP_F_Freemode_01'),
			new mp.Vector3(100.0, -100.0, 25.0),
			270.0,
			mp.players.local.dimension
			);
	</syntaxhighlight>		</syntaxhighlight>
	== ==		== ==
Line 20:		Line 22:
	==Legacy Syntax Variation==		==Legacy Syntax Variation==

	If you ~~would like~~ to ~~use~~ the ~~legacy syntax for mp.peds.new()~~, ~~refer~~ to the ~~following function~~:		The previous syntax for this function allowed you to specify a "streamedIn" callback. This has been removed in favor of the [[EntityStreamIn]] event, but you can add this polyfill to your client script to enable the previous syntax:
	~~{{ClientSide}}~~
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	mp.peds.newLegacy = (hash, position, heading, streamIn, dimension) =>		mp.peds.newLegacy = (hash, position, heading, streamIn, dimension) => {
	{
	let ped = mp.peds.new(hash, position, heading, dimension);		let ped = mp.peds.new(hash, position, heading, dimension);
	ped.streamInHandler = streamIn;		ped.streamInHandler = streamIn;
	return ped;		return ped;
	};		};
	~~</syntaxhighlight>~~

	~~For the above function to work, you must add the following 'entityStreamIn' event to your script:~~		mp.events.add("entityStreamIn", entity => {
	~~{{ClientSide}}~~		if (entity.streamInHandler) {
	~~<syntaxhighlight lang="javascript">~~
	mp.events.add("entityStreamIn", (entity) =>
	{
	if(entity.streamInHandler)
	{
	entity.streamInHandler(entity);		entity.streamInHandler(entity);
	}		}
Line 44:		Line 39:

	===Example===		===Example===
	~~{{ClientSide}}~~
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	let ~~Ped~~ = mp.peds.newLegacy(mp.game.joaat(~~model~~), ~~location~~, 0, ~~(streamPed)~~ => {		let ped = mp.peds.newLegacy(mp.game.joaat('mp_m_freemode_01'), new mp.Vector3(1000, 100, 10), 0, ped => {
	// ~~Ped Streamed~~		// Called when the ped is streamed in
	~~streamPed~~.setAlpha(255);		ped.setAlpha(255);
	~~streamPed~~.freezePosition(false);		ped.freezePosition(false);
	~~streamPed~~.setInvincible(false);		ped.setInvincible(false);
	~~streamPed~~.setProofs(false, false, false, false, false, false, false, false);		ped.setProofs(false, false, false, false, false, false, false, false);
	}, 0);		}, 0);
	</syntaxhighlight>		</syntaxhighlight>

MCtheBoss: Updated the page to represent the change in syntax, as well as provide the function for legacy syntax support.

2019-05-30T07:41:56Z

Updated the page to represent the change in syntax, as well as provide the function for legacy syntax support.

← Older revision		Revision as of 07:41, 30 May 2019
Line 1:		Line 1:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading~~, streamInEventHandler~~, dimension);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, dimension);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''modelHash:''' Model hash		*'''modelHash:''' Model hash
	*'''position:''' Vector3 position		*'''position:''' Vector3 position
	*'''heading:''' float		*'''heading:''' float
	*'''streamInEventHandler:''' function (called when the ped is streamed)
	*'''dimension:''' int		*'''dimension:''' int
	===Return value===		===Return value===
	*'''Ped handle or object'''		*'''Ped handle or object'''

			This function relies on the 'entityStreamIn' event to handle the Ped's streamInEvent. If you do not have this event in your script, you can find it below.

	==Example==		==Example==
	{{ClientSide}}		{{ClientSide}}
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, (~~streamPed~~) => {		let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, mp.players.local.dimension);
	~~// Ped Streamed~~		</syntaxhighlight>
	~~streamPed~~.~~setAlpha(0)~~;		== ==
	}~~, player.dimension)~~;
			==Legacy Syntax Variation==

			If you would like to use the legacy syntax for mp.peds.new(), refer to the following function:
			{{ClientSide}}
			<syntaxhighlight lang="javascript">
			mp.peds.newLegacy = (hash, position, heading, streamIn, dimension) =>
			{
			let ped = mp.peds.new(hash, position, heading, dimension);
			ped.streamInHandler = streamIn;
			return ped;
			};
	</syntaxhighlight>		</syntaxhighlight>

			For the above function to work, you must add the following 'entityStreamIn' event to your script:
			{{ClientSide}}
			<syntaxhighlight lang="javascript">
			mp.events.add("entityStreamIn", (entity) =>
			{
			if(entity.streamInHandler)
			{
			entity.streamInHandler(entity);
			}
			});
			</syntaxhighlight>

			===Example===
			{{ClientSide}}
			<syntaxhighlight lang="javascript">
			let Ped = mp.peds.newLegacy(mp.game.joaat(model), location, 0, (streamPed) => {
			// Ped Streamed
			streamPed.setAlpha(255);
			streamPed.freezePosition(false);
			streamPed.setInvincible(false);
			streamPed.setProofs(false, false, false, false, false, false, false, false);
			}, 0);
			</syntaxhighlight>


	==See also==		==See also==
	{{Ped_functions_c}}		{{Ped_functions_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]

Mcfloy at 12:01, 20 January 2018

2018-01-20T12:01:50Z

← Older revision		Revision as of 12:01, 20 January 2018
Line 11:		Line 11:

	==Example==		==Example==
	~~<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">~~		{{ClientSide}}
	~~<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>~~
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, (streamPed) => {		let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, (streamPed) => {
Line 19:		Line 18:
	}, player.dimension);		}, player.dimension);
	</syntaxhighlight>		</syntaxhighlight>
	~~</div>~~

	==See also==		==See also==
	{{~~Ped_s_function_c~~}}		{{Ped_functions_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]

Kubas at 00:16, 16 January 2018

2018-01-16T00:16:22Z

← Older revision		Revision as of 00:16, 16 January 2018
Line 1:		Line 1:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, streamInEventHandler, dimension);;</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, streamInEventHandler, dimension);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''modelHash:''' Model hash		*'''modelHash:''' Model hash

Kpect 94: /* Syntax */

2018-01-13T22:24:19Z

Syntax

← Older revision		Revision as of 22:24, 13 January 2018
Line 1:		Line 1:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.peds.new(~~modelHash~~, position, ~~rotation[~~, ~~onStream~~, dimension]);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.peds.new(model, position, heading, streamInEventHandler, dimension);;</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''modelHash:''' Model hash		*'''modelHash:''' Model hash
	*'''position:''' Vector3 position		*'''position:''' Vector3 position
	*'''~~rotation~~:''' float		*'''heading:''' float
	*'''~~onStream~~:''' function (called when the ped is streamed)		*'''streamInEventHandler:''' function (called when the ped is streamed)
	*'''dimension:''' int		*'''dimension:''' int
	===Return value===		===Return value===
	*'''Ped handle or object'''		*'''Ped handle or object'''

	==Example==		==Example==
	<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">		<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">

StreetGT: /* Example */

2017-09-20T09:05:01Z

Example

← Older revision		Revision as of 09:05, 20 September 2017
Line 13:		Line 13:
	<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, (streamPed) => {		let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, (streamPed) => {
	// Ped Streamed		// Ped Streamed
	streamPed.setAlpha(0);		streamPed.setAlpha(0);
	}, player.dimension);		}, player.dimension);
	</syntaxhighlight>		</syntaxhighlight>
	</div>		</div>

	==See also==		==See also==
	{{Ped_s_function_c}}		{{Ped_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]

Rt-2: modelHash param

2017-09-20T03:35:20Z

modelHash param

← Older revision		Revision as of 03:35, 20 September 2017
Line 2:		Line 2:
	<syntaxhighlight lang="javascript">mp.peds.new(modelHash, position, rotation[, onStream, dimension]);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.peds.new(modelHash, position, rotation[, onStream, dimension]);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''modelHash:''' Model hash ~~or name~~		*'''modelHash:''' Model hash
	*'''position:''' Vector3 position		*'''position:''' Vector3 position
	*'''rotation:''' float		*'''rotation:''' float

Rt-2: Added the 'client-side' header to the example

2017-09-18T19:58:21Z

Added the 'client-side' header to the example

← Older revision		Revision as of 19:58, 18 September 2017
Line 10:		Line 10:
	*'''Ped handle or object'''		*'''Ped handle or object'''
	==Example==		==Example==
			<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
			<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, (streamPed) => {		let Ped = mp.peds.new(mp.game.joaat('MP_F_Freemode_01'), new mp.Vector3( 100.0, -100.0, 25.0), 270.0, (streamPed) => {
Line 16:		Line 18:
	}, player.dimension);		}, player.dimension);
	</syntaxhighlight>		</syntaxhighlight>
			</div>
	==See also==		==See also==
	{{Ped_s_function_c}}		{{Ped_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]