Create3DText - Revision history

QCherry: Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

2026-09-12T11:51:44Z

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 1:		Line 1:
	~~<!-- This page is generated automatically from the function definition: create3DText. -->~~
	= create3DText =		= create3DText =
	Creates a server-authoritative world-space text label and replicates it to connected players.		Creates a server-authoritative world-space text label and replicates it to connected players.
Line 48:		Line 47:
	* The server replicates creation and updates reliably, including the current state for late-joining players.		* The server replicates creation and updates reliably, including the current state for late-joining players.
	* The creating resource owns the label. Other resources cannot change or destroy it, and it is removed automatically when its owner stops.		* The creating resource owns the label. Other resources cannot change or destroy it, and it is removed automatically when its owner stops.
	* A resource may own up to ~~256~~ labels, with a server-wide maximum of ~~2048~~ labels.		* A resource may own up to 1024 labels, with a server-wide maximum of 8192 labels.
	* Store the returned identifier as a string. Do not convert it to a Lua number.		* Store the returned identifier as a string. Do not convert it to a Lua number.
			* Expanded limits apply from update 0.1.3 BUILD81. See [[Scripting limits]]; earlier 0.1.3 binaries retain their old limits.

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

QCherry: Complete Lua function catalog

2026-08-15T09:52:14Z

Complete Lua function catalog

← Older revision		Revision as of 09:52, 15 August 2026
Line 51:		Line 51:
	* Store the returned identifier as a string. Do not convert it to a Lua number.		* Store the returned identifier as a string. Do not convert it to a Lua number.

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

QCherry: Synchronize Lua API documentation

2026-08-13T20:32:30Z

Synchronize Lua API documentation

New page

= create3DText =
Creates a server-authoritative world-space text label and replicates it to connected players.

== Syntax ==
<syntaxhighlight lang="lua">
string|false create3DText(string text, number x, number y, number z [, table options])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>text</code> || <code>string</code> || yes || Valid UTF-8 text containing 1-128 characters and at most 256 bytes.
|-
| <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>options</code> || <code>table</code> || no || Optional fields: drawDistance (1-1000 metres), scale (0.25-5.0), and integer r, g, b, a color channels (0-255).
|}

== Returns ==
Returns an opaque text identifier string on success, or <code>false</code> when validation or capacity limits reject the request.

== Examples ==
Create a gold world label above an RP meeting point:
<syntaxhighlight lang="lua" line>
local meetingLabel = create3DText(
"Old Camp meeting point",
125.0, -48.5, 3.2,
{
drawDistance = 40.0,
scale = 0.85,
r = 225, g = 185, b = 91, a = 255
}
)

if not meetingLabel then
outputDebugString("Could not create the meeting label", 1)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The server replicates creation and updates reliably, including the current state for late-joining players.
* The creating resource owns the label. Other resources cannot change or destroy it, and it is removed automatically when its owner stops.
* A resource may own up to 256 labels, with a server-wide maximum of 2048 labels.
* Store the returned identifier as a string. Do not convert it to a Lua number.

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