Wiki G1R-MP G1 Remake Multiplayer - Recent changes [en]

Main Page

QCherry — Sun, 13 Sep 2026 00:41:11 GMT

Place the main wiki heading above release announcements

@@ Line 1: / Line 1: @@
 __NOTOC__
 <div style="border:1px solid #b28a3d; border-left:4px solid #b28a3d; background:#faf9f5; padding:0.9rem 1rem; margin:0 0 1.2rem;">
@@ Line 8: / Line 15: @@
 <div style="color:#111; font-size:1.05rem; font-weight:bold;">CHAPTER SCREENS — AVAILABLE FROM UPDATE 0.1.3</div>
 <div style="color:#111; margin-top:0.35rem; line-height:1.55;">'''2 new server-side functions''': [[showChapterScreen|ShowChapterScreen]] and [[hideChapterScreen|HideChapterScreen]] (also available with lower-camel aliases). Show custom chapter-style title cards without advancing the story. See [[Chapter screens]] for examples, validation, resource ownership and <code>/chaptertest</code>.</div>
 </div>

Hosting a G1R:MP dedicated server

QCherry — Sun, 13 Sep 2026 00:29:46 GMT

Update hosting compatibility to 0.1.3 / Protocol 35

← Older revision		Revision as of 00:29, 13 September 2026
Line 8:		Line 8:
	</div>		</div>

	This requirement also applies when the dedicated server, launcher, and game are running on the same computer. Protocol ~~26 uses~~ the official G1R:MP service for server discovery and connection authorization, including direct-connect attempts. Private-only server addresses are not accepted for public registration.		This requirement also applies when the dedicated server, launcher, and game are running on the same computer. The current 0.1.3 release uses Protocol 35 and the official G1R:MP service for server discovery and connection authorization, including direct-connect attempts. Private-only server addresses are not accepted for public registration. Update both the client and server; see [[Update 0.1.3]].

	The official service does not relay gameplay. After authorization, gameplay, voice, and resource traffic connects directly to the public endpoint advertised by the dedicated server. This architecture requires that endpoint to be reachable from the Internet.		The official service does not relay gameplay. After authorization, gameplay, voice, and resource traffic connects directly to the public endpoint advertised by the dedicated server. This architecture requires that endpoint to be reachable from the Internet.

Main Page

QCherry — Sun, 13 Sep 2026 00:29:43 GMT

Announce official 0.1.3 / BUILD106 / Protocol 35

