Skip to content

Commit

Permalink
Add field type migration to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Procyonae committed Jun 12, 2024
1 parent e36ac14 commit 8e071e1
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions doc/OBSOLETION_AND_MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,40 @@ Move multiple ids that don't need to be unique any more to a single id
}
```

# Field migration

Field migration replaces the provided id as submaps are loaded. You can use `fd_null` with `to_field` to remove furniture entirely without creating errors.

```json
{
"type": "field_type_migration", // Mandatory. String. Must be "field_type_migration"
"from_field": "t_old_field", // Mandatory. String. Id of the field to replace.
"to_field": "f_new_field", // Mandatory. String. Id of the new field to place.
},
```

## Example

Migrate an id

```json
{
"type": "field_type_migration",
"from_field": "fd_being_migrated_id",
"to_field": "fd_new_id"
}
```

Errorlessly obsolete an id

```json
{
"type": "field_type_migration",
"from_field": "fd_being_obsoleted_id",
"to_field": "fd_null"
}
```

# Overmap terrain migration

Overmap terrain migration replaces the location, if it's not generated, and replaces the entry shown on your map even if it's already generated. If you need the map to be removed without alternative, use `omt_obsolete`
Expand Down

0 comments on commit 8e071e1

Please sign in to comment.