QCherry: Complete Lua function catalog

2026-08-15T09:55:45Z

Complete Lua function catalog

← Older revision		Revision as of 09:55, 15 August 2026
Line 37:		Line 37:
	* The identifier must refer to an object known to the replicated world-object system.		* The identifier must refer to an object known to the replicated world-object system.

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

QCherry: Update Lua API reference

2026-08-15T09:49:04Z

Update Lua API reference

New page

= setWorldObjectState =
Sets the authoritative replicated state of a known usable world object.

== Syntax ==
<syntaxhighlight lang="lua">
bool setWorldObjectState(string objectId, string objectType, bool lit, bool usable [, int serverTime = 0])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>objectId</code> || <code>string</code> || yes || The opaque decimal world-object identifier.
|-
| <code>objectType</code> || <code>string</code> || yes || One of <code>campfire</code>, <code>torch</code>, <code>bed</code>, or <code>usable</code>.
|-
| <code>lit</code> || <code>bool</code> || yes || Whether a fire-capable object is lit.
|-
| <code>usable</code> || <code>bool</code> || yes || Whether players may currently use the object.
|-
| <code>serverTime</code> || <code>int</code> || no || Optional non-negative authoritative timestamp in milliseconds; 0 uses the server's current time.
|}

== Returns ==
Returns <code>true</code> when the state is accepted and replicated; otherwise returns <code>false</code>.

== Examples ==
Light a synchronized campfire:
<syntaxhighlight lang="lua" line>
setWorldObjectState(objectId, "campfire", true, true)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The state is server-authoritative and replayed to late joiners.
* The identifier must refer to an object known to the replicated world-object system.

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

SetWorldObjectState - Revision history

QCherry: Complete Lua function catalog

QCherry: Update Lua API reference