← Older revision		Revision as of 00:29, 13 September 2026
Line 1:		Line 1:
	__NOTOC__		__NOTOC__

			<div style="border:1px solid #b28a3d; border-left:4px solid #b28a3d; background:#faf9f5; padding:0.9rem 1rem; margin:0 0 1.2rem;">
			'''G1R:MP 0.1.3 — official release, BUILD106 / Protocol 35.''' Windows client and Windows/Linux dedicated server downloads are available on the [https://g1r-mp.com/download/ Download page]. Update both the client and server. See [[Update 0.1.3]] for scripting additions and migration notes.
			</div>

	<div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;">		<div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;">

Update 0.1.3

QCherry — Sun, 13 Sep 2026 00:29:40 GMT

Publish official 0.1.3 release and migration guide

New page

{{DISPLAYTITLE:G1R:MP Update 0.1.3}}
__NOTOC__

= Update 0.1.3 =

'''Official release: 0.1.3, BUILD106, Protocol 35.''' Download the Windows x64 client and matching Windows x64 or Linux x86_64 dedicated server from the [https://g1r-mp.com/download/ official Download page]. The Windows launcher uses the existing automatic update channel.

== Update both sides ==

Protocol 35 requires a matching client and dedicated server. Back up your server configuration, resources and database before upgrading. Stop the dedicated server before replacing its binaries; preserve your own gamemode and configuration rather than overwriting them with examples. The supplied Gothic RP database password is <code>CHANGE_ME</code> and must be configured locally.

The public version is <code>0.1.3</code>. Windows Explorer shows the client file version <code>0.1.3.106</code>; the final number is the launcher build, not a separate Lua API version. See [[Hosting a G1R:MP dedicated server]] for network and port requirements.

== Scripting available from 0.1.3 ==

* '''Scripted camera:''' 15 functions and two client events. Set position, rotation, look-at and FOV; animate transitions, paths and orbits; reset to normal gameplay. See [[Scripted camera]].
* '''Player appearance:''' seven functions for skin color and tattoos, with improved compatibility for the existing identity API. See [[Player customization]] and [[Player tattoo catalog]].
* '''Observer-specific nameplates:''' 12 server functions for per-observer labels, visibility and ID policy. Gamemodes can persist their own directional acquaintance records in a database. See [[Observer nameplates]].
* '''Custom chapter title cards:''' [[showChapterScreen|ShowChapterScreen]] and [[hideChapterScreen|HideChapterScreen]] display presentation-only cards without advancing the story. See [[Chapter screens]].
* '''Expanded scripting budgets:''' see [[Scripting limits]] for the current client/server limits, including timers and resource budgets.

Function pages specify the execution side, accepted arguments, return values and asynchronous acknowledgement rules. Version annotations refer to API availability; they do not make server-only functions callable from client resources.

== Examples and test commands ==

The included Gothic RP resources provide <code>/cameratest</code>, <code>/looktest</code>, <code>/nametest</code> and <code>/chaptertest</code>. Use the linked guides for syntax and prerequisites. Keep administrative test commands restricted to trusted users on public servers. Existing gamemodes are not replaced automatically by the client updater.

== Reference ==

The API reference contains '''312 function pages and 94 event pages'''. Start with [[Main Page]], [[Lua API catalogs]] and [[Lua events]].

[[Category:Lua API]]

Main Page

QCherry — Sat, 12 Sep 2026 18:33:06 GMT

Document ShowChapterScreen/HideChapterScreen available from update 0.1.3

← Older revision		Revision as of 18:33, 12 September 2026
Line 1:		Line 1:
	__NOTOC__		__NOTOC__

			<div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;">
			<div style="color:#111; font-size:1.05rem; font-weight:bold;">CHAPTER SCREENS — AVAILABLE FROM UPDATE 0.1.3</div>
			<div style="color:#111; margin-top:0.35rem; line-height:1.55;">'''2 new server-side functions''': [[showChapterScreen\|ShowChapterScreen]] and [[hideChapterScreen\|HideChapterScreen]] (also available with lower-camel aliases). Show custom chapter-style title cards without advancing the story. See [[Chapter screens]] for examples, validation, resource ownership and <code>/chaptertest</code>.</div>
			</div>

	<div style="background:#111611; color:#eee7d5; border:1px solid #8f7338; border-top:4px solid #c6a251; padding:1.6rem 1.8rem; margin-bottom:1.25rem;">		<div style="background:#111611; color:#eee7d5; border:1px solid #8f7338; border-top:4px solid #c6a251; padding:1.6rem 1.8rem; margin-bottom:1.25rem;">
Line 57:		Line 62:
	<li>[[Client audio\|Client audio and synchronized 3D playback]]</li>		<li>[[Client audio\|Client audio and synchronized 3D playback]]</li>
	<li>[[Scripted camera\|Scripted camera and moving login backgrounds (0.1.3)]]</li>		<li>[[Scripted camera\|Scripted camera and moving login backgrounds (0.1.3)]]</li>
			<li>[[Chapter screens\|Custom chapter title cards (0.1.3)]]</li>
	<li>[[Observer nameplates\|Observer-specific labels and acquaintance presentation (0.1.3)]]</li>		<li>[[Observer nameplates\|Observer-specific labels and acquaintance presentation (0.1.3)]]</li>
	<li>[[:Category:Resource Functions\|Resource lifecycle functions]]</li>		<li>[[:Category:Resource Functions\|Resource lifecycle functions]]</li>
Line 142:		Line 148:
	<div style="flex:1 1 22rem; border-top:3px solid #6f8461; background:#f5f2e9; padding:1rem 1.15rem;">		<div style="flex:1 1 22rem; border-top:3px solid #6f8461; background:#f5f2e9; padding:1rem 1.15rem;">
	<div style="font-size:1.2rem; font-weight:bold; margin-bottom:0.4rem;">Documentation status</div>		<div style="font-size:1.2rem; font-weight:bold; margin-bottom:0.4rem;">Documentation status</div>
	<div style="line-height:1.6;">The reference contains '''~~310~~ Lua functions''' and '''94 events''', including '''12 observer/nameplate-ID functions, 7 skin-color/tattoo functions, 15 camera functions and 2 camera events available from update 0.1.3'''. Version notices distinguish newly available APIs from improved contracts in earlier APIs. See [[Observer nameplates]] for directional labels, [[Player customization]] for identity, color and tattoos, [[Lua API catalogs]] for validated gameplay keys, and [[Scripted camera]] for camera state and lifecycle rules. APIs marked [[:Category:Experimental Lua API\|experimental]] may still change while the multiplayer runtime is under active development.</div>		<div style="line-height:1.6;">The reference contains '''312 Lua functions''' and '''94 events''', including '''2 chapter-screen functions, 12 observer/nameplate-ID functions, 7 skin-color/tattoo functions, 15 camera functions and 2 camera events available from update 0.1.3'''. Version notices distinguish newly available APIs from improved contracts in earlier APIs. See [[Chapter screens]] for custom title cards, [[Observer nameplates]] for directional labels, [[Player customization]] for identity, color and tattoos, [[Lua API catalogs]] for validated gameplay keys, and [[Scripted camera]] for camera state and lifecycle rules. APIs marked [[:Category:Experimental Lua API\|experimental]] may still change while the multiplayer runtime is under active development.</div>
	</div>		</div>
	</div>		</div>

	[[Category:Lua API]]		[[Category:Lua API]]

Chapter screens

QCherry — Sat, 12 Sep 2026 18:33:05 GMT

Document ShowChapterScreen/HideChapterScreen available from update 0.1.3

New page

= Chapter screens =

'''AVAILABLE FROM UPDATE 0.1.3''' — introduced in BUILD85. Use a server and client that both include chapter-screen support. An older protocol-34 client is not sufficient merely because it can connect.

[[showChapterScreen|ShowChapterScreen]] displays a custom, passive chapter-style title card to one player. [[hideChapterScreen|HideChapterScreen]] requests early removal. The lower-camel aliases <code>showChapterScreen</code> and <code>hideChapterScreen</code> behave identically.

This is a presentation API, '''not a story/chapter progression API'''. It does not change quests, saves or the current chapter, and does not start chapter music or a native cutscene. It uses the game's chapter-style widget with fixed background artwork and no image/audio options. It does not request input focus.

== Server-side example ==
Call after the player's character is available, for example from an authenticated server command:

<syntaxhighlight lang="lua" line>
local accepted = ShowChapterScreen(playerId, "CHAPTER I", "Welcome to the Colony", 6000)
-- accepted means the server accepted delivery, not a client render acknowledgement.

-- When the same resource needs to remove its card early:
-- HideChapterScreen(playerId)
</syntaxhighlight>

An empty heading is valid. Omit the fourth argument for 6000 ms; do not pass <code>nil</code> explicitly. There are no new chapter-screen Lua events or client-side Lua bindings.

== Validation and limits ==
{| class="wikitable"
! Field !! Accepted value
|-
| playerId || Connected player ID, finite integer 1–4294967295.
|-
| heading || UTF-8 string, 0–256 bytes.
|-
| title || UTF-8 string, 1–512 bytes.
|-
| durationMs || Finite integer 1000–30000 ms; default 6000 ms.
|-
| Presentation || One custom card per player. A later show replaces the previous card; no display backlog.
|-
| Resource ownership || Up to 8192 distinct tracked player IDs per server resource. Explicit hide/resource cleanup releases tracking; automatic visual expiry is not a Lua acknowledgement.
|-
| Native pending commands || Bounded queue of 32; excess pending commands can be discarded. At most three widget-creation attempts, 500 ms apart.
|}

Limits on strings count '''UTF-8 bytes''', not characters. Invalid UTF-8, NUL, control characters and line breaks (including Unicode line/paragraph separators) are rejected. Text is literal: <code><b>Title</b></code> is not markup. Show accepts exactly three or four arguments; hide accepts exactly one.

== Ownership and lifetime ==
* The latest show becomes the current resource-owned card, including when another resource previously displayed one.
* An old resource's hide/cleanup cannot remove another resource's replacement card. A successful server-side hide is not proof that a visible card was removed.
* Cards expire automatically. Duration starts when the native client processes the show and includes the fades, not server/network delay.
* Disconnect, resource cleanup and player-pawn replacement clear the corresponding presentation. This API is not a pre-spawn loading-screen facility.
* This API is separate from multiplayer suppression of native story triggers. It does '''not''' provide a general switch for disabling story regions, ladder events, conversations or cinematics.

== Bundled GothicRP test ==
The test requires an authenticated player and affects only the caller:

* <code>/chaptertest</code> — default six-second card.
* <code>/chaptertest show My custom title</code> — custom title.
* <code>/chaptertest unicode</code> — Unicode text.
* <code>/chaptertest literal</code> — verifies literal text instead of markup.
* <code>/chaptertest replace</code> — replaces an older card immediately.
* <code>/chaptertest long My title</code> — 30-second card.
* <code>/chaptertest hide</code> — early hide from the same resource.

Check expiration, replacement, movement and native menus/GUI clicks. These are bundled test commands, not additional public Lua functions.

[[Category:Lua API]]
[[Category:Lua Examples]]

HideChapterScreen

QCherry — Sat, 12 Sep 2026 18:33:03 GMT

Document ShowChapterScreen/HideChapterScreen available from update 0.1.3

New page

= hideChapterScreen =
<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;">AVAILABLE FROM UPDATE 0.1.3</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

Request early removal of the calling resource's custom chapter title card for one player. See [[showChapterScreen]] and [[Chapter screens]].

== Syntax ==
<syntaxhighlight lang="lua">
bool HideChapterScreen(int playerId)
bool hideChapterScreen(int playerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|}

== Returns ==
Returns <code>true</code> when an owned hide request is accepted for delivery. Returns <code>false</code> for invalid arguments, a disconnected player, no tracked chapter ownership for this resource/player, or a rejected runtime action. This is not a client-render acknowledgement.

== Examples ==
Hide a title card previously requested by this same resource:
<syntaxhighlight lang="lua" line>
HideChapterScreen(playerId)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Available from update 0.1.3 (introduced in BUILD85), with matching client support.
* Both spellings in Syntax are aliases. Exactly one argument is accepted.
* Only the current owner can remove the displayed custom card. If another resource replaced it, an older resource's accepted hide is ignored by the client and does not hide the new card.
* The server ownership record is not a visibility query: automatic client expiry does not acknowledge an early hide to Lua. Do not use the return value to determine whether a card was visible.
* The custom card also expires automatically; resource cleanup, disconnect and player-pawn replacement clear the corresponding presentation. This function does not change the story or cancel arbitrary native cutscenes.

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

ShowChapterScreen

QCherry — Sat, 12 Sep 2026 18:33:02 GMT

Document ShowChapterScreen/HideChapterScreen available from update 0.1.3

New page

= showChapterScreen =
<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;">AVAILABLE FROM UPDATE 0.1.3</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

Show a custom chapter-style title card to one player. Presentation only: this does not advance the story, quests or the saved chapter. See [[Chapter screens]].

== Syntax ==
<syntaxhighlight lang="lua">
bool ShowChapterScreen(int playerId, string heading, string title [, int durationMs = 6000])
bool showChapterScreen(int playerId, string heading, string title [, int durationMs = 6000])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>heading</code> || <code>string</code> || yes || Top line: valid UTF-8, 0–256 bytes; an empty string is allowed.
|-
| <code>title</code> || <code>string</code> || yes || Main line: valid UTF-8, 1–512 bytes.
|-
| <code>durationMs</code> || <code>int</code> || no || Integer 1000–30000 milliseconds, default 6000. Omit this argument to use the default; explicit nil is invalid.
|}

== Returns ==
Returns <code>true</code> when the server accepts the request for delivery. This is not confirmation that the client rendered it. Returns <code>false</code> for invalid arguments, a disconnected player, an ownership-capacity limit or a rejected runtime action.

== Examples ==
Call from a server-side command or event after the player's character is available:
<syntaxhighlight lang="lua" line>
ShowChapterScreen(playerId, "CHAPTER I", "Welcome to the Colony", 6000)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Available from update 0.1.3 (introduced in BUILD85). Both server and client must support this API; matching protocol 34 alone is not sufficient for older clients.
* Both spellings in Syntax are aliases of the same function; they are not separate screens.
* Text is literal, not HTML/RML. Control characters, NUL and line breaks are rejected. UTF-8 limits are bytes, not visible characters.
* One custom chapter screen per player: a later show replaces the previous one, including a screen from another resource. No backlog is retained.
* The screen expires automatically. Duration starts when the native client processes the request and includes its fade-in/fade-out, not network delay.
* Use [[hideChapterScreen]] for an early hide. Hiding and resource cleanup cannot remove a screen currently owned by another resource.
* The server tracks at most 8192 distinct player IDs per resource for chapter ownership until explicit hide/resource cleanup; an already tracked ID can be reused.
* This passive native title card does not request input focus or start chapter gameplay, a cinematic or chapter music. Background artwork is fixed; this API exposes no image/audio parameters.
* Do not use as a pre-spawn loading screen. The native client has a bounded 32-command pending queue and at most three widget-creation attempts at 500 ms intervals.
* The bundled GothicRP test command is <code>/chaptertest</code>; see [[Chapter screens]] for variants.

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

AddEventHandler

QCherry — Sat, 12 Sep 2026 11:51:54 GMT

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: addEventHandler. -->~~
	= addEventHandler =		= addEventHandler =
	Attaches a Lua callback to a named event in the current resource.		Attaches a Lua callback to a named event in the current resource.
Line 36:		Line 35:
	== Notes ==		== Notes ==
	* Available in both client-side and server-side resource scripts.		* Available in both client-side and server-side resource scripts.
			* Expanded limits apply from update 0.1.3 BUILD81. Client limits: 8192 total handlers per resource and 512 handlers per event. The server has no matching fixed handler-count cap. See [[Scripting limits]]; earlier 0.1.3 binaries retain their old limits.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]
	[[Category:Shared Functions]]		[[Category:Shared Functions]]
	[[Category:Event Functions]]		[[Category:Event Functions]]

AddEvent

