GetItemStatDefinitions: Difference between revisions
Jump to navigation
Jump to search
Document planned 0.1.9 item stats, armor, runes and experimental map-editor seats/lights; not a release |
Release 0.1.9 / BUILD264 / Protocol42: availability and download setup; preserve experimental limits |
||
| Line 2: | Line 2: | ||
<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="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.9</div> | <div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.9</div> | ||
<div style="color:#111111; margin-top:0.25rem;"> | <div style="color:#111111; margin-top:0.25rem;">Available from 0.1.9. See the scope and validation notes below.</div> | ||
</div> | </div> | ||
| Line 33: | Line 33: | ||
== Notes == | == Notes == | ||
* | * Available from G1R:MP 0.1.9. This documents the implemented API and its current limits. See [[Item type stats]] for scope and remaining in-game validation. | ||
* Server-side only. Profiles affect every copy of the same type on this server, across dimensions; not individual item instances. | * Server-side only. Profiles affect every copy of the same type on this server, across dimensions; not individual item instances. | ||
* Use matching supported client and server builds. Server acceptance and a client application report do not prove the native gameplay effect. | * Use matching supported client and server builds. Server acceptance and a client application report do not prove the native gameplay effect. | ||
Latest revision as of 13:27, 20 October 2026
getItemStatDefinitions
AVAILABLE FROM UPDATE 0.1.9
Available from 0.1.9. See the scope and validation notes below.
Describes which properties a type accepts and how to validate them.
Syntax
definitions = getItemStatDefinitions(item)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
item |
string |
yes | Known canonical item key or recognized alias; this is not an inventory-instance ID. |
Returns
nil for an unknown type; otherwise a map keyed by applicable property name. Each row contains writable, reason, minimum, maximum, integer, defaultKnown and nativeDefaultKnown. reason is empty for writable fields. A field outside the item family may be absent entirely.
Examples
local defs = getItemStatDefinitions("mercenary")
local field = defs and defs.resistanceEdge
if field and field.writable then
local ok, why = setItemStats("mercenary", {resistanceEdge=80})
assert(ok, why)
end
Notes
- Available from G1R:MP 0.1.9. This documents the implemented API and its current limits. See Item type stats for scope and remaining in-game validation.
- Server-side only. Profiles affect every copy of the same type on this server, across dimensions; not individual item instances.
- Use matching supported client and server builds. Server acceptance and a client application report do not prove the native gameplay effect.
- writable describes the implemented capability, not proof of a successful in-game effect or refreshed native tooltip.