SetPlayerPosition - Revision history

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

2026-09-03T18:40:38Z

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: setPlayerPosition. -->~~
	= setPlayerPosition =		= setPlayerPosition =
			<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>

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

Line 24:		Line 28:

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

	== Examples ==		== Examples ==
Line 38:		Line 42:
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
	* Coordinates use metres. The server converts them to Unreal units before sending the reliable control event.		* Coordinates use metres. The server converts them to Unreal units before sending the reliable control event.
	* The player ~~must already have supplied at least one~~ valid movement snapshot.		* The function may be called from <code>onPlayerJoin</code>. Before the player's first valid movement snapshot, the accepted request remains queued and is dispatched as soon as that snapshot proves the native pawn is ready.
	* ~~This function~~ emits <code>onPlayerTeleport</code> ~~when accepted~~.		* Position commands run one at a time. The server commits the transform and emits <code>onPlayerTeleport</code> only after a validated native ACK confirms that the exact command was applied.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]

QCherry: Complete Lua function catalog

2026-08-15T09:55:30Z

Complete Lua function catalog

← Older revision		Revision as of 09:55, 15 August 2026
Line 41:		Line 41:
	* This function emits <code>onPlayerTeleport</code> when accepted.		* This function emits <code>onPlayerTeleport</code> when accepted.

			[[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:02Z

Automatyczna aktualizacja dokumentacji funkcji

New page

= setPlayerPosition =
Moves a connected player to an authoritative world position.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerPosition(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 authoritative move is accepted and queued for the client; otherwise returns <code>false</code>.

== Examples ==
Move a player two metres along the X axis:
<syntaxhighlight lang="lua" line>
local position = getPlayerPosition(playerId)
if position then
setPlayerPosition(playerId, position.x + 2, position.y, position.z)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Coordinates use metres. The server converts them to Unreal units before sending the reliable control event.
* The player must already have supplied at least one valid movement snapshot.
* This function emits <code>onPlayerTeleport</code> when accepted.

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