Asset

The internal Asset definition of an asset.

See AssetDefinition in Female3DCG.d.ts for documentation.

Index

Properties

• Activity
• ActivityAudio
• ActivityExpression
• AllowActivePose
• AllowActivity
• AllowActivityOn
• AllowBlock
• AllowColorize
• AllowColorizeAll
• AllowEffect
• AllowExpression
• AllowHide
• AllowHideItem
• AllowLock
• AllowLockType
• AllowRemoveExclusive
• AllowTighten
• AllowTint
• Alpha
• AlwaysExtend
• AlwaysInteract
• Archetype
• ArousalZone
• Attribute
• Audio
• AvailableLocations
• Block
• BodyCosplay
• Bonus
• BuyGroup
• Category
• ColorableLayerCount
• ColorSuffix
• CraftGroup
• CreateLayerTypes
• CreateLayerTypesOverride
• CustomBlindBackground
• DefaultColor
• DefaultTint
• Description
• DialogSortOverride
• Difficulty
• DrawingLeft
• DrawingPriority
• DrawingTop
• DrawLocks
• DrawOffset
• DynamicActivity
• DynamicAfterDraw
• DynamicAllowInventoryAdd
• DynamicAudio
• DynamicBeforeDraw
• DynamicDescription
• DynamicGroupName
• DynamicName
• DynamicPreviewImage
• DynamicScriptDraw
• EditOpacity
• Effect
• Enable
• ExclusiveUnlock
• Expose
• ExpressionPrerequisite
• ExpressionTrigger
• Extended
• FamilyOnly
• Fetish
• FixedPosition
• FullAlpha
• Gender
• Group
• HeightModifier
• Hide
• HideItem
• HideItemAttribute
• HideItemExclude
• InheritColor
• InventoryID
• IsLock
• IsRestraint
• Layer
• LayerVisibility
• LoverOnly
• MaxOpacity
• MaxTimer
• MinOpacity
• MirrorExpression
• Name
• NeverSell
• NotVisibleOnScreen
• Opacity
• OverrideBlinking
• OverrideHeight
• OwnerOnly
• ParentGroup
• ParentItem
• PickDifficulty
• PoseMapping
• Prerequisite
• PreviewIcons
• Random
• RemoveAtLogin
• RemoveItemOnRemove
• RemoveTime
• RemoveTimer
• Require
• SelfBondage
• SelfUnlock
• SetPose
• StyleOverride
• SupportedStyles
• Tint
• Value
• Visible
• Wear
• WearTime
• ZoomModifier

Properties

readonlyActivity

Activity: ActivityName

optionalreadonlyActivityAudio

ActivityAudio?: readonly string[]

readonlyActivityExpression

ActivityExpression: Readonly<Partial<Record<ActivityName, readonly ExpressionTrigger[]>>>

optionalreadonlyAllowActivePose

AllowActivePose?: readonly AssetPoseName[]

optionalreadonlyAllowActivity

AllowActivity?: readonly ActivityName[]

readonlyAllowActivityOn

AllowActivityOn: readonly AssetGroupItemName[]

optionalreadonlyAllowBlock

AllowBlock?: readonly AssetGroupItemName[]

readonlyAllowColorize

AllowColorize: boolean

optionalreadonlyAllowColorizeAll

AllowColorizeAll?: never

@deprecated

Removed without replacement: items must support a "color all layers" button (to the extent that the item is colorable in the first place)

optionalreadonlyAllowEffect

AllowEffect?: readonly EffectName[]

optionalreadonlyAllowExpression

AllowExpression?: readonly ExpressionName[]

optionalreadonlyAllowHide

AllowHide?: readonly AssetGroupName[]

optionalreadonlyAllowHideItem

AllowHideItem?: readonly string[]

readonlyAllowLock

AllowLock: boolean

readonlyAllowLockType

AllowLockType: Partial<Record<string, Set<number>>>

A record that maps ExtendedItemData.name to a set with all option indices that support locks

readonlyAllowRemoveExclusive

AllowRemoveExclusive: boolean

readonlyAllowTighten

AllowTighten: boolean

readonlyAllowTint

AllowTint: boolean

readonlyAlpha

Alpha: readonly Data[]

readonlyAlwaysExtend

AlwaysExtend: boolean

readonlyAlwaysInteract

AlwaysInteract: boolean

optionalreadonlyArchetype

Archetype?: ExtendedArchetype

readonlyArousalZone

ArousalZone: AssetGroupItemName

readonlyAttribute

Attribute: readonly AssetAttribute[]

optionalreadonlyAudio

Audio?: string

readonlyAvailableLocations

AvailableLocations: readonly string[]

optionalreadonlyBlock

Block?: readonly AssetGroupItemName[]

readonlyBodyCosplay

BodyCosplay: boolean

optionalreadonlyBonus

Bonus?: AssetBonusName

optionalreadonlyBuyGroup

BuyGroup?: string

optionalreadonlyCategory

Category?: readonly AssetCategory[]

readonlyColorableLayerCount

ColorableLayerCount: number

The number of colorable layers. Guaranteed to be >= 1

readonlyColorSuffix

ColorSuffix: Readonly<Partial<Record<BCColor | HEX_COLOR, BCColor>>>

readonlyCraftGroup

CraftGroup: string

readonlyCreateLayerTypes

CreateLayerTypes: readonly string[]

A list of TypeRecord keys for which a single layer expects multiple type-specific .png files.

optionalreadonlyCreateLayerTypesOverride

CreateLayerTypesOverride?: number[]

optionalreadonlyCustomBlindBackground

CustomBlindBackground?: string

readonlyDefaultColor

DefaultColor: readonly BCColor[]

The default color of the item: an array of length Asset.ColorableLayerCount consisting of AssetGroup.DefaultColor and/or valid color hex codes.