QCherry — Sat, 12 Sep 2026 11:51:52 GMT

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: addEvent. -->~~
	= addEvent =		= addEvent =
	Declares a custom event for the current resource.		Declares a custom event for the current resource.
Line 29:		Line 28:
	* Available in both client-side and server-side resource scripts.		* Available in both client-side and server-side resource scripts.
	* Only enable remote triggering for events whose arguments and permissions are validated by the receiver.		* Only enable remote triggering for events whose arguments and permissions are validated by the receiver.
			* Expanded limits apply from update 0.1.3 BUILD81. Client limit: 4096 declared remote event names per resource; the server has no matching fixed declaration-count cap. See [[Scripting limits]]; earlier 0.1.3 binaries retain their old limits.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]
	[[Category:Shared Functions]]		[[Category:Shared Functions]]
	[[Category:Event Functions]]		[[Category:Event Functions]]

SetTimer

QCherry — Sat, 12 Sep 2026 11:51:51 GMT

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: setTimer. -->~~
	= setTimer =		= setTimer =
	Schedules a Lua function to run after a delay, optionally more than once.		Schedules a Lua function to run after a delay, optionally more than once.
Line 34:		Line 33:
	== Notes ==		== Notes ==
	* Available in both client-side and server-side resource scripts.		* Available in both client-side and server-side resource scripts.
			* Expanded limits apply from update 0.1.3 BUILD81. Client limits: 8192 timers per resource, at most 256 selected callbacks per tick, oldest deadline first, and 32 callback arguments. The server has no corresponding fixed timer-count or callbacks-per-tick cap; memory and execution budgets still apply. See [[Scripting limits]]; earlier 0.1.3 binaries retain their old limits.

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

PlaySound3D

QCherry — Sat, 12 Sep 2026 11:51:50 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 54:		Line 54:
	* The native player transform is sampled for the listener only while at least one spatial sound exists; this path does not use Angelscript and does not install a ProcessEvent hook.		* The native player transform is sampled for the listener only while at least one spatial sound exists; this path does not use Angelscript and does not install a ProcessEvent hook.
	* The same declaration, path, integrity, codec, ownership, and active-sound limits as <code>playSound</code> apply.		* The same declaration, path, integrity, codec, ownership, and active-sound limits as <code>playSound</code> apply.
			* Expanded limits apply from update 0.1.3 BUILD81. Client limits: 128 owned sounds per resource and 512 globally. See [[Scripting limits]]; earlier 0.1.3 binaries retain their old limits.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]
	[[Category:Client Functions]]		[[Category:Client Functions]]
	[[Category:Audio Functions]]		[[Category:Audio Functions]]

PlaySound

QCherry — Sat, 12 Sep 2026 11:51:49 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 42:		Line 42:
	* Resource audio uses the normal Windows default playback endpoint. The communications-device selection is reserved for voice microphone capture and does not reroute 2D or 3D playback.		* Resource audio uses the normal Windows default playback endpoint. The communications-device selection is reserved for voice microphone capture and does not reroute 2D or 3D playback.
	* 2D playback preserves the source channel layout. When source and output sample rates differ, the runtime converts once with the bundled libsamplerate 0.2.2 sinc converter using <code>SRC_SINC_MEDIUM_QUALITY</code> and bypasses miniaudio's pitch-oriented linear converter.		* 2D playback preserves the source channel layout. When source and output sample rates differ, the runtime converts once with the bundled libsamplerate 0.2.2 sinc converter using <code>SRC_SINC_MEDIUM_QUALITY</code> and bypasses miniaudio's pitch-oriented linear converter.
	* Each resource may own at most 32 active sounds; the client runtime may own at most ~~128~~ in total.		* Each resource may own at most 128 active sounds; the client runtime may own at most 512 in total.
			* 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:Client Functions]]		[[Category:Client Functions]]
	[[Category:Audio Functions]]		[[Category:Audio Functions]]

BindKey

QCherry — Sat, 12 Sep 2026 11:51:47 GMT

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: bindKey. -->~~
	= bindKey =		= bindKey =
	Binds a keyboard or mouse key to a client-side Lua callback and consumes the corresponding game input while the binding is active.		Binds a keyboard or mouse key to a client-side Lua callback and consumes the corresponding game input while the binding is active.
Line 45:		Line 44:
	* A new binding does not begin while another RmlUi document owns text or pointer input. A key-up transition belonging to an active binding is still delivered so the UI can close safely.		* A new binding does not begin while another RmlUi document owns text or pointer input. A key-up transition belonging to an active binding is still delivered so the UI can close safely.
	* The client runtime polls keys only while the G1R window is focused. It does not install a global keyboard hook and does not use Unreal ProcessEvent.		* The client runtime polls keys only while the G1R window is focused. It does not install a global keyboard hook and does not use Unreal ProcessEvent.
	* Each resource may register at most ~~128~~ bindings.		* Each resource may register at most 1024 bindings.
			* 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:Client Functions]]		[[Category:Client Functions]]
	[[Category:Input Functions]]		[[Category:Input Functions]]

SetNpcRoute

QCherry — Sat, 12 Sep 2026 11:51:46 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 18:		Line 18:
	\| <code>npcId</code> \|\| <code>int</code> \|\| yes \|\| The server-assigned NPC identifier returned by <code>spawnNpc</code> or <code>getNpcs</code>.		\| <code>npcId</code> \|\| <code>int</code> \|\| yes \|\| The server-assigned NPC identifier returned by <code>spawnNpc</code> or <code>getNpcs</code>.
	\|-		\|-
	\| <code>points</code> \|\| <code>table</code> \|\| yes \|\| A one-based array of 1-~~256~~ points. Every point has x, y and z in metres and may have yaw in degrees and waitMs from 0 to 3600000.		\| <code>points</code> \|\| <code>table</code> \|\| yes \|\| A one-based array of 1-1024 points. Every point has x, y and z in metres and may have yaw in degrees and waitMs from 0 to 3600000.
	\|-		\|-
	\| <code>options</code> \|\| <code>table</code> \|\| no \|\| Optional <code>{ loop = bool, speed = number, obstacleBehavior = string }</code>; speed is 0.1-12 metres per second and defaults to 1. Available since update 0.1.2, <code>obstacleBehavior</code> accepts <code>"wait"</code> or <code>"avoid"</code>. When omitted, the NPC keeps its current mode; a newly spawned NPC starts in <code>"wait"</code> mode.		\| <code>options</code> \|\| <code>table</code> \|\| no \|\| Optional <code>{ loop = bool, speed = number, obstacleBehavior = string }</code>; speed is 0.1-12 metres per second and defaults to 1. Available since update 0.1.2, <code>obstacleBehavior</code> accepts <code>"wait"</code> or <code>"avoid"</code>. When omitted, the NPC keeps its current mode; a newly spawned NPC starts in <code>"wait"</code> mode.
Line 42:		Line 42:
	* The <code>obstacleBehavior</code> option is available since update 0.1.2. Its default <code>"wait"</code> mode stops the NPC until a blocking dynamic capsule clears. <code>"avoid"</code> attempts a safe detour and continues toward the waypoint, falling back to waiting when no valid detour exists.		* The <code>obstacleBehavior</code> option is available since update 0.1.2. Its default <code>"wait"</code> mode stops the NPC until a blocking dynamic capsule clears. <code>"avoid"</code> attempts a safe detour and continues toward the waypoint, falling back to waiting when no valid detour exists.
	* Route progress emits <code>onNpcRoutePoint</code> and non-looping completion emits <code>onNpcRouteComplete</code>.		* Route progress emits <code>onNpcRoutePoint</code> and non-looping completion emits <code>onNpcRouteComplete</code>.
			* 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]]

CreateAiNavigationBlocker

QCherry — Sat, 12 Sep 2026 11:51:45 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 37:		Line 37:
	* All coordinates and dimensions use metres. A box uses centre <code>x/y/z</code>, <code>width</code>, <code>depth</code>, <code>height</code>, and optional yaw in degrees. A cylinder uses centre <code>x/y/z</code>, <code>radius</code>, and <code>height</code>. Each dimension must be 0.01-10000 metres.		* All coordinates and dimensions use metres. A box uses centre <code>x/y/z</code>, <code>width</code>, <code>depth</code>, <code>height</code>, and optional yaw in degrees. A cylinder uses centre <code>x/y/z</code>, <code>radius</code>, and <code>height</code>. Each dimension must be 0.01-10000 metres.
	* A polygon uses <code>points = {{x=...,y=...}, ...}</code> with 3-16 vertices plus <code>minZ</code> and <code>maxZ</code>. It must be finite, simple and convex; clockwise input is normalized. Coordinates are limited to +/-100000 metres.		* A polygon uses <code>points = {{x=...,y=...}, ...}</code> with 3-16 vertices plus <code>minZ</code> and <code>maxZ</code>. It must be finite, simple and convex; clockwise input is normalized. Coordinates are limited to +/-100000 metres.
	* Optional <code>enabled</code> defaults to true. The server permits at most ~~1024~~ blockers per resource and ~~4096~~ total, and also bounds spatial-index growth.		* Optional <code>enabled</code> defaults to true. The server permits at most 4096 blockers per resource and 16384 total, and also bounds spatial-index growth.
	* The blocker is visible to every AI entity whose collision mode includes the custom layer, not only entities owned by the creating resource. Only the creating resource may inspect, update, enable, disable or destroy it.		* The blocker is visible to every AI entity whose collision mode includes the custom layer, not only entities owned by the creating resource. Only the creating resource may inspect, update, enable, disable or destroy it.
	* Stopping or restarting the owning resource removes all of its blockers automatically. Dynamic player, NPC and monster capsule collision is separate and always remains active.		* Stopping or restarting the owning resource removes all of its blockers automatically. Dynamic player, NPC and monster capsule collision is separate and always remains active.
	* Use custom blockers for static geometry and occasional changes such as opening or closing a gate. Moving or toggling blockers every server tick is unsupported; moving characters already use the mandatory dynamic capsule layer.		* Use custom blockers for static geometry and occasional changes such as opening or closing a gate. Moving or toggling blockers every server tick is unsupported; moving characters already use the mandatory dynamic capsule layer.
			* 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]]

