Skip to main content

AssetDefinitionProperties

Base properties of extended items derived from their respective Asset definition.

Those are the properties the main game code enforces.

Hierarchy

AssetDefinitionProperties
- ItemProperties

Properties

optionalAllowActivePose

AllowActivePose?: AssetPoseName[]

A list of poses

@see: Asset.AllowActivePose

optionalAllowActivity

AllowActivity?: ActivityName[]

A list of allowed activities

@see: Asset.AllowActivity

optionalAllowActivityOn

AllowActivityOn?: AssetGroupName[]

A list of groups allowed activities

@see: Asset.AllowActivityOn

optionalAllowPose

AllowPose?: never

A list of allowed poses

@see

Asset.AllowPose

@deprecated

Was never actually functional

optionalAttribute

Attribute?: AssetAttribute[]

???

@see: Asset.Attribute

optionalBlock

Block?: AssetGroupItemName[]

The groups that this item blocks

@see: Asset.Block

optionalCustomBlindBackground

CustomBlindBackground?: string

A custom background for this option that overrides the default

@see: Asset.CustomBlindBackground

optionalDefaultColor

DefaultColor?: ItemColor

The default color of the item. Used by extended items that need one of their layers to have a different per-type default color FIXME: That should be hoisted in the extended config, since it's set by the definition and Item.Color should be the actual colors used

@see: Asset.DefaultColor

optionalDifficulty

Difficulty?: number

The difficulty of the item

@see: Asset.Difficulty

optionalEffect

Effect?: EffectName[]

Effects that are applied by this item

@see: Asset.Effect

optionalFetish

Fetish?: FetishName[]

A list of fetishes affected by the item

@see: Asset.Fetish

optionalFreezeActivePose

FreezeActivePose?: never

A list of poses that should be frozen

@see: Asset.FreezeActivePose
@deprecated: Use ItemProperties.AllowActivePose instead

optionalHeightModifier

HeightModifier?: number

How much the character should be moved up

@see: Asset.HeightModifier

optionalHide

Hide?: AssetGroupName[]

Items groups that should be hidden by this item

@see: Asset.Hide

optionalHideItem

HideItem?: string[]

Items that should be hidden by this item

@see: Asset.HideItem

optionalHideItemExclude

HideItemExclude?: string[]

Items that should not be hidden by this item

@see: Asset.HideItemExclude

optionalOpacity

Opacity?: number | number[]

The asset's draw opacity

@see: Asset.Opacity

optionalOverrideHeight

OverrideHeight?: AssetOverrideHeight

Override the height of the item

@see: Asset.OverrideHeight

optionalOverridePriority

OverridePriority?: AssetLayerOverridePriority

The drawing priority of the item

@see: Asset.OverridePriority

optionalRemoveTimer

RemoveTimer?: number

The timer for after how long until a lock should be removed.

@see: Asset.RemoveTimer

optionalSelfUnlock

SelfUnlock?: boolean

Whether an item can be unlocked by the player even if they're restrained

@see: Asset.SelfUnlock

optionalSetPose

SetPose?: AssetPoseName[]

A list of poses that should forcefully be set

@see: Asset.SetPose

optionalTint

Tint?: TintDefinition[]

A list of custom tints

@see: Asset.Tint

optionalWhitelistActivePose

WhitelistActivePose?: never

A list of poses

@see: Asset.WhitelistActivePose
@deprecated: Use ItemProperties.AllowActivePose instead