FOnline Engine
Current master GitHub
Documentation Docs/en/reference/prototype-format/properties.md

Built-in Prototype Properties

Generated reference. Do not edit directly. Update BuildTools/PrototypeFormatInterface.json or the owning engine metadata, then run python BuildTools/docs_prototype_format.py --write.

Index Syntax Properties Validation Canonical JSON Authoring guide

The engine declares 4 built-in HasProtos entity types and 112 properties for them. 91 properties can be loaded from prototype text at this revision.

A property marked no is virtual or temporary and fails when authored on a side where it exists. A server-only key is skipped in client/mapper output, and a client-only key is skipped in server output.

Built-in entity types

Stable ID Type Section Sides Authorable properties Source
prototype-format.entity.Critter Critter [ProtoCritter] server, client, mapper 21 Source/Common/Entity.h
prototype-format.entity.Item Item [ProtoItem] server, client, mapper 50 Source/Common/Entity.h
prototype-format.entity.Location Location [ProtoLocation] server, client, mapper 5 Source/Common/Entity.h
prototype-format.entity.Map Map [ProtoMap] server, client, mapper 15 Source/Common/Entity.h

Critter properties

Property Type Authorable Sides Flags Source
AttachMaster ident no (temporary) server, client, mapper CoreProperty Source/Common/EntityProperties.h
Condition CritterCondition yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
ControlledByPlayer bool no (temporary) server, client, mapper CoreProperty Source/Common/EntityProperties.h
CustomHolderEntry hstring yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
CustomHolderId ident yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
DeadDrawNoFlatten bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
Dir mdir yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
Elevation int16 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ExplicitlyPersistent bool yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
GlobalMapTripId uint32 no (temporary) server CoreProperty Source/Common/EntityProperties.h
Hex mpos yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
HexOffset ipos16 yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
HideSprite bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
InitScript hstring yes server Mutable, Persistent, ScriptFuncType, =, CritterInit, CoreProperty Source/Common/EntityProperties.h
IsAttached bool no (temporary) server, client, mapper CoreProperty Source/Common/EntityProperties.h
IsChosen bool no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
IsPlayerOffline bool no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
ItemIds ident[] yes server Persistent, CoreProperty Source/Common/EntityProperties.h
LightColor ucolor no (temporary) client, mapper Mutable, CoreProperty Source/Common/EntityProperties.h
LightDistance int16 no (temporary) client, mapper Mutable, CoreProperty Source/Common/EntityProperties.h
LightFlags uint16 no (temporary) client, mapper Mutable, CoreProperty Source/Common/EntityProperties.h
LightIntensity int8 no (temporary) client, mapper Mutable, CoreProperty Source/Common/EntityProperties.h
LightSource bool no (temporary) client, mapper Mutable, CoreProperty Source/Common/EntityProperties.h
LookDistance int32 yes server, client, mapper Mutable, OwnerSync, Persistent, CoreProperty Source/Common/EntityProperties.h
MapId ident yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
ModelLayers int32[] no (temporary) client, mapper Mutable, CoreProperty Source/Common/EntityProperties.h
ModelName hstring yes server, client, mapper Mutable, PublicSync, Persistent, Resource, CoreProperty Source/Common/EntityProperties.h
MovingSpeed int32 no (temporary) server CoreProperty Source/Common/EntityProperties.h
Multihex int32 yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
NameOffset int16 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ScaleFactor int32 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ShowCritterDist1 int32 yes server Mutable, Persistent, CoreProperty Source/Common/EntityProperties.h
ShowCritterDist2 int32 yes server Mutable, Persistent, CoreProperty Source/Common/EntityProperties.h
ShowCritterDist3 int32 yes server Mutable, Persistent, CoreProperty Source/Common/EntityProperties.h
VisibilityMode CritterVisibilityMode no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h

Item properties

