Lua events - Revision history

QCherry: Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release

2026-10-01T10:21:17Z

Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release

← Older revision		Revision as of 10:21, 1 October 2026
Line 301:		Line 301:
	* [[onNpcProjectileState]] — Reports ranged/spell subsystem state transitions for an NPC.		* [[onNpcProjectileState]] — Reports ranged/spell subsystem state transitions for an NPC.
	<!-- npc015:end -->		<!-- npc015:end -->

			<!-- game-audio017:start -->
			== Game audio event (upcoming 0.1.7) ==
			* Client: [[onClientGameSoundResult]] — asynchronous game-sound results and lifecycle notifications, delivered to the owning resource. Callback: <code>function(requestId, ok, reason, dataJson)</code>.
			Planned for update 0.1.7; not included in public 0.1.6. See [[Game audio]] for request IDs, JSON result data and cleanup.
			<!-- game-audio017:end -->

QCherry: Document new NPC/player-mode API and events available from 0.1.5

2026-09-25T17:14:26Z

Document new NPC/player-mode API and events available from 0.1.5

← Older revision		Revision as of 17:14, 25 September 2026
Line 12:		Line 12:
	Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.		Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.

	The ~~current reference~~ documents ~~'''94 Lua~~ events~~'''~~. Red badges identify the update in which an event became available or received a materially improved compatibility contract.		The catalog below documents runtime events, with version-specific additions listed separately. Red badges identify the update in which an event became available or received a materially improved compatibility contract.

	== Resource events ==		== Resource events ==
Line 292:		Line 292:
	== Authenticated event origin (since 0.1.4) ==		== Authenticated event origin (since 0.1.4) ==
	See [[getEventClient]] for the authenticated initiating player, eventOrigin/sourceResource behavior, synchronous forwarding and asynchronous limitations. Client-provided resource names are not trusted server origins.		See [[getEventClient]] for the authenticated initiating player, eventOrigin/sourceResource behavior, synchronous forwarding and asynchronous limitations. Client-provided resource names are not trusted server origins.

			<!-- npc015:start -->
			== New server events since 0.1.5 ==
			* [[onPlayerWeaponModeChange]] — Reports a change of observed player drawn-weapon mode.
			* [[onNpcDamage]] — Reports authoritative incoming NPC damage after state commit.
			* [[onNpcDeath]] — Reports an NPC transition to dead.
			* [[onNpcAttack]] — Reports an NPC attack impact against a player.
			* [[onNpcProjectileState]] — Reports ranged/spell subsystem state transitions for an NPC.
			<!-- npc015:end -->

QCherry: Release 0.1.4 BUILD133 / Protocol 36 and document authenticated event origin

2026-09-21T20:37:14Z

Release 0.1.4 BUILD133 / Protocol 36 and document authenticated event origin

← Older revision		Revision as of 20:37, 21 September 2026
Line 275:		Line 275:

	[[Category:Lua Events]]		[[Category:Lua Events]]
	== Database recovery (since 0.1.4~~, in development~~) ==		== Database recovery (since 0.1.4) ==
	* [[onDatabaseConnectionStateChange]] — resource-owned database session state transitions. Not present in public 0.1.3.		* [[onDatabaseConnectionStateChange]] — resource-owned database session state transitions. Not present in public 0.1.3.

	<!-- weapon-mouse014:start -->		<!-- weapon-mouse014:start -->
	== Weapon and mouse events (0.1.4~~, in development~~) ==		== Weapon and mouse events (0.1.4) ==
	* Server: [[onPlayerWeaponChangeResult]].		* Server: [[onPlayerWeaponChangeResult]].
	* Client: [[onClientMouseMove]], [[onClientMouseCaptureChanged]], [[onClientCameraStreamError]].		* Client: [[onClientMouseMove]], [[onClientMouseCaptureChanged]], [[onClientCameraStreamError]].