Create3DText

QCherry — Sat, 12 Sep 2026 11:51:44 GMT

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]]

RequestRemote

QCherry — Sat, 12 Sep 2026 11:51:42 GMT

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: requestRemote. -->~~
	= requestRemote =		= requestRemote =
	Queues a bounded asynchronous HTTP or HTTPS request from a server-side resource.		Queues a bounded asynchronous HTTP or HTTPS request from a server-side resource.
Line 67:		Line 66:
	* Only HTTP and HTTPS are accepted. Loopback, private, link-local, reserved, documentation, and mixed public/private DNS results are rejected. Every redirect target is resolved and validated again.		* Only HTTP and HTTPS are accepted. Loopback, private, link-local, reserved, documentation, and mixed public/private DNS results are rejected. Every redirect target is resolved and validated again.
	* DNS answers are pinned for each transfer to prevent rebinding between validation and connection. TLS certificate and hostname verification remain enabled.		* DNS answers are pinned for each transfer to prevent rebinding between validation and connection. TLS certificate and hostname verification remain enabled.
	* ~~Default hard~~ limits are 1 MiB request bodies, 2 MiB response bodies, 32 request headers, ~~16 KiB~~ response headers, 3 attempts, 10 seconds to connect, 30 seconds total, 3 redirects, and 4 pending requests per resource.		* Hard limits are 4 MiB request bodies, 8 MiB response bodies, 128 request headers, 256 response headers, 64 KiB aggregate header bytes, 3 attempts, 10 seconds to connect, 30 seconds total and 3 redirects. Compiled service defaults: 8 workers, 256 queued work items and 32 pending requests per resource.
	* If a body is supplied without an explicit method, the method defaults to <code>POST</code>.		* If a body is supplied without an explicit method, the method defaults to <code>POST</code>.
	* Credentials remain server-side, but resources should still avoid placing secrets in URLs or logs.		* Credentials remain server-side, but resources should still avoid placing secrets in URLs or logs.
			* 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]]

FromJSON

QCherry — Sat, 12 Sep 2026 11:51:41 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 16:		Line 16:
	! Name !! Type !! Required !! Description		! Name !! Type !! Required !! Description
	\|-		\|-
	\| <code>json</code> \|\| <code>string</code> \|\| yes \|\| A UTF-8 JSON document up to ~~32 KiB~~.		\| <code>json</code> \|\| <code>string</code> \|\| yes \|\| A UTF-8 JSON document up to 1 MiB.
	\|}		\|}

Line 35:		Line 35:
	== Notes ==		== Notes ==
	* Available in both server-side and client-side resource scripts.		* Available in both server-side and client-side resource scripts.
	* JSON is limited to ~~32 KiB~~, 16 nested levels, and ~~2048~~ entries.		* JSON is limited to 1 MiB, 64 nested levels, and 65536 cumulative entries.
			* 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:Shared Functions]]		[[Category:Shared Functions]]
	[[Category:Utility Functions]]		[[Category:Utility Functions]]

ToJSON

QCherry — Sat, 12 Sep 2026 11:51:40 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 33:		Line 33:
	== Notes ==		== Notes ==
	* Available in both server-side and client-side resource scripts.		* Available in both server-side and client-side resource scripts.
	* JSON is limited to ~~32 KiB~~, 16 nested levels, and ~~2048~~ entries.		* JSON is limited to 1 MiB, 64 nested levels, and 65536 cumulative entries.
			* 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:Shared Functions]]		[[Category:Shared Functions]]
	[[Category:Utility Functions]]		[[Category:Utility Functions]]

Client audio

QCherry — Sat, 12 Sep 2026 11:51:38 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 111:		Line 111:
	== Ownership and limits ==		== Ownership and limits ==

	* A resource can own at most 32 active sounds; the client runtime can own at most ~~128~~ in total.		* From update 0.1.3 BUILD81, a resource can own at most 128 active sounds; the client runtime can own at most 512 in total (previously 32/128). See [[Scripting limits]].
	* A handle can be controlled only by the resource that created it.		* A handle can be controlled only by the resource that created it.
	* Stopping a resource releases all sounds that it still owns.		* Stopping a resource releases all sounds that it still owns.

Hosting a G1R:MP dedicated server

QCherry — Sat, 12 Sep 2026 11:51:35 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 111:		Line 111:

	== Resource package limits ==		== Resource package limits ==

			These expanded values apply from '''update 0.1.3 BUILD81'''. Older 0.1.3 clients must be updated. See [[Scripting limits]] and [[Server configuration limits]] for all other budgets and exact units.

	The dedicated server and client enforce matching compatibility limits for Lua scripts and downloadable resources. Values at a stated hard boundary are accepted; a resource that exceeds that boundary is rejected before it can run.		The dedicated server and client enforce matching compatibility limits for Lua scripts and downloadable resources. Values at a stated hard boundary are accepted; a resource that exceeds that boundary is rejected before it can run.
Line 117:		Line 119:
	! Limit !! Value !! Scope		! Limit !! Value !! Scope
	\|-		\|-
	\| Lua script size \|\| <code>64 MiB</code> \|\| Each individual <code>.lua</code> script.		\| Lua script size \|\| <code>128 MiB</code> \|\| Each individual <code>.lua</code> script.
	\|-		\|-
	\| Resource file size \|\| <code>64 MiB</code> \|\| Each individual file included in the client resource catalog.		\| Resource file size \|\| <code>256 MiB</code> \|\| Each individual file included in the client resource catalog.
	\|-		\|-
	\| Catalog file count \|\| <code>65,~~536~~</code> files \|\| All client scripts and downloadable files across the complete catalog.		\| Catalog file count \|\| <code>262,144</code> files \|\| All client scripts and downloadable files across the complete catalog.
	\|-		\|-
	\| Catalog payload \|\| <code>8 GiB</code> \|\| Sum of the file sizes declared by the complete client resource catalog.		\| Catalog payload \|\| <code>32 GiB</code> \|\| Sum of the file sizes declared by the complete client resource catalog.
	\|-		\|-
	\| Catalog JSON document \|\| <code>64 MiB</code> \|\| Serialized <code>catalog.json</code> metadata returned by the resource service.		\| Catalog JSON document \|\| <code>128 MiB</code> \|\| Serialized <code>catalog.json</code> metadata returned by the resource service.
	\|-		\|-
	\| Lua VM memory \|\| <code>~~256~~ MiB</code> by default \|\| Each client-side resource Lua VM uses the ~~256~~ MiB default. For each server-side resource Lua VM, <code>[lua] memoryLimitMB</code> is configurable from <code>4</code> through <code>4096</code> MiB; the shipped default is <code>~~256~~</code> MiB.		\| Lua VM memory \|\| <code>1024 MiB</code> by default \|\| Each client-side resource Lua VM uses the 1024 MiB default. For each server-side resource Lua VM, <code>[lua] memoryLimitMB</code> is configurable from <code>4</code> through <code>4096</code> MiB; the shipped default is <code>1024</code> MiB.
	\|}		\|}

Lua API catalogs

QCherry — Sat, 12 Sep 2026 11:51:34 GMT

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:
	{{DISPLAYTITLE:Lua API catalogs}}		{{DISPLAYTITLE:Lua API catalogs}}

			See [[Scripting limits\|current Lua, resource and API limits for 0.1.3 BUILD81]], [[Server configuration limits\|all numeric server configuration bounds]] and [[Player statistic limits\|all 59 statistic ranges]].
	'''Lua API catalogs''' collect stable, server-validated keys used by G1R:MP resources. Prefer catalog keys and enumeration functions over hard-coded Unreal paths.		'''Lua API catalogs''' collect stable, server-validated keys used by G1R:MP resources. Prefer catalog keys and enumeration functions over hard-coded Unreal paths.

Main Page

QCherry — Sat, 12 Sep 2026 11:51:33 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

← Older revision		Revision as of 11:51, 12 September 2026
Line 52:		Line 52:
	<li>[[:Category:Lua Functions\|Complete function catalog]]</li>		<li>[[:Category:Lua Functions\|Complete function catalog]]</li>
	<li>[[Lua events\|Complete event and callback catalog]]</li>		<li>[[Lua events\|Complete event and callback catalog]]</li>
			<li>[[Scripting limits\|Lua, resource and API limits — 0.1.3 BUILD81]]</li>
	<li>[[Lua API catalogs\|Validated skin, monster, equipment, and gameplay keys]]</li>		<li>[[Lua API catalogs\|Validated skin, monster, equipment, and gameplay keys]]</li>
	<li>[[NPC and monster navigation collision\|NPC and monster navigation collision]]</li>		<li>[[NPC and monster navigation collision\|NPC and monster navigation collision]]</li>

