SpawnTestItem - Revision history

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

2026-09-03T18:40:34Z

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

	Spawns the catalog-backed synchronized test apple near a player.		Spawns the catalog-backed synchronized test apple near a player.

	== Syntax ==		== Syntax ==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool spawnTestItem(int playerId [, number heightOffset ~~= 0~~])		bool spawnTestItem(int playerId [, number heightOffset])
	</syntaxhighlight>		</syntaxhighlight>

Line 14:		Line 18:
	\| <code>playerId</code> \|\| <code>int</code> \|\| yes \|\| The connected player identifier.		\| <code>playerId</code> \|\| <code>int</code> \|\| yes \|\| The connected player identifier.
	\|-		\|-
	\| <code>heightOffset</code> \|\| <code>number</code> \|\| no \|\| Optional vertical offset in metres~~, clamped~~ to the ~~validated test range~~.		\| <code>heightOffset</code> \|\| <code>number</code> \|\| no \|\| Optional finite vertical offset in metres from -100 through 100. Values outside this range are rejected. Omit it to request ground snapping; an explicit 0 keeps the player's snapshot height without ground snapping.
	\|}		\|}

	== Returns ==		== Returns ==
	Returns <code>true</code> ~~when~~ the ~~authoritative spawn request is accepted~~; otherwise returns <code>false</code>.		Returns <code>true</code> after the server accepts and creates the test item; otherwise returns <code>false</code>.

	== Examples ==		== Examples ==
	Spawn ~~a pickup at~~ the invoking player~~'s feet~~:		Spawn the fixed test apple near the invoking player and snap it to the ground:
	<syntaxhighlight lang="lua" line>		<syntaxhighlight lang="lua" line>
	addCommandHandler("~~spawnitem~~", function(playerId)		addCommandHandler("spawntestitem", function(playerId)
	if not spawnTestItem(playerId) then		if not spawnTestItem(playerId) then
	outputChatBox("The item could not be spawned.", playerId)		outputChatBox("The item could not be spawned.", playerId)
Line 32:		Line 36:
	== Notes ==		== Notes ==
	* Available only in server-side resource scripts.		* Available only in server-side resource scripts.
			* Each accepted call spawns exactly one apple 0.7 metres in front of the player's latest replicated position and facing direction.
	* The server owns the item identity, revision, visibility, pickup validation, inventory award, and late-join state.		* The server owns the item identity, revision, visibility, pickup validation, inventory award, and late-join state.
	* This ~~function~~ deliberately spawns only the validated ~~test~~ apple. ~~It is not a generic arbitrary asset loader~~.		* This compatibility and test helper deliberately spawns only the validated apple. Use <code>spawnItem</code> when selecting an allowlisted item key.

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

QCherry: Complete Lua function catalog

2026-08-15T09:55:49Z

Complete Lua function catalog

← Older revision		Revision as of 09:55, 15 August 2026
Line 35:		Line 35:
	* This function deliberately spawns only the validated test apple. It is not a generic arbitrary asset loader.		* This function deliberately spawns only the validated test apple. It is not a generic arbitrary asset loader.

			[[Category:Lua Functions]]
	[[Category:Server Functions]]		[[Category:Server Functions]]
	[[Category:World Functions]]		[[Category:World Functions]]
	[[Category:Inventory Functions]]		[[Category:Inventory Functions]]

QCherry: Document server-owned monsters and interactions

2026-08-14T04:26:15Z

Document server-owned monsters and interactions

New page

= spawnTestItem =
Spawns the catalog-backed synchronized test apple near a player.

== Syntax ==
<syntaxhighlight lang="lua">
bool spawnTestItem(int playerId [, number heightOffset = 0])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>heightOffset</code> || <code>number</code> || no || Optional vertical offset in metres, clamped to the validated test range.
|}

== Returns ==
Returns <code>true</code> when the authoritative spawn request is accepted; otherwise returns <code>false</code>.

== Examples ==
Spawn a pickup at the invoking player's feet:
<syntaxhighlight lang="lua" line>
addCommandHandler("spawnitem", function(playerId)
if not spawnTestItem(playerId) then
outputChatBox("The item could not be spawned.", playerId)
end
end)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The server owns the item identity, revision, visibility, pickup validation, inventory award, and late-join state.
* This function deliberately spawns only the validated test apple. It is not a generic arbitrary asset loader.

[[Category:Server Functions]]
[[Category:World Functions]]
[[Category:Inventory Functions]]