optionalreadonlyDefaultTint

DefaultTint?: BCColor

readonlyDescription

Description: string

optionalreadonlyDialogSortOverride

DialogSortOverride?: DialogSortOrder

readonlyDifficulty

Difficulty: number

readonlyDrawingLeft

DrawingLeft: Readonly<Partial<Record<AssetPoseName, number>> & Record<, number>>

optionalreadonlyDrawingPriority

DrawingPriority?: number

readonlyDrawingTop

DrawingTop: Readonly<Partial<Record<AssetPoseName, number>> & Record<, number>>

readonlyDrawLocks

DrawLocks: boolean

optionalreadonlyDrawOffset

DrawOffset?: { Asset?: string; Group?: AssetGroupName; Layer?: string[]; X?: number; Y?: number }[]

readonlyDynamicActivity

DynamicActivity: (C) => ActivityName

Type declaration

• • (C): ActivityName

  • Parameters

    • C: Character

    Returns ActivityName

readonlyDynamicAfterDraw

DynamicAfterDraw: boolean

readonlyDynamicAllowInventoryAdd

DynamicAllowInventoryAdd: (C) => boolean

Type declaration

• • (C): boolean

  • Parameters

    • C: Character

    Returns boolean

readonlyDynamicAudio

DynamicAudio: (C) => string

Type declaration

• • (C): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicBeforeDraw

DynamicBeforeDraw: boolean

readonlyDynamicDescription

DynamicDescription: (C) => string

Type declaration

• • (C): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicGroupName

DynamicGroupName: AssetGroupName

readonlyDynamicName

DynamicName: (C) => string

Type declaration

• • (C): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicPreviewImage

DynamicPreviewImage: (C) => string

Type declaration

• • (C): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicScriptDraw

DynamicScriptDraw: boolean

readonlyEditOpacity

EditOpacity: boolean

readonlyEffect

Effect: readonly EffectName[]

readonlyEnable

Enable: boolean

readonlyExclusiveUnlock

ExclusiveUnlock: boolean

readonlyExpose

Expose: readonly AssetGroupItemName[]

optionalreadonlyExpressionPrerequisite

ExpressionPrerequisite?: readonly AssetPrerequisite[]

optionalreadonlyExpressionTrigger

ExpressionTrigger?: readonly ExpressionTrigger[]

readonlyExtended

Extended: boolean

readonlyFamilyOnly

FamilyOnly: boolean

optionalreadonlyFetish

Fetish?: readonly FetishName[]

readonlyFixedPosition

FixedPosition: boolean

readonlyFullAlpha

FullAlpha: boolean

optionalreadonlyGender

Gender?: AssetGender

readonlyGroup

Group: AssetGroup

readonlyHeightModifier

HeightModifier: number

optionalreadonlyHide

Hide?: readonly AssetGroupName[]

optionalreadonlyHideItem

HideItem?: readonly string[]

readonlyHideItemAttribute

HideItemAttribute: readonly AssetAttribute[]

readonlyHideItemExclude

HideItemExclude: readonly string[]

readonlyInheritColor

InheritColor: AssetGroupName

optionalreadonlyInventoryID

InventoryID?: number

readonlyIsLock

IsLock: boolean

readonlyIsRestraint

IsRestraint: boolean

readonlyLayer

Layer: readonly AssetLayer[]

readonlyLayerVisibility

LayerVisibility: boolean

readonlyLoverOnly

LoverOnly: boolean

readonlyMaxOpacity

MaxOpacity: number

readonlyMaxTimer

MaxTimer: number

readonlyMinOpacity

MinOpacity: number

optionalreadonlyMirrorExpression

MirrorExpression?: AssetGroupName

readonlyName

Name: string

readonlyNeverSell

NeverSell: boolean

optionalreadonlyNotVisibleOnScreen

NotVisibleOnScreen?: readonly string[]

readonlyOpacity

Opacity: number

readonlyOverrideBlinking

OverrideBlinking: boolean

optionalreadonlyOverrideHeight

OverrideHeight?: Readonly<AssetOverrideHeight>

readonlyOwnerOnly

OwnerOnly: boolean

readonlyParentGroup

ParentGroup: Partial<Record< | AssetPoseName, | AssetGroupName>>

An object mapping pose names to group names from which to inherit body sizes.

optionalreadonlyParentItem

ParentItem?: string

readonlyPickDifficulty

PickDifficulty: number

readonlyPoseMapping

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

readonlyPrerequisite

Prerequisite: readonly AssetPrerequisite[]

readonlyPreviewIcons

PreviewIcons: readonly InventoryIcon[]

readonlyRandom

Random: boolean

readonlyRemoveAtLogin

RemoveAtLogin: boolean

readonlyRemoveItemOnRemove

RemoveItemOnRemove: readonly { Group: AssetGroupName; Name: string; TypeRecord?: TypeRecord }[]

readonlyRemoveTime

RemoveTime: number

readonlyRemoveTimer

RemoveTimer: number

readonlyRequire

Require: readonly AssetGroupBodyName[]

readonlySelfBondage

SelfBondage: number

readonlySelfUnlock

SelfUnlock: boolean

optionalreadonlySetPose

SetPose?: readonly AssetPoseName[]

optionalreadonlyStyleOverride

StyleOverride?: BodyStyle[]

optionalreadonlySupportedStyles

SupportedStyles?: BodyStyle[]

readonlyTint

Tint: readonly Readonly<TintDefinition>[]

readonlyValue

Value: number

readonlyVisible

Visible: boolean

readonlyWear

Wear: boolean

readonlyWearTime

WearTime: number

readonlyZoomModifier

ZoomModifier: number

The height of the character as set in the special Height appearance group.

Is represented by a number in the [0.9, 1.0] interval.