Player statistic limits

QCherry — Sat, 12 Sep 2026 11:51:32 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

New page

{{DISPLAYTITLE:Player statistic limits}}
'''Current in update 0.1.3, expanded-budget BUILD81; audited 2026-09-12.''' These statistic ranges were '''not raised''' by the scripting-capacity update: gameplay values are separate from Lua VM storage.

<code>setPlayerStat</code> and its named stat setters reject unknown keys/non-finite values and clamp finite numeric values to the catalog range below. Further authoritative rules still apply (for example current health versus max health, life state and equipment). This table is not a promise that every underlying single-player attribute has independent gameplay support. Query [[getPlayerStatLimits]] and [[getPlayerStatNames]] rather than copying assumptions into a gamemode. See [[Scripting limits]].

== All 59 catalog ranges ==
{| class="wikitable sortable"
! Stat key !! Minimum !! Maximum
|-
| <code>alcohol</code> || 0 || 100000
|-
| <code>max_alcohol</code> || 0 || 100000
|-
| <code>alcohol_depletion_rate</code> || 0 || 100000
|-
| <code>super_armor</code> || 0 || 100000
|-
| <code>max_super_armor</code> || 0 || 100000
|-
| <code>resistance_blunt</code> || 0 || 100000
|-
| <code>resistance_edge</code> || 0 || 100000
|-
| <code>resistance_point</code> || 0 || 100000
|-
| <code>resistance_fire</code> || 0 || 100000
|-
| <code>resistance_energy</code> || 0 || 100000
|-
| <code>resistance_ice</code> || 0 || 100000
|-
| <code>resistance_wind</code> || 0 || 100000
|-
| <code>resistance_falling</code> || 0 || 100000
|-
| <code>dexterity</code> || 0 || 100000
|-
| <code>fatigue</code> || 0 || 100000
|-
| <code>max_fatigue</code> || 0 || 100000
|-
| <code>fatigue_fill_ratio</code> || 0 || 100000
|-
| <code>fatigue_fill_ratio_period</code> || 0 || 100000
|-
| <code>fatigue_max_threshold_index</code> || 0 || 100000
|-
| <code>fatigue_recovery_per_sleep_hour</code> || 0 || 100000
|-
| <code>health</code> || 0 || 100000
|-
| <code>max_health</code> || 1 || 100000
|-
| <code>damage_multiplier</code> || 0 || 100
|-
| <code>health_recovery_per_sleep_hour</code> || 0 || 100000
|-
| <code>level</code> || 0 || 1000
|-
| <code>experience</code> || 0 || 1000000000
|-
| <code>skill_points</code> || 0 || 1000000
|-
| <code>xp_executed_bounty</code> || 0 || 1000000000
|-
| <code>xp_kill_or_defeat_bounty</code> || 0 || 1000000000
|-
| <code>toughness</code> || 0 || 100000
|-
| <code>toughness_a</code> || 0 || 100000
|-
| <code>toughness_b</code> || 0 || 100000
|-
| <code>toughness_c</code> || 0 || 100000
|-
| <code>lockpick_durability</code> || 0 || 100000
|-
| <code>lockpick_precision</code> || 0 || 100000
|-
| <code>mana</code> || 0 || 100000
|-
| <code>max_mana</code> || 0 || 100000
|-
| <code>magician_level</code> || 0 || 6
|-
| <code>mana_recovery_per_sleep_hour</code> || 0 || 100000
|-
| <code>speed_modifier</code> || 0 || 100
|-
| <code>oxygen</code> || 0 || 100000
|-
| <code>max_oxygen</code> || 0 || 100000
|-
| <code>oxygen_depletion_rate</code> || 0 || 100000
|-
| <code>oxygen_recovery_rate</code> || 0 || 100000
|-
| <code>oxygen_critical_level_percent</code> || 0 || 100
|-
| <code>pickpocketing</code> || 0 || 100000
|-
| <code>sleep_time</code> || 0 || 100000
|-
| <code>max_sleep_time</code> || 0 || 100000
|-
| <code>sleep_recovery_amount</code> || 0 || 100000
|-
| <code>sleep_recovery_period</code> || 0 || 100000
|-
| <code>max_rest_time</code> || 0 || 100000
|-
| <code>strength</code> || 0 || 100000
|-
| <code>critical_fists</code> || 0 || 100
|-
| <code>critical_one_hand</code> || 0 || 100
|-
| <code>critical_two_hand</code> || 0 || 100
|-
| <code>critical_orc</code> || 0 || 100
|-
| <code>swampweed</code> || 0 || 100000
|-
| <code>max_swampweed</code> || 0 || 100000
|-
| <code>swampweed_depletion_rate</code> || 0 || 100000
|}

== Source audit ==
<code>shared/PlayerProgressionCatalog.hpp</code> (Stats, 59 entries); <code>server/src/scripting/ScriptRuntime.cpp</code> (set_player_stat_value).

[[Category:Lua API]]

Server configuration limits

QCherry — Sat, 12 Sep 2026 11:51:31 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

New page

{{DISPLAYTITLE:Server configuration limits}}
<div style="border-left:4px solid #c33;padding:0.7em 1em;background:#fff5f5">'''CURRENT IN UPDATE 0.1.3 — expanded-budget BUILD81 (2026-09-12).'''</div>
All numeric ranges below are extracted from the production configuration parser, not guessed from a running server. Defaults are the compiled defaults; an explicit setting in your existing configuration overrides them. Invalid out-of-range values fail configuration loading instead of being silently clamped. Restart with the new server executable/configuration to apply changes. Do not overwrite your passwords, keys or other custom settings with a sample configuration.

See [[Scripting limits]] for fixed API capacities and client limits. Server <code>[lua]</code> settings do not propagate to the client VM.

