Skip to main content

AssetCommonPropertiesGroupAssetLayer

Properties common to groups, assets and layers

Those properties will be inherited by default from layer, to asset, to group. Defining it will override the parent's value altogether.

Hierarchy

Index

Properties

Properties

optionalAllowColorize

AllowColorize?: boolean = true Set to `true`, the target will be colorized when drawing. Set to `false`, the color will be used as part of the image file name. Mainly useful for inheriting the body color around.

Whether that layer is colorized

optionalAllowPose

AllowPose?: never

The poses that have pose-specific assets.

Used when building the file paths for the asset's layers.

If a pose is absent then the asset corresponding to the default pose will be used in its place. Note that a pose's absence from this list does not prevent its usage.

@deprecated
  • Superceded by PoseMapping

optionalInheritColor

InheritColor?: AssetGroupName

The group the target should inherit its color from.

optionalInheritPoseMappingFields

InheritPoseMappingFields?: boolean = ```ts false ```

Let assets inherit the group's pose mapping on an individual pose by pose basis, rather than inheriting the pose mapping as a whole (i.e. all or nothing).

optionalLeft

Left?: Definition

The left coordinate of the target draw rect or a record with pose-specific left coordinates.

@example
Left: {
    [PoseType.Default]: 100,
    Kneeling: 150,
},

optionalParentGroup

ParentGroup?: Definition

A group identifier that will be used to inherit the body size. Body sizes can be either be used for all poses (by passing a singular group) or on a pose-by-pose basis (via passing an object). In the latter case PoseType.DEFAULT can be used to override the default for all groups when used as key, or to disable inheritance when used as value.

@example
// Inherit from the body sizes `BodyLower` by default, but do not inherit for the `AllFours` pose
ParentGroup: {
    [PoseType.DEFAULT]: "BodyLower",
    AllFours: PoseType.DEFAULT,
},

optionalPoseMapping

PoseMapping?: Partial<Record<AssetPoseName, AssetPoseName | PoseType>>

A record mapping pose names to the actually to-be drawn poses. Special values can be specified, via use of PoseType, for either hiding the asset or using pose-agnostic assets.

Poses that are absent from the mapping (or whose value is set to PoseType.DEFAULT) will use the default pose-agnostic path.

optionalPriority

Priority?: number

The drawing priority of the target

optionalTop

Top?: Definition

The top coordinate of the target draw rect or a record with pose-specific top coordinates.

@example
Top: {
    [PoseType.Default]: 100,
    Kneeling: 150,
},
Page Options