TeleportPlayer - Revision history

QCherry: Document Lua APIs available or improved from G1R:MP 0.1.2

2026-09-03T18:40:41Z

Document Lua APIs available or improved from G1R:MP 0.1.2

← Older revision		Revision as of 18:40, 3 September 2026
Line 1:		Line 1:
	~~<!-- This page is generated automatically from the function definition: teleportPlayer. -->~~
	= teleportPlayer =		= teleportPlayer =
			<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
			<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">IMPROVED FROM UPDATE 0.1.2</div>
			<div style="color:#111111; margin-top:0.25rem;">This function is available in earlier releases and has corrected or expanded behavior in G1R:MP 0.1.2 and later. The contract below describes the updated behavior.</div>
			</div>

	Teleports a connected player to an authoritative world position.		Teleports a connected player to an authoritative world position.

Line 24:		Line 28:

	== Returns ==		== Returns ==
	Returns <code>true</code> when the teleport is accepted ~~and queued~~; otherwise returns <code>false</code>.		Returns <code>true</code> when the teleport is accepted into the player's position-control queue; otherwise returns <code>false</code>.

	== Examples ==		== Examples ==
Line 34:		Line 38:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* This is the explicit teleport alias of <code>setPlayerPosition</code> and emits <code>onPlayerTeleport</code>.		* This is the explicit teleport alias of <code>setPlayerPosition</code>. Calls made before the first valid movement snapshot, including from <code>onPlayerJoin</code>, remain queued until the native pawn is ready.
			* The server commits the transform and emits <code>onPlayerTeleport</code> only after the native client acknowledges that it applied the queued command.
	* Coordinates use metres and yaw uses degrees.		* Coordinates use metres and yaw uses degrees.

QCherry: Complete Lua function catalog

2026-08-15T09:55:53Z

Complete Lua function catalog

← Older revision		Revision as of 09:55, 15 August 2026
Line 37:		Line 37:
	* Coordinates use metres and yaw uses degrees.		* Coordinates use metres and yaw uses degrees.

			[[Category:Lua Functions]]
	[[Category:Server Functions]]		[[Category:Server Functions]]
	[[Category:Player Functions]]		[[Category:Player Functions]]
	[[Category:Spatial Functions]]		[[Category:Spatial Functions]]

QCherry: Automatyczna aktualizacja dokumentacji funkcji

2026-08-05T20:14:10Z

Automatyczna aktualizacja dokumentacji funkcji

New page

= teleportPlayer =
Teleports a connected player to an authoritative world position.

== Syntax ==
<syntaxhighlight lang="lua">
bool teleportPlayer(int playerId, number x, number y, number z [, number yaw = 0])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>x</code> || <code>number</code> || yes || World X coordinate in metres.
|-
| <code>y</code> || <code>number</code> || yes || World Y coordinate in metres.
|-
| <code>z</code> || <code>number</code> || yes || World Z coordinate in metres.
|-
| <code>yaw</code> || <code>number</code> || no || Optional actor yaw in degrees; defaults to 0.
|}

== Returns ==
Returns <code>true</code> when the teleport is accepted and queued; otherwise returns <code>false</code>.

== Examples ==
Teleport a player to an RP spawn point:
<syntaxhighlight lang="lua" line>
teleportPlayer(playerId, 125.5, -48.0, 3.25, 180)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* This is the explicit teleport alias of <code>setPlayerPosition</code> and emits <code>onPlayerTeleport</code>.
* Coordinates use metres and yaw uses degrees.

[[Category:Server Functions]]
[[Category:Player Functions]]
[[Category:Spatial Functions]]