== Complete numeric configuration table ==
{| class="wikitable sortable"
! Setting !! Compiled default !! Minimum !! Maximum !! Unit
|-
| <code>server.port</code> || 7777 || 1 || 65535 || TCP/UDP port
|-
| <code>server.maxPlayers</code> || 500 || 1 || 5000 || count / integer
|-
| <code>server.tickrate</code> || 30 || 1 || 240 || ticks/s
|-
| <code>server.syncDistance</code> || 15000 || 500 || 200000 || cm (100 cm = 1 m)
|-
| <code>server.peerTimeoutMinimumMs</code> || 20000 || 5000 || 60000 || ms
|-
| <code>server.peerTimeoutMaximumMs</code> || 40000 || 5000 || 120000 || ms
|-
| <code>server.peerTimeoutLimit</code> || 32 || 4 || 64 || count / integer
|-
| <code>http.port</code> || 7780 || 1 || 65535 || TCP/UDP port
|-
| <code>http.workerThreads</code> || 8 || 1 || 64 || count / integer
|-
| <code>http.maxQueuedRequests</code> || 1024 || 8 || 16384 || count / integer
|-
| <code>http.requestsPerMinutePerIp</code> || 1200 || 60 || 100000 || per minute
|-
| <code>http.maxTrackedAddresses</code> || 8192 || 256 || 1000000 || count / integer
|-
| <code>http.readTimeoutMs</code> || 5000 || 500 || 120000 || ms
|-
| <code>http.writeTimeoutMs</code> || 30000 || 1000 || 600000 || ms
|-
| <code>nameplates.maxPairs</code> || 250000 || 1 || 1000000 || count / integer
|-
| <code>nameplates.maxPairsPerResource</code> || 250000 || 1 || 1000000 || count / integer
|-
| <code>nameplates.mutationsPerSecond</code> || 4096 || 1 || 250000 || per second
|-
| <code>nameplates.mutationBurst</code> || 8192 || 1 || 250000 || count / integer
|-
| <code>voice.port</code> || 7778 || 1 || 65535 || TCP/UDP port
|-
| <code>voice.ticketTtlMs</code> || 15000 || 1000 || 120000 || ms
|-
| <code>voice.idleTimeoutMs</code> || 5000 || 2000 || 120000 || ms
|-
| <code>voice.heartbeatIntervalMs</code> || 1000 || 250 || 10000 || ms
|-
| <code>voice.maxFramesPerSecond</code> || 55 || 10 || 200 || per second
|-
| <code>voice.maxBytesPerSecond</code> || 65536 || 8192 || 1048576 || bytes/s
|-
| <code>voice.maxPendingHandshakes</code> || 128 || 1 || 4096 || count / integer
|-
| <code>voice.maxConnectionsPerIp</code> || 32 || 1 || 1000 || count / integer
|-
| <code>voice.maxTrackedAddresses</code> || 16384 || 256 || 1000000 || count / integer
|-
| <code>voice.whisperRange</code> || 500 || 50 || 200000 || cm (100 cm = 1 m)
|-
| <code>voice.defaultRange</code> || 1800 || 50 || 200000 || cm (100 cm = 1 m)
|-
| <code>voice.shoutRange</code> || 3500 || 50 || 200000 || cm (100 cm = 1 m)
|-
| <code>voice.maxRange</code> || 10000 || 50 || 200000 || cm (100 cm = 1 m)
|-
| <code>lua.memoryLimitMB</code> || 1024 || 4 || 4096 || MiB
|-
| <code>lua.instructionLimit</code> || 10000000 || 10000 || 1000000000 || count / integer
|-
| <code>lua.timeoutMs</code> || 5000 || 10 || 60000 || ms
|-
| <code>lua.hookInstructionInterval</code> || 10000 || 100 || 1000000 || count / integer
|-
| <code>magic.projectileTickrate</code> || 30 || 10 || 120 || ticks/s
|-
| <code>magic.maxCastsPerSecond</code> || 6 || 1 || 30 || per second
|-
| <code>magic.maxSnapshotAgeMs</code> || 1000 || 100 || 10000 || ms
|-
| <code>magic.playerCapsuleRadius</code> || 45 || 10 || 500 || cm (100 cm = 1 m)
|-
| <code>magic.playerCapsuleHalfHeight</code> || 90 || 20 || 1000 || cm (100 cm = 1 m)
|-
| <code>ranged.projectileTickrate</code> || 30 || 10 || 120 || ticks/s
|-
| <code>ranged.maxShotsPerSecond</code> || 8 || 1 || 30 || per second
|-
| <code>ranged.maxSnapshotAgeMs</code> || 1000 || 100 || 10000 || ms
|-
| <code>ranged.developmentArrowCount</code> || 0 || 0 || 65535 || count / integer
|-
| <code>ranged.developmentBoltCount</code> || 0 || 0 || 65535 || count / integer
|-
| <code>ranged.playerCapsuleRadius</code> || 45 || 10 || 500 || cm (100 cm = 1 m)
|-
| <code>ranged.playerCapsuleHalfHeight</code> || 90 || 20 || 1000 || cm (100 cm = 1 m)
|-
| <code>rcon.port</code> || 7781 || 1 || 65535 || TCP/UDP port
|-
| <code>rcon.timestampWindowSeconds</code> || 30 || 5 || 300 || s
|-
| <code>rcon.requestsPerMinute</code> || 60 || 1 || 600 || per minute
|-
| <code>security.handshakeTimeoutMs</code> || 5000 || 1000 || 30000 || ms
|-
| <code>security.maxConnectionsPerIp</code> || 32 || 1 || 1000 || count / integer
|-
| <code>security.maxPendingHandshakes</code> || 128 || 1 || 2048 || count / integer
|-
| <code>security.connectionAttemptsPerMinute</code> || 120 || 1 || 100000 || per minute
|-
| <code>security.preAuthPacketsPerSecond</code> || 12 || 1 || 1000 || per second
|-
| <code>security.authenticatedPacketsPerSecond</code> || 240 || 30 || 10000 || per second
|-
| <code>security.authenticatedBytesPerSecond</code> || 524288 || 65536 || 67108864 || bytes/s
|-
| <code>security.invalidPacketsPerMinute</code> || 16 || 1 || 10000 || per minute
|-
| <code>security.temporaryBlockSeconds</code> || 120 || 10 || 86400 || s
|-
| <code>security.maxTrackedAddresses</code> || 16384 || 256 || 1000000 || count / integer
|-
| <code>security.maxPacketBytes</code> || 65536 || 16384 || 1048576 || bytes
|-
| <code>security.maxWaitingDataPerPeerBytes</code> || 524288 || 65536 || 16777216 || bytes
|-
| <code>world.day</code> || 0 || 0 || 1000000 || count / integer
|-
| <code>world.hour</code> || 8 || 0 || 23 || count / integer
|-
| <code>world.minute</code> || 0 || 0 || 59 || count / integer
|-
| <code>world.minuteDurationMs</code> || 1000 || 0 || 3600000 || ms
|-
| <code>world.weatherTransitionMs</code> || 3000 || 0 || 300000 || ms
|-
| <code>world.syncIntervalMs</code> || 5000 || 500 || 60000 || ms
|-
| <code>database.workerThreads</code> || 8 || 1 || 64 || count / integer
|-
| <code>database.maxConnectionsPerResource</code> || 16 || 1 || 128 || count / integer
|-
| <code>database.maxPendingQueriesPerResource</code> || 1024 || 1 || 100000 || count / integer
|-
| <code>database.maxQueryBytes</code> || 4194304 || 1024 || 67108864 || bytes
|-
| <code>database.maxResultRows</code> || 50000 || 1 || 1000000 || count / integer
|-
| <code>database.maxResultBytes</code> || 67108864 || 1024 || 536870912 || bytes
|-
| <code>database.connectTimeoutMs</code> || 5000 || 100 || 120000 || ms
|-
| <code>database.readTimeoutMs</code> || 15000 || 100 || 300000 || ms
|-
| <code>database.writeTimeoutMs</code> || 15000 || 100 || 300000 || ms
|-
| <code>database.maxBlockingPollMs</code> || 100 || 0 || 5000 || ms
|-
| <code>security.passwordWorkerThreads</code> || 4 || 1 || 8 || count / integer
|-
| <code>security.passwordQueueCapacity</code> || 1024 || 8 || 4096 || count / integer
|-
| <code>security.passwordPendingPerResource</code> || 256 || 1 || 512 || count / integer
|-
| <code>security.passwordMemoryKiB</code> || 65536 || 8192 || 1048576 || KiB
|-
| <code>security.passwordIterations</code> || 3 || 1 || 10 || count / integer
|-
| <code>security.passwordParallelism</code> || 1 || 1 || 4 || count / integer
|}