Line 285:		Line 285:

	<!-- map-editor014:start -->		<!-- map-editor014:start -->
	== World object events (since 0.1.4~~, in development~~) ==		== World object events (since 0.1.4) ==
	* [[onClientWorldObjectResult]]: asynchronous command completion, including trace JSON and errors.		* [[onClientWorldObjectResult]]: asynchronous command completion, including trace JSON and errors.
	* [[onClientWorldObjectsReset]]: resource-owned scene invalidation after world/session reset.		* [[onClientWorldObjectsReset]]: resource-owned scene invalidation after world/session reset.
	See [[World objects]] and [[Map scene deployment]].		See [[World objects]] and [[Map scene deployment]].
	<!-- map-editor014:end -->		<!-- map-editor014:end -->
			== Authenticated event origin (since 0.1.4) ==
			See [[getEventClient]] for the authenticated initiating player, eventOrigin/sourceResource behavior, synchronous forwarding and asynchronous limitations. Client-provided resource names are not trusted server origins.

QCherry: Document Map Editor, saved maps, static scene deployment and Lua APIs since 0.1.4

2026-09-20T18:19:22Z

Document Map Editor, saved maps, static scene deployment and Lua APIs since 0.1.4

← Older revision		Revision as of 18:19, 20 September 2026
Line 283:		Line 283:
	* Client: [[onClientMouseMove]], [[onClientMouseCaptureChanged]], [[onClientCameraStreamError]].		* Client: [[onClientMouseMove]], [[onClientMouseCaptureChanged]], [[onClientCameraStreamError]].
	<!-- weapon-mouse014:end -->		<!-- weapon-mouse014:end -->

			<!-- map-editor014:start -->
			== World object events (since 0.1.4, in development) ==
			* [[onClientWorldObjectResult]]: asynchronous command completion, including trace JSON and errors.
			* [[onClientWorldObjectsReset]]: resource-owned scene invalidation after world/session reset.
			See [[World objects]] and [[Map scene deployment]].
			<!-- map-editor014:end -->

QCherry: Document upcoming 0.1.4 weapon confirmation and mouse camera APIs

2026-09-19T13:53:56Z

Document upcoming 0.1.4 weapon confirmation and mouse camera APIs

← Older revision		Revision as of 13:53, 19 September 2026
Line 277:		Line 277:
	== Database recovery (since 0.1.4, in development) ==		== Database recovery (since 0.1.4, in development) ==
	* [[onDatabaseConnectionStateChange]] — resource-owned database session state transitions. Not present in public 0.1.3.		* [[onDatabaseConnectionStateChange]] — resource-owned database session state transitions. Not present in public 0.1.3.

			<!-- weapon-mouse014:start -->
			== Weapon and mouse events (0.1.4, in development) ==
			* Server: [[onPlayerWeaponChangeResult]].
			* Client: [[onClientMouseMove]], [[onClientMouseCaptureChanged]], [[onClientCameraStreamError]].
			<!-- weapon-mouse014:end -->

QCherry: Document upcoming 0.1.4 database recovery; organize wiki navigation

2026-09-19T10:51:58Z

Document upcoming 0.1.4 database recovery; organize wiki navigation

← Older revision		Revision as of 10:51, 19 September 2026
Line 275:		Line 275:

	[[Category:Lua Events]]		[[Category:Lua Events]]
			== Database recovery (since 0.1.4, in development) ==
			* [[onDatabaseConnectionStateChange]] — resource-owned database session state transitions. Not present in public 0.1.3.

QCherry: Document scripted camera API and events available from G1R:MP 0.1.3

2026-09-08T23:51:08Z

Document scripted camera API and events available from G1R:MP 0.1.3

← Older revision		Revision as of 23:51, 8 September 2026
Line 12:		Line 12:
	Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.		Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.

	The current reference documents '''92 Lua events'''. Red badges identify the update in which an event became available or received a materially improved compatibility contract.		The current reference documents '''94 Lua events'''. Red badges identify the update in which an event became available or received a materially improved compatibility contract.

	== Resource events ==		== Resource events ==