Property Type Authorable Sides Flags Source
AlwaysHideSprite bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
Colorize bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ColorizeColor ucolor yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ContainerId ident yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
ContainerStack any yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
Corner CornerType yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
CritterId ident yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
CritterSlot CritterItemSlot yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
CustomHolderEntry hstring yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
CustomHolderId ident yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
DisableEgg bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
DrawFlatten bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
DrawMultihexLines bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
DrawMultihexMesh bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
DrawOrderSubLayer int8 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
Elevation int16 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ExplicitlyPersistent bool yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
Hex mpos yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
Hidden bool yes server Mutable, Persistent, CoreProperty Source/Common/EntityProperties.h
HideSprite bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
InitScript hstring yes server Mutable, Persistent, ScriptFuncType, =, ItemInit, CoreProperty Source/Common/EntityProperties.h
InnerItemIds ident[] yes server Persistent, CoreProperty Source/Common/EntityProperties.h
IsGag bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
IsRoofTile bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
IsScenery bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
IsTile bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
IsTrigger bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
IsWall bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
LightColor ucolor yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
LightDistance int16 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
LightFlags uint16 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
LightIntensity int8 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
LightSource bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
LightThru bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
MapId ident yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
MultihexGeneration MultihexGenerationType yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
MultihexLines uint8[] yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
MultihexMesh mpos[] yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
NoBlock bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
NoHighlight bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
NoLightInfluence bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
Offset ipos16 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
Ownership ItemOwnership yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
PicInv hstring yes server, client, mapper Mutable, PublicSync, Persistent, Resource, CoreProperty Source/Common/EntityProperties.h
PicMap hstring yes server, client, mapper Mutable, PublicSync, Persistent, Resource, CoreProperty Source/Common/EntityProperties.h
ShootThru bool yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
Static bool yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
StaticScript hstring yes server Mutable, Persistent, ScriptFuncType, =, ItemStatic, CoreProperty Source/Common/EntityProperties.h
TileLayer uint8 yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
TriggerScript hstring yes server Mutable, Persistent, ScriptFuncType, =, ItemTrigger, CoreProperty Source/Common/EntityProperties.h

Location properties

Property Type Authorable Sides Flags Source
CustomHolderEntry hstring yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
CustomHolderId ident yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
ExplicitlyPersistent bool yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
InitScript hstring yes server Mutable, Persistent, ScriptFuncType, =, LocationInit, CoreProperty Source/Common/EntityProperties.h
MapIds ident[] yes server Persistent, CoreProperty Source/Common/EntityProperties.h

Map properties

Property Type Authorable Sides Flags Source
CritterIds ident[] yes server Persistent, CoreProperty Source/Common/EntityProperties.h
CustomHolderEntry hstring yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
CustomHolderId ident yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
DayColor uint8[] yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
DayColorTime int32[] yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ExplicitlyPersistent bool yes server, client, mapper Persistent, CoreProperty, SharedProperty Source/Common/Entity.h
FixedDayTime int32 yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
GlobalDayColor ucolor no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
GlobalDayLightCapacity int32 no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
InitScript hstring yes server Mutable, Persistent, ScriptFuncType, =, MapInit, CoreProperty Source/Common/EntityProperties.h
ItemIds ident[] yes server Persistent, CoreProperty Source/Common/EntityProperties.h
LocId ident yes server Persistent, CoreProperty Source/Common/EntityProperties.h
LocMapIndex int32 yes server Persistent, CoreProperty Source/Common/EntityProperties.h
MapDayColor ucolor no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
MapDayLightCapacity int32 no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
RemovedStaticItemIds ident[] yes server, client, mapper Mutable, PublicSync, Persistent, CoreProperty Source/Common/EntityProperties.h
ScrollAxialArea irect yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
ScrollOffset ipos no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
Size msize yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
SpritesZoom float32 no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
SpritesZoomTarget float32 no (temporary) client, mapper CoreProperty Source/Common/EntityProperties.h
WorkHex mpos yes server, client, mapper Persistent, CoreProperty Source/Common/EntityProperties.h
Start typing to search.