Документация
Docs/ru/reference/prototype-format/properties.md
Встроенные свойства прототипов
Сгенерированный справочник. Не редактируйте напрямую. Обновите
BuildTools/PrototypeFormatInterface.jsonили владеющие метаданные движка, затем запуститеpython BuildTools/docs_prototype_format.py --write.
| Индекс | Синтаксис | Свойства | Валидация | Каноническая JSON-модель | Руководство |
Движок объявляет 4 встроенных типа сущностей HasProtos и 112 их свойств. На этой ревизии из текста прототипов можно загрузить 91 свойства.
Свойство с отметкой нет является virtual или temporary и приводит к ошибке при авторинге на стороне, где оно существует. Server-only ключ пропускается в client/mapper output, а client-only ключ - в server output.
Встроенные типы сущностей
| Стабильный ID | Тип | Секция | Стороны | Доступные для авторинга свойства | Исходник |
|---|---|---|---|---|---|
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
| Свойство | Тип | Авторинг | Стороны | Флаги | Исходник |
|---|---|---|---|---|---|
AttachMaster |
ident |
нет (temporary) | server, client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
Condition |
CritterCondition |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ControlledByPlayer |
bool |
нет (temporary) | server, client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
CustomHolderEntry |
hstring |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
CustomHolderId |
ident |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
DeadDrawNoFlatten |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Dir |
mdir |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Elevation |
int16 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ExplicitlyPersistent |
bool |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
GlobalMapTripId |
uint32 |
нет (temporary) | server |
CoreProperty |
Source/Common/EntityProperties.h |
Hex |
mpos |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
HexOffset |
ipos16 |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
HideSprite |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
InitScript |
hstring |
да | server |
Mutable, Persistent, ScriptFuncType, =, CritterInit, CoreProperty |
Source/Common/EntityProperties.h |
IsAttached |
bool |
нет (temporary) | server, client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
IsChosen |
bool |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
IsPlayerOffline |
bool |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
ItemIds |
ident[] |
да | server |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LightColor |
ucolor |
нет (temporary) | client, mapper |
Mutable, CoreProperty |
Source/Common/EntityProperties.h |
LightDistance |
int16 |
нет (temporary) | client, mapper |
Mutable, CoreProperty |
Source/Common/EntityProperties.h |
LightFlags |
uint16 |
нет (temporary) | client, mapper |
Mutable, CoreProperty |
Source/Common/EntityProperties.h |
LightIntensity |
int8 |
нет (temporary) | client, mapper |
Mutable, CoreProperty |
Source/Common/EntityProperties.h |
LightSource |
bool |
нет (temporary) | client, mapper |
Mutable, CoreProperty |
Source/Common/EntityProperties.h |
LookDistance |
int32 |
да | server, client, mapper |
Mutable, OwnerSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
MapId |
ident |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ModelLayers |
int32[] |
нет (temporary) | client, mapper |
Mutable, CoreProperty |
Source/Common/EntityProperties.h |
ModelName |
hstring |
да | server, client, mapper |
Mutable, PublicSync, Persistent, Resource, CoreProperty |
Source/Common/EntityProperties.h |
MovingSpeed |
int32 |
нет (temporary) | server |
CoreProperty |
Source/Common/EntityProperties.h |
Multihex |
int32 |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
NameOffset |
int16 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ScaleFactor |
int32 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ShowCritterDist1 |
int32 |
да | server |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ShowCritterDist2 |
int32 |
да | server |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ShowCritterDist3 |
int32 |
да | server |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
VisibilityMode |
CritterVisibilityMode |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
Свойства Item
| Свойство | Тип | Авторинг | Стороны | Флаги | Исходник |
|---|---|---|---|---|---|
AlwaysHideSprite |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Colorize |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ColorizeColor |
ucolor |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ContainerId |
ident |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ContainerStack |
any |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Corner |
CornerType |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
CritterId |
ident |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
CritterSlot |
CritterItemSlot |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
CustomHolderEntry |
hstring |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
CustomHolderId |
ident |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
DisableEgg |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
DrawFlatten |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
DrawMultihexLines |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
DrawMultihexMesh |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
DrawOrderSubLayer |
int8 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Elevation |
int16 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ExplicitlyPersistent |
bool |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
Hex |
mpos |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Hidden |
bool |
да | server |
Mutable, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
HideSprite |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
InitScript |
hstring |
да | server |
Mutable, Persistent, ScriptFuncType, =, ItemInit, CoreProperty |
Source/Common/EntityProperties.h |
InnerItemIds |
ident[] |
да | server |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
IsGag |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
IsRoofTile |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
IsScenery |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
IsTile |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
IsTrigger |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
IsWall |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LightColor |
ucolor |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LightDistance |
int16 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LightFlags |
uint16 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LightIntensity |
int8 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LightSource |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LightThru |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
MapId |
ident |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
MultihexGeneration |
MultihexGenerationType |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
MultihexLines |
uint8[] |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
MultihexMesh |
mpos[] |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
NoBlock |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
NoHighlight |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
NoLightInfluence |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Offset |
ipos16 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Ownership |
ItemOwnership |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
PicInv |
hstring |
да | server, client, mapper |
Mutable, PublicSync, Persistent, Resource, CoreProperty |
Source/Common/EntityProperties.h |
PicMap |
hstring |
да | server, client, mapper |
Mutable, PublicSync, Persistent, Resource, CoreProperty |
Source/Common/EntityProperties.h |
ShootThru |
bool |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Static |
bool |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
StaticScript |
hstring |
да | server |
Mutable, Persistent, ScriptFuncType, =, ItemStatic, CoreProperty |
Source/Common/EntityProperties.h |
TileLayer |
uint8 |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
TriggerScript |
hstring |
да | server |
Mutable, Persistent, ScriptFuncType, =, ItemTrigger, CoreProperty |
Source/Common/EntityProperties.h |
Свойства Location
| Свойство | Тип | Авторинг | Стороны | Флаги | Исходник |
|---|---|---|---|---|---|
CustomHolderEntry |
hstring |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
CustomHolderId |
ident |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
ExplicitlyPersistent |
bool |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
InitScript |
hstring |
да | server |
Mutable, Persistent, ScriptFuncType, =, LocationInit, CoreProperty |
Source/Common/EntityProperties.h |
MapIds |
ident[] |
да | server |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
Свойства Map
| Свойство | Тип | Авторинг | Стороны | Флаги | Исходник |
|---|---|---|---|---|---|
CritterIds |
ident[] |
да | server |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
CustomHolderEntry |
hstring |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
CustomHolderId |
ident |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
DayColor |
uint8[] |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
DayColorTime |
int32[] |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ExplicitlyPersistent |
bool |
да | server, client, mapper |
Persistent, CoreProperty, SharedProperty |
Source/Common/Entity.h |
FixedDayTime |
int32 |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
GlobalDayColor |
ucolor |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
GlobalDayLightCapacity |
int32 |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
InitScript |
hstring |
да | server |
Mutable, Persistent, ScriptFuncType, =, MapInit, CoreProperty |
Source/Common/EntityProperties.h |
ItemIds |
ident[] |
да | server |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LocId |
ident |
да | server |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
LocMapIndex |
int32 |
да | server |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
MapDayColor |
ucolor |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
MapDayLightCapacity |
int32 |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
RemovedStaticItemIds |
ident[] |
да | server, client, mapper |
Mutable, PublicSync, Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ScrollAxialArea |
irect |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
ScrollOffset |
ipos |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
Size |
msize |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |
SpritesZoom |
float32 |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
SpritesZoomTarget |
float32 |
нет (temporary) | client, mapper |
CoreProperty |
Source/Common/EntityProperties.h |
WorkHex |
mpos |
да | server, client, mapper |
Persistent, CoreProperty |
Source/Common/EntityProperties.h |