Documentation
Docs/en/reference/script-api/migrations.md
Migration Rules
Generated reference. Do not edit this page directly. Update engine metadata, regenerate
Docs/generated/api.json, then runpython BuildTools/docs_reference.py --write.
A dash in the description column means that the owning source metadata has no documentation comment. Every contract cell identifies an exact source classification, the inventory-pinned scope contract, or an unclassified default; script reachability alone does not make a symbol stable.
| Reference index | Canonical JSON model | Generation contract |
This page contains 28 native metadata migration rules.
Property
| Scope | Previous name | Replacement | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
Item |
Accessory |
Ownership |
migration.Property.Item.Accessory |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:121 | Maps the legacy Item property name Accessory to Ownership during Engine migration lookup |
Item |
BlockLines |
MultihexLines |
migration.Property.Item.BlockLines |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:170 | Maps the legacy Item property name BlockLines to MultihexLines during Engine migration lookup |
Critter |
Cond |
Condition |
migration.Property.Critter.Cond |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:375 | Maps the legacy Critter property name Cond to Condition during Engine migration lookup |
Item |
CritId |
CritterId |
migration.Property.Item.CritId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:135 | Maps the legacy Item property name CritId to CritterId during Engine migration lookup |
Item |
CritSlot |
CritterSlot |
migration.Property.Item.CritSlot |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:140 | Maps the legacy Item property name CritSlot to CritterSlot during Engine migration lookup |
Map |
CurDayTime |
FixedDayTime |
migration.Property.Map.CurDayTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:456 | Maps the legacy Map property name CurDayTime to FixedDayTime during Engine migration lookup |
Map |
DayTime |
DayColorTime |
migration.Property.Map.DayTime |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:461 | Maps the legacy Map property name DayTime to DayColorTime during Engine migration lookup |
Item |
IsColorize |
Colorize |
migration.Property.Item.IsColorize |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:285 | Maps the legacy Item property name IsColorize to Colorize during Engine migration lookup |
Critter |
IsControlledByPlayer |
ControlledByPlayer |
migration.Property.Critter.IsControlledByPlayer |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:349 | Maps the legacy Critter property name IsControlledByPlayer to ControlledByPlayer during Engine migration lookup |
Item |
IsFlat |
DrawFlatten |
migration.Property.Item.IsFlat |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:264 | Maps the legacy Item property name IsFlat to DrawFlatten during Engine migration lookup |
Item |
IsHidden |
Hidden |
migration.Property.Item.IsHidden |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:187 | Maps the legacy Item property name IsHidden to Hidden during Engine migration lookup |
Item |
IsHiddenPicture |
AlwaysHideSprite |
migration.Property.Item.IsHiddenPicture |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:195 | Maps the legacy Item property name IsHiddenPicture to AlwaysHideSprite during Engine migration lookup |
Item |
IsLight |
LightSource |
migration.Property.Item.IsLight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:215 | Maps the legacy Item property name IsLight to LightSource during Engine migration lookup |
Item |
IsLightThru |
LightThru |
migration.Property.Item.IsLightThru |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:210 | Maps the legacy Item property name IsLightThru to LightThru during Engine migration lookup |
Item |
IsNoBlock |
NoBlock |
migration.Property.Item.IsNoBlock |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:200 | Maps the legacy Item property name IsNoBlock to NoBlock during Engine migration lookup |
Critter |
IsNoFlatten |
DeadDrawNoFlatten |
migration.Property.Critter.IsNoFlatten |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:386 | Maps the legacy Critter property name IsNoFlatten to DeadDrawNoFlatten during Engine migration lookup |
Item |
IsNoHighlight |
NoHighlight |
migration.Property.Item.IsNoHighlight |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:272 | Maps the legacy Item property name IsNoHighlight to NoHighlight during Engine migration lookup |
Item |
IsNoLightInfluence |
NoLightInfluence |
migration.Property.Item.IsNoLightInfluence |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:277 | Maps the legacy Item property name IsNoLightInfluence to NoLightInfluence during Engine migration lookup |
Item |
IsShootThru |
ShootThru |
migration.Property.Item.IsShootThru |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:205 | Maps the legacy Item property name IsShootThru to ShootThru during Engine migration lookup |
Item |
IsStatic |
Static |
migration.Property.Item.IsStatic |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:116 | Maps the legacy Item property name IsStatic to Static during Engine migration lookup |
Item |
SceneryScript |
StaticScript |
migration.Property.Item.SceneryScript |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:235 | Maps the legacy Item property name SceneryScript to StaticScript during Engine migration lookup |
Critter |
ScriptId |
InitScript |
migration.Property.Critter.ScriptId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:302 | Maps the legacy Critter property name ScriptId to InitScript during Engine migration lookup |
Item |
ScriptId |
InitScript |
migration.Property.Item.ScriptId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:111 | Maps the legacy Item property name ScriptId to InitScript during Engine migration lookup |
Location |
ScriptId |
InitScript |
migration.Property.Location.ScriptId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:493 | Maps the legacy Location property name ScriptId to InitScript during Engine migration lookup |
Map |
ScriptId |
InitScript |
migration.Property.Map.ScriptId |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:418 | Maps the legacy Map property name ScriptId to InitScript during Engine migration lookup |
Item |
Slot |
CritterSlot |
migration.Property.Item.Slot |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:142 | Maps the legacy Item property name Slot to CritterSlot during Engine migration lookup |
Item |
SubItemIds |
InnerItemIds |
migration.Property.Item.SubItemIds |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/EntityProperties.h:153 | Maps the legacy Item property name SubItemIds to InnerItemIds during Engine migration lookup |
Version
| Scope | Previous name | Replacement | Symbol ID | Contract | Source | Description |
|---|---|---|---|---|---|---|
0 |
0 |
66 |
migration.Version.0.0 |
experimental (scope)since 2022.1.0.wipcontract source: Source/Common/Common.h:47 |
Source/Common/Common.h:50 | Force change of compatability version |