== Additional validation and units ==
* Peer timeout maximum must be at least the minimum. Voice idle timeout must be at least twice its heartbeat interval.
* Voice ranges must satisfy whisper <= default <= shout <= max. These configuration values and <code>server.syncDistance</code> are '''centimetres''', not the metre units used by camera, NPC route and 3D-text Lua functions.
* <code>world.minuteDurationMs=0</code> pauses time. Day 0..1000000, hour 0..23 and minute 0..59 are separate limits.
* Enabled voice must use a different port from gameplay, resource HTTP and enabled RCON.
* At least one autostart resource and a nonempty navigation map filename are required. Navigation geometry settings are not exposed as numeric serverconf settings; see [[Scripting limits#Navigation]].
* Listing/name text: server name at most 96 UTF-8 bytes and 48 codepoints; description at most 320 bytes and 160 codepoints. Game mode is an ASCII token up to 24 bytes, region 12, version 24; at most 8 tags of 16 bytes each. Join password is at most 128 bytes.
* Production master-list heartbeat is fixed at 20 seconds and authorization maximum staleness at 300 seconds. These are not operator-adjustable Lua limits. Device identity verification remains mandatory.
* Rate controls are shared traffic budgets, not one independent allowance per Lua event. Increasing Lua storage does not disable anti-abuse controls.

== Source audit ==
<code>server/src/config/ServerConfig.cpp</code> (every numeric <code>parse_unsigned</code> setting), <code>ServerConfig.hpp</code>, <code>server/src/database/DatabaseTypes.hpp</code>, <code>shared/native_protocol.hpp</code>. Audit: 2026-09-12, protocol 34, expanded-budget 0.1.3 BUILD81.

[[Category:Lua API]]

Scripting limits

QCherry — Sat, 12 Sep 2026 11:51:30 GMT

Document expanded scripting capacities and complete audited limits for 0.1.3 BUILD81

New page

{{DISPLAYTITLE:Scripting limits}}
<div style="border-left:4px solid #c33;padding:0.7em 1em;background:#fff5f5">'''CURRENT IN UPDATE 0.1.3 — expanded-budget BUILD81 (2026-09-12).''' Earlier 0.1.3 binaries have smaller capacities. Update the server and the complete client/launcher package before relying on the expanded limits.</div>

This reference lists the current developer-facing Lua, resource, API, queue and configuration limits audited in source. It distinguishes '''fixed capacities''', '''compiled defaults''' and '''operator-configurable bounds'''. It does not treat every internal rendering/physics constant as a scripting limit or guarantee that the maximum workload will run smoothly on every machine.

* [[Server configuration limits|All 84 numeric server settings: default, minimum, maximum and units]]
* [[Player statistic limits|All 59 player statistic ranges]]
* [[Lua API catalogs|Allowed appearance, equipment, monster and other catalog keys]]

'''Units:''' KiB = 1024 bytes; MiB = 1024 KiB; GiB = 1024 MiB. String limits count bytes unless a separate Unicode-codepoint limit is stated. Most position-based Lua functions use metres; '''server sync-distance configuration and voice range use centimetres'''. Times are milliseconds unless stated otherwise. Coordinates must be finite; numeric validity is not a promise that playable terrain exists at that position.

== Lua VM and execution ==
{| class="wikitable"
! Limit !! Client !! Server !! Scope / behaviour
|-
| Lua VM allocation budget || 1024 MiB || 1024 MiB default; configurable 4..4096 MiB || Per resource/VM. Allocated on demand, not reserved on resource startup. This is not a cap on total process/native allocations, textures, audio or database buffers.
|-
| Instruction budget || 10000000 || 10000000 default; configurable 10000..1000000000 || Reset on each protected script chunk/callback invocation. Exceeding it raises a Lua error.
|-
| Execution timeout || 5000 ms || 5000 ms default; configurable 10..60000 ms || Cooperative Lua-hook check, not an OS watchdog and not preemption of a blocking native API call.
|-
| Hook interval || 10000 instructions || 10000 default; configurable 100..1000000 || Budgets are checked in samples; execution can pass a nominal boundary before the next check.
|}

Server settings are <code>lua.memoryLimitMB</code>, <code>lua.instructionLimit</code>, <code>lua.timeoutMs</code>, <code>lua.hookInstructionInterval</code>. They '''do not propagate to the client'''. An existing configuration retaining older values overrides the new server defaults. The production and bundled GothicRP-test configuration templates now use the expanded Lua/DB defaults.

Lua is the sandboxed LuaJIT/Lua 5.1 environment with JIT disabled. Base, table, string and math libraries are exposed; general filesystem/OS/module-loading access is not. <code>dofile</code>, <code>load</code>, <code>loadfile</code>, <code>loadstring</code>, <code>getfenv</code>, <code>setfenv</code>, <code>collectgarbage</code>, <code>newproxy</code>, <code>coroutine</code>, <code>io</code>, <code>os</code>, <code>package</code>, <code>debug</code>, <code>jit</code>, <code>ffi</code> and <code>string.dump</code> are unavailable. Lua bytecode is rejected. Increasing capacity does not weaken sandbox, hash, ownership, path or network validation.

== Timers, handlers and commands ==
{| class="wikitable"
! Capacity !! Client, per resource !! Server
|-
| Timers || 8192 (previously 256) || No additional fixed timer-count cap in the server Lua API; still subject to memory and execution cost.
|-
| Timer callbacks selected per tick || 256 (previously 32), oldest deadline first || No matching fixed per-tick callback-count cap. Due timers are processed by the server runtime.
|-
| Event handlers, total || 8192 (previously 256) || No additional fixed count cap in the registration API.
|-
| Handlers for one event || 512 (previously 32) || No matching fixed per-event count cap.
|-
| Declared remote event names || 4096 (previously 256) || No additional fixed registration-count cap.
|-
| Key bindings || 1024 (previously 128) || Client-only feature.
|}

Both timer APIs require an interval of at least '''10 ms'''; interval and repeat-count parameters are unsigned 32-bit values. Repeat count <code>0</code> means repeat indefinitely. This is not a precision guarantee: timer dispatch follows runtime ticks, and missed intervals are not replayed in an unlimited catch-up loop. Client timers and key bindings accept at most '''32 callback arguments'''. Cancelled client timers leave their storage slots when the tick removes cancelled entries. Client <code>setTimer</code> returns <code>0</code> on rejection; handler/key-binding registration returns <code>false</code>. Check return values.

Client selection is deadline-ordered and snapshots timer IDs before callbacks. Large batches of fast repeating timers therefore do not permanently starve later timers; callbacks may still be delayed by load. Do not use thousands of 10-ms timers as a substitute for batching work.

Server local event dispatch has a recursion-depth limit of '''32'''; nested command execution has a depth limit of '''16'''. Command names are nonempty and at most '''64 bytes'''. <code>executeCommandHandler</code> accepts at most '''32 arguments''' with at most '''2048 bytes''' of converted argument text in total. These recursion guards are not capacities for how many independent events/commands a gamemode can declare.

== Network events and IPC ==
{| class="wikitable"
! Field !! Fixed limit
|-
| Resource name in an event envelope || 96 bytes
|-
| Event name || 128 bytes
|-
| Arguments per serialized resource event || 32
|-
| One event string || 32 KiB
|-
| Complete serialized resource event || 64 KiB, including headers, names and all arguments
|-
| Client IPC payload || 64 KiB
|-
| IPC buffered bytes / queued frames || 256 KiB / 256 frames; separate guards
|}

Values transported directly are nil, boolean, integer/number and string, '''not Lua tables, functions or userdata'''. Client local event argument conversion also uses the 32-argument/32-KiB-string guards. Server-local callbacks should not be confused with serialized network messages. Lua numbers do not represent every 64-bit integer exactly: keep large opaque identifiers as strings where the API specifies strings.

'''A 1-MiB JSON document cannot be sent as one event string.''' The expanded JSON limit is for local serialization/storage; the event envelope is unchanged. For bulk application data, use bounded application-level chunks or appropriate resource/HTTP/database facilities. Validate sender permissions, payloads and request rates. Packet/IP budgets in [[Server configuration limits]] still apply to the connection as a whole.

== Resource files and downloads ==
{| class="wikitable"
! Capacity !! BUILD81 value !! Previous value
|-
| One Lua source file || 128 MiB || 64 MiB
|-
| One resource file || 256 MiB || 64 MiB
|-
| All files in the client download catalog || 32 GiB || 8 GiB
|-
| Catalog file count || 262144 || 65536
|-
| Serialized catalog document || 128 MiB || 64 MiB
|}

The download totals cover client/shared scripts and declared files, not server-only scripts. Server-only Lua files still have their individual Lua source-file cap. Server, launcher and client share these constants. A resource exceeding the old client limits will not work with old launchers simply because the server was updated.

Client catalog relative paths are at most '''512 bytes''', with at most '''128 bytes per segment'''; file URLs are at most '''2048 bytes'''. Resource names used across the whole scripting/network stack should fit the stricter '''96-byte event-name envelope field''' even though filesystem-side validators allow longer names. Paths must stay inside the resource, use the accepted relative-path syntax and refer to declared files; absolute paths and traversal are not enabled by larger file budgets.

== JSON ==
<code>toJSON</code>/<code>fromJSON</code> now allow '''1 MiB''', nesting depth '''64''' and '''65536 cumulative entries''' across the document (previously 32 KiB / 16 / 2048). Object keys remain at most '''256 bytes'''. Arrays must use contiguous positive indices; mixed array/object key tables, cyclic references and non-finite numbers are rejected. Failure returns <code>false</code> plus an error description. The byte cap applies to the serialized document, not to the full native/Lua memory consumed while processing it.

== Database and password work ==
{| class="wikitable"
! Compiled default !! BUILD81 value !! Configuration / scope
|-
| DB workers || 8 || Global worker pool
|-
| DB connections || 16 || Per resource
|-
| Pending DB queries || 1024 || Per resource
|-
| SQL statement || 4 MiB || Per query
|-
| DB result || 50000 rows and 64 MiB || Per result, both guards apply
|-
| DB timeouts || connect 5000 / read 15000 / write 15000 ms || Connection options may reduce, but not exceed, configured timeouts; minimum 100 ms
|-
| Blocking dbPoll || 100 ms maximum || Configurable; negative timeout becomes non-blocking and excessive timeout is clamped
|-
| Password workers / queue / pending per resource || 4 / 1024 / 256 || Password hashing/verifying service
|}

All configurable ranges are listed in [[Server configuration limits]]. Result overflow is reported as a database error (client result-limit error '''90001'''), not a successful partial result. Free/poll results and avoid unbounded result retention; use SQL pagination. MariaDB/MySQL can impose additional server-side limits, including its packet and connection settings, which this application does not automatically change.

Passwords for hash/verify are at most '''256 bytes'''; encoded hashes at most '''512 bytes'''. Default Argon2id parameters remain '''65536 KiB memory, 3 iterations, parallelism 1'''; larger queue capacity does not weaken hash security. DB multi-statements, multi-queries, local infile and automatic reconnect are not enabled as a side effect of this update.

== requestRemote ==
{| class="wikitable"
! Limit !! Value
|-
| Workers / queued work / pending per resource || 8 / 256 / 32 (compiled defaults)
|-
| URL || 2048 bytes
|-
| Request body / response body || 4 MiB / 8 MiB
|-
| Request headers / response headers || 128 / 256
|-
| Aggregate header bytes || 64 KiB
|-
| Header name / username / password || 128 / 512 / 512 bytes
|-
| Connection attempts || 1..3; default 1
|-
| Connect timeout || 500..10000 ms; default 5000
|-
| Total timeout || 1000..30000 ms; default 15000
|-
| Redirect count || 0..3; default 2
|}

Allowed methods are GET, POST, PUT, PATCH, DELETE, HEAD and OPTIONS. Only the supported HTTP/HTTPS destinations are accepted. Loopback/private-address restrictions, DNS and redirect validation stay enabled in production. Capacity or validation rejection returns an error; asynchronous transfers also report completion errors. Keep callbacks short. The larger download-catalog file limit is '''not''' the requestRemote response limit.

== World entities and text ==
{| class="wikitable"
! Feature !! Fixed capacity / range
|-
| Active world items || 16384 globally (previously 4096); quantity 1..1000 per spawn
|-
| Active NPCs || 8192 globally (previously 2048)
|-
| Active monsters || 4096 globally (previously 1024)
|-
| NPC route || 1..1024 points (previously 256); each wait 0..3600000 ms; speed 0.1..12 m/s
|-
| NPC scripted movement arrival radius || 0.01..5 m
|-
| Monster scripted movement || speedScale >0 and <=1; Lua arrivalRadius 0.01..5 m
|-
| Monster max health / attack damage || max health >0 and <=1000000; damage 0..100000
|-
| NPC name || 3..16 bytes, without control characters
|-
| Monster/nameplate display text || At most 96 UTF-8 bytes and 48 codepoints
|-
| 3D text objects || 1024 per resource / 8192 globally (previously 256 / 2048)
|-
| 3D text content || Nonempty, at most 256 bytes AND 128 Unicode codepoints; no control characters/newlines
|-
| 3D text draw distance / scale || 1..1000 m / 0.25..5
|-
| Scripted world positions || Finite coordinates within +/-1000000 m per axis where the Lua position validator is used
|}

Global capacities are shared across resources. Creation above a capacity is rejected; it does not expand the cap or authorize mutation of another resource's entities. More accepted entities do not mean that placing all of them in one visible area is performant. Navigation, authoritative sync distance, client streaming and actual hardware still matter.

== Navigation ==
The compiled custom-collision capacities are '''16384 blockers globally / 4096 per owner''' (previously 4096 / 1024). The internal settings validator permits global capacity up to '''65536''', with owner capacity positive and no greater than global capacity. These are not extra numeric <code>serverconf.cfg</code> options.

* Lua custom blocker coordinates: +/-100000 m; size/height dimensions 0.01..10000 m; polygons 3..16 vertices and must pass geometry validation.
* Navigation artifact: at most 256 MiB and 200000 baked blockers (previously 64 MiB / 50000); polygon cap 16 vertices.
* Compiled search defaults remain grid cell 50 cm, detour margin 1200 cm, maximum slope 45 degrees, maximum path distance 30000 cm (300 m), maximum search nodes 120000.
* Internal settings bounds: grid cell 5..1000 cm; detour margin 0..50000 cm; slope >=0 and <89 degrees; path distance >=grid cell and <=1000000 cm; search nodes 64..1000000.
* Navigation failure/search exhaustion is not permission to cross blockers. See [[NPC and monster navigation collision]].

== Player state, appearance and nameplates ==
* Player names: 3..16 bytes, accepted player-name character set. Appearance, armor, weapons, spells, skills and tattoo selection use validated catalogs, not arbitrary game asset paths; see [[Lua API catalogs]].
* Skin RGB and display RGBA components: integers 0..255. Tattoo catalog: 12 presets. These are valid value ranges, not gamemode capacity budgets, and were not expanded.
* Inventory give/remove amount: 1..1000 per call. Server-controlled cumulative count: ammunition at most 65535, other supported items at most 100000. Ownership and item-specific rules still apply.
* Consumable grant count: 1..100; persistent consumable commit keys at most 96 bytes. This does not authorize trusting client-submitted permanent stats.
* All 59 stat ranges: [[Player statistic limits]]. Common HP/STR/DEX values cap at 100000; max-health minimum is 1. Level caps at 1000, magician level at 6; other stats have their own bounds.
* Scripted player damage amount: positive, at most 100000. Unconscious duration: 0 or 250..3600000 ms; configured health arguments must fit the relevant player-health range. Life-state checks still apply.
* Player/nameplate text: at most 96 UTF-8 bytes and 48 codepoints. Nameplate height offset is within +/-100 m.
* Observer-specific nameplates: defaults 250000 pairs globally and per resource; per-resource mutation budget 4096/s with burst 8192. Configurable ranges: [[Server configuration limits]]. These are directed observer/target overrides, not persistent database rows. Throttle bulk restore operations and handle rejected mutations.
* Nearby-player radius: 0..100000 m. Focus-query maximum distance: 0.1..1000 m; field of view: 1..180 degrees.
* Lua chat output: nonempty and at most 2048 bytes; chat RGB values are clamped to 0..255. Administrative <code>say</code> has its separate 512-byte message cap.
* Animation API uses the 27-key validated animation catalog. <code>startAnim</code> blend argument range is 0..2 seconds. Catalog keys are not raw montage paths.
* Account binding key: 3..24 bytes with its validated identifier syntax; serial: 32 hexadecimal characters. Kick/ban reason: nonempty, at most 160 bytes, valid text without controls. Ban duration: 0 (permanent) or at most 5256000 minutes.

== Camera ==
Camera safety/representation ranges were not changed by this capacity update. '''There is no 100-metre distance-from-player restriction.''' Keep engine streaming and server relevance in mind; coordinate acceptance alone cannot guarantee valid/rendered terrain everywhere. See [[Scripted camera]].

{| class="wikitable"
! Parameter !! Limit
|-
| Camera command document || 24 KiB
|-
| Position/focus/path/orbit envelope || Finite coordinates within +/-1000000 m per axis
|-
| Path points || 1..32
|-
| FOV || 15..150 degrees
|-
| Rotation / orbit starting angle || Absolute value <=360000 degrees
|-
| Orbit sweep || Absolute value <=3600 degrees
|-
| Orbit radius / height offset || 0.1..50 m / absolute value <=50 m
|-
| Command duration || At most 600000 ms
|-
| Each path point || Duration 1..600000 ms; hold 0..600000 ms; sum of all durations and holds <=600000 ms per cycle
|-
| Orbit duration || 100..600000 ms
|-
| Reset blend || 0..10000 ms
|-
| Camera state document || At most 4096 bytes
|}

Looped paths/orbits can repeat; the per-cycle duration bound is not a total lifetime cap. Invalid commands are rejected, not silently replaced by a different camera path. Resource ownership and cleanup still apply.

== Client audio and UI ==
* Audio: '''128 sound handles per resource / 512 globally''' (previously 32 / 128). Declared join-time <code>.ogg</code> resource files only. Stop unused handles; an accepted handle is not a promise that hundreds of simultaneously mixed sounds are cheap.
* Sound volume 0..1; finite 3D coordinates +/-1000000 m; minimum distance >=0.01 m, maximum distance greater than minimum and <=10000 m. Audio paths must also satisfy the catalog's stricter relative-path bounds.
* UI texture files: at most '''256 MiB''' encoded (previously 64 MiB); decoded width and height remain at most '''8192 pixels each'''. This is not a VRAM allocation guarantee.
* UI attribute name: 1..64 bytes with safe-name validation; attribute value at most '''16384 bytes''' (previously 4096). Event-handler attribute injection remains prohibited.
* GUI append-text retains at most '''1000 child lines''' per target element (previously 200), removing older children. This is not a cap on all elements in an RML document.
* No separate fixed document-count or general <code>setInnerRML</code> byte cap was found in the exposed UI API. Resource ownership, file limits, Lua/native memory and rendering cost still apply; this does not mean unlimited capacity.

== Voice ==
Voice remains a separate real-time stream: 48000 Hz, 960 samples/20-ms frame, two channels; encoded frame at most 512 bytes and voice datagram at most 768 bytes. Default sender budgets are 55 frames/s and 65536 bytes/s; see [[Server configuration limits]] for ranges.

'''Voice range values use centimetres''', including <code>setPlayerVoiceRange</code>/<code>getPlayerVoiceRange</code>. A positive finite custom range is normalized to 50 cm..configured <code>voice.maxRange</code>; defaults are whisper 500 cm (5 m), normal 1800 cm (18 m), shout 3500 cm (35 m), maximum 10000 cm (100 m). Voice volume is 0..2; channel ID 0..4294967295. Increasing Lua capacity does not alter voice gain, codec timing or anti-abuse limits.

== Source audit and practical use ==
Audit date: '''2026-09-12'''; expanded-budget '''0.1.3 BUILD81''', protocol '''34'''. Changes increase capacities, not packet layouts. Main sources:

* <code>shared/resource_limits.hpp</code>, <code>resource_event_protocol.hpp</code>, <code>client_ipc_protocol.hpp</code>, <code>scripting/LuaJson.hpp</code>/<code>.cpp</code>, <code>CameraProtocol.hpp</code>, <code>PlayerProgressionCatalog.hpp</code>, <code>PlayerAnimationCatalog.hpp</code>, <code>NameplateValidation.hpp</code>.
* <code>server/src/config/ServerConfig.cpp</code>/<code>.hpp</code>, <code>server/src/scripting/ScriptRuntime.cpp</code>, <code>server/src/resources/ResourceManager.cpp</code>, resource catalog/manifest, database, HTTP, voice and world implementations, <code>server/enet_server.cpp</code>.
* <code>client-runtime/src/scripting/ClientScriptRuntime.cpp</code>/<code>.hpp</code>, <code>app/ClientRuntimeMain.cpp</code>, catalog, audio and UI implementations.

The test suite executes the real Lua runtimes with 8192 client timers / 8193 server timers, expanded handler/remote-event/key-binding capacities, JSON boundary and overflow cases, client timer fairness and restart/cleanup. Capacity boundaries are not a full in-game performance benchmark. Use staged loading, staggered timers, asynchronous DB/HTTP, pagination and explicit cleanup even on fast computers. Always check API results and the runtime logs.

[[Category:Lua API]]

← Older revision		Revision as of 11:51, 12 September 2026
Line 52:		Line 52:
	<li>[[:Category:Lua Functions\|Complete function catalog]]</li>		<li>[[:Category:Lua Functions\|Complete function catalog]]</li>
	<li>[[Lua events\|Complete event and callback catalog]]</li>		<li>[[Lua events\|Complete event and callback catalog]]</li>
			<li>[[Scripting limits\|Lua, resource and API limits — 0.1.3 BUILD81]]</li>
	<li>[[Lua API catalogs\|Validated skin, monster, equipment, and gameplay keys]]</li>		<li>[[Lua API catalogs\|Validated skin, monster, equipment, and gameplay keys]]</li>
	<li>[[NPC and monster navigation collision\|NPC and monster navigation collision]]</li>		<li>[[NPC and monster navigation collision\|NPC and monster navigation collision]]</li>