Line 262:		Line 262:
	\| [[onClientGuiSubmit]] \|\| client-side \|\| Triggered when a resource-owned RmlUi form or input is submitted.		\| [[onClientGuiSubmit]] \|\| client-side \|\| Triggered when a resource-owned RmlUi form or input is submitted.
	\|}		\|}

			== Camera events ==
			{\| class="wikitable" style="width:100%;"
			! Event !! Side !! Description
			\|-
			\| [[onClientCameraCommandResult]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.3)</span> \|\| client-side \|\| Reports a matching camera request's progress, completion, state, reset, error or cancellation to the owning resource.
			\|-
			\| [[onClientCameraReset]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.3)</span> \|\| client-side \|\| Reports forced camera ownership/cache invalidation; discard pending cinematic work and wait for world readiness.
			\|}

			See [[Scripted camera]] for request IDs, cache timing and lifecycle-safe login backgrounds.

	[[Category:Lua Events]]		[[Category:Lua Events]]

QCherry: Add stable consumable callbacks available since 0.1.3

2026-09-08T14:06:42Z

Add stable consumable callbacks available since 0.1.3

← Older revision		Revision as of 14:06, 8 September 2026
Line 12:		Line 12:
	Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.		Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.

	The current reference documents '''~~88 public~~ events'''. Red badges identify ~~'''8 events~~ available ~~since update 0.1.2''' and '''4 events~~ improved ~~since update 0.1.2'''~~.		The current reference documents '''92 Lua events'''. Red badges identify the update in which an event became available or received a materially improved compatibility contract.

	== Resource events ==		== Resource events ==
Line 108:		Line 108:
	! Event !! Side !! Description		! Event !! Side !! Description
	\|-		\|-
	\| [[~~onPlayerConsumableUse~~]] \|\| server-side \|\| Triggered after the server ~~accepts or rejects~~ a consumable-~~use request~~.		\| [[onPlayerConsumableCommitRequested]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.3)</span> \|\| server-side \|\| Triggered after an authoritative consumable use passes validation and reserves one item, requesting durable stage-one inventory persistence.
			\|-
			\| [[onPlayerConsumableDetachedSnapshot]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.3)</span> \|\| server-side \|\| Triggered during disconnect when a consumable operation is still awaiting its durable inventory result, providing both rollback and success snapshots for detached recovery.
			\|-
			\| [[onPlayerConsumableDurablySettled]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.3)</span> \|\| server-side \|\| Triggered for a connected player after the consumable inventory removal and final authoritative progression snapshot are both durably committed.
			\|-
			\| [[onPlayerConsumableEffectTick]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.3)</span> \|\| server-side \|\| Triggered after a periodic consumable tick successfully changes authoritative health or mana.
			\|-
			\| [[onPlayerConsumableFinalizeRequested]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.3)</span> \|\| server-side \|\| Triggered after the inventory removal is durable and the server has applied the authoritative instant effect, requesting persistence of the final settlement snapshot.
	\|-		\|-
	\| [[onPlayerSpellCastCancel]] \|\| server-side \|\| Triggered when an active spell cast is cancelled.		\| [[onPlayerSpellCastCancel]] \|\| server-side \|\| Triggered when an active spell cast is cancelled.

QCherry: Update G1R:MP 0.1.2 API documentation

2026-09-03T18:41:43Z

Update G1R:MP 0.1.2 API documentation

← Older revision		Revision as of 18:41, 3 September 2026
Line 12:		Line 12:
	Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.		Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.

	The current reference documents '''80 public events''' ~~plus~~ '''1 ~~event planned for~~ update 0.1.2'''.		The current reference documents '''88 public events'''. Red badges identify '''8 events available since update 0.1.2''' and '''4 events improved since update 0.1.2'''.

	== Resource events ==		== Resource events ==
Line 39:		Line 39:
	\| [[onPlayerHeadChange]] \|\| server-side \|\| Triggered after a validated independent Nameless Hero head option has changed.		\| [[onPlayerHeadChange]] \|\| server-side \|\| Triggered after a validated independent Nameless Hero head option has changed.
	\|-		\|-
	\| [[onPlayerJoin]] \|\| server-side \|\| Triggered after a client has ~~joined the server and~~ received its authoritative player ID.		\| [[onPlayerJoin]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(improved since 0.1.2)</span> \|\| server-side \|\| Triggered after a client is authenticated and has received its authoritative player ID.
	\|-		\|-
	\| [[onPlayerNameChange]] \|\| server-side \|\| Triggered after an authoritative player name change has been accepted.		\| [[onPlayerNameChange]] \|\| server-side \|\| Triggered after an authoritative player name change has been accepted.
Line 45:		Line 45:
	\| [[onPlayerNameplateChange]] \|\| server-side \|\| Triggered after a player's authoritative overhead nameplate text or visibility changes.		\| [[onPlayerNameplateChange]] \|\| server-side \|\| Triggered after a player's authoritative overhead nameplate text or visibility changes.
	\|-		\|-
	\| [[onPlayerQuit]] \|\| server-side \|\| Triggered ~~when a~~ player ~~disconnects or~~ is ~~removed from the server~~.		\| [[onPlayerQuit]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(improved since 0.1.2)</span> \|\| server-side \|\| Triggered synchronously while an authenticated player's disconnect is being finalized.
	\|-		\|-
	\| [[onPlayerSkinChange]] \|\| server-side \|\| Triggered after a validated authoritative player appearance preset has changed.		\| [[onPlayerSkinChange]] \|\| server-side \|\| Triggered after a validated authoritative player appearance preset has changed.
Line 177:		Line 177:
	\| [[onWeatherChange]] \|\| server-side \|\| Triggered after the server accepts an authoritative weather transition.		\| [[onWeatherChange]] \|\| server-side \|\| Triggered after the server accepts an authoritative weather transition.
	\|-		\|-
	\| [[~~onWorldItemPickup~~]] \|\| server-side \|\| Triggered after ~~the server validates~~ a ~~synchronized~~ world-item ~~pickup~~.		\| [[onWorldItemDrop]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered for public server resources after a player-initiated world-item drop is durably committed and published.
	\|-		\|-
	\| [[~~onWorldItemSpawn~~]] \|\| server-side \|\| Triggered ~~when~~ the server creates a synchronized ~~pickup~~ item ~~in the world~~.		\| [[onWorldItemPickup]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(improved since 0.1.2)</span> \|\| server-side \|\| Triggered after the server accepts a synchronized world-item pickup and applies its authoritative inventory grant.
			\|-
			\| [[onWorldItemSpawn]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(improved since 0.1.2)</span> \|\| server-side \|\| Triggered after <code>spawnItem</code> or <code>spawnTestItem</code> creates and publishes a synchronized world item.
	\|-		\|-
	\| [[onWorldObjectStateChange]] \|\| server-side \|\| Triggered when a synchronized usable world object changes state.		\| [[onWorldObjectStateChange]] \|\| server-side \|\| Triggered when a synchronized usable world object changes state.
Line 195:		Line 197:
	\|-		\|-
	\| [[onMonsterDestroy]] \|\| server-side \|\| Triggered after a synchronized monster is removed from the server world.		\| [[onMonsterDestroy]] \|\| server-side \|\| Triggered after a synchronized monster is removed from the server world.
			\|-
			\| [[onMonsterIdVisibilityChange]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered after a resource shows or hides the numeric identifier in a monster's nameplate.
			\|-
			\| [[onMonsterMoveBlocked]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered once when a resource-owned monster's direct scripted movement becomes blocked.
			\|-
			\| [[onMonsterMoveComplete]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered once when a resource-owned monster reaches its direct scripted movement goal.
			\|-
			\| [[onMonsterNameChange]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered after a resource changes a monster's validated overhead display name.
	\|-		\|-
	\| [[onMonsterSpawn]] \|\| server-side \|\| Triggered after the server creates a synchronized monster.		\| [[onMonsterSpawn]] \|\| server-side \|\| Triggered after the server creates a synchronized monster.
Line 211:		Line 221:
	\| [[onNpcEquipmentChange]] \|\| server-side \|\| Triggered after a scripted NPC's equipped weapon changes.		\| [[onNpcEquipmentChange]] \|\| server-side \|\| Triggered after a scripted NPC's equipped weapon changes.
	\|-		\|-
	\| [[onNpcIdVisibilityChange]] <span style="color:#c62828; font-weight:bold;">(~~coming in update~~ 0.1.2)</span> \|\| server-side \|\| Triggered after a resource shows or hides the numeric identifier in a scripted NPC's nameplate.		\| [[onNpcIdVisibilityChange]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered after a resource shows or hides the numeric identifier in a scripted NPC's nameplate.
			\|-
			\| [[onNpcMoveBlocked]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered once when a resource-owned NPC's direct scripted movement becomes blocked.
			\|-
			\| [[onNpcMoveComplete]] <span style="color:#000; background:#ffcdd2; border:1px solid #c62828; font-weight:bold; padding:0.08em 0.35em; border-radius:0.2em;">(available since 0.1.2)</span> \|\| server-side \|\| Triggered once when a resource-owned NPC reaches its direct scripted movement goal.
	\|-		\|-
	\| [[onNpcNameChange]] \|\| server-side \|\| Triggered after a resource changes a scripted NPC's validated display name.		\| [[onNpcNameChange]] \|\| server-side \|\| Triggered after a resource changes a scripted NPC's validated display name.

QCherry: List the NPC ID visibility event planned for G1R:MP update 0.1.2

2026-09-02T17:33:16Z

List the NPC ID visibility event planned for G1R:MP update 0.1.2

← Older revision		Revision as of 17:33, 2 September 2026
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	= Lua events =		= Lua events =
	Lua events notify resources about authoritative gameplay, world, networking, and client UI changes. The catalog below ~~is generated from~~ event names and argument lists verified against the current runtime.		Lua events notify resources about authoritative gameplay, world, networking, and client UI changes. The catalog below lists event names and argument lists verified against the current runtime.

	== Handling an event ==		== Handling an event ==
Line 12:		Line 12:
	Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.		Use <code>root</code> for global runtime events and <code>resourceRoot</code> for events owned by the current resource. Each event page specifies its execution side, exact callback signature, parameters, and delivery rules.

	The current reference documents '''80 public events'''.		The current reference documents '''80 public events''' plus '''1 event planned for update 0.1.2'''.

	== Resource events ==		== Resource events ==
Line 210:		Line 210:
	\|-		\|-
	\| [[onNpcEquipmentChange]] \|\| server-side \|\| Triggered after a scripted NPC's equipped weapon changes.		\| [[onNpcEquipmentChange]] \|\| server-side \|\| Triggered after a scripted NPC's equipped weapon changes.
			\|-
			\| [[onNpcIdVisibilityChange]] <span style="color:#c62828; font-weight:bold;">(coming in update 0.1.2)</span> \|\| server-side \|\| Triggered after a resource shows or hides the numeric identifier in a scripted NPC's nameplate.
	\|-		\|-
	\| [[onNpcNameChange]] \|\| server-side \|\| Triggered after a resource changes a scripted NPC's validated display name.		\| [[onNpcNameChange]] \|\| server-side \|\| Triggered after a resource changes a scripted NPC's validated display name.