Repository navigation
reference api enemy rig reference
cheaterbob edited this page Oct 3, 2026
·
1 revision
Generated from
enemy-rig-reference.schema.json. Runtime validation remains authoritative for cross-file and engine-dependent rules.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
schemaVersion |
const: 1
|
yes | stable | |
type |
const: enemyRigReference
|
yes | stable | |
id |
string | yes | stable | pattern: ^core:enemy-rig/[a-z0-9][a-z0-9._/-]*$
|
enemy |
string | yes | stable | pattern: ^core:enemy/[a-z0-9][a-z0-9._/-]*$
|
prefab |
string | yes | stable | min length: 1
|
controller |
string null | no | stable | |
sampleRoot |
string | yes | stable | |
bones |
array of ref: bone
|
yes | stable | min items: 1; max items: 512
|
warnings |
array of string | yes | stable |
Schema form: object.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
x |
number | yes | ||
y |
number | yes | ||
z |
number | yes | ||
rotationX |
number | yes | ||
rotationY |
number | yes | ||
rotationZ |
number | yes | ||
scaleX |
number | yes | ||
scaleY |
number | yes | ||
scaleZ |
number | yes |
Schema form: object.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
unityPath |
string | yes | ||
name |
string null | no | ||
asset |
string null | no | ||
pivotX |
number | yes | ||
pivotY |
number | yes | ||
width |
number | yes | min: 0
|
|
height |
number | yes | min: 0
|
|
sortingLayer |
string | yes | ||
sortingOrder |
integer | yes | min: -32768; max: 32767
|
Schema form: object.
| Field | Type | Required | Stability | Constraints and meaning |
|---|---|---|---|---|
name |
string | yes | pattern: ^[a-z0-9][a-z0-9-]*$
|
|
parent |
string null | no | pattern: ^[a-z0-9][a-z0-9-]*$
|
|
unityPath |
string | yes | ||
unityPaths |
array of string | yes | min items: 1; unique items |
|
defaultTransform |
ref: transform
|
yes | ||
sprites |
array of ref: sprite
|
yes |
Published from Docs/Modding/Public. The repository documentation is the canonical source.
Captivity Reloaded wiki* Captivity Reloaded Wiki
- Getting started
- Core concepts
- Content types
- Authoring tools
-
Reference
- Example pack index
- Schema index
- Field-by-field API reference
- Public asset-slot catalog
- Core enemy asset slots
- Validation and errors
- Validation/error-code catalog
- Mod API changelog
- Migration guides
- Troubleshooting
- Glossary
- Defaults and compatibility
- Resource limits
- Mod-author test matrix
- Implementation status
- Mod API v1 release checklist
- Release verification runbook
- Release evidence template
- Licensing and redistribution
- Development