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
• AllowPose
• AllowRemoveExclusive
• AllowTighten
• AllowTint
• AllowTypes
• Alpha
• AlwaysExtend
• AlwaysInteract
• Archetype
• ArousalZone
• Attribute
• Audio
• AvailableLocations
• Block
• BodyCosplay
• Bonus
• BuyGroup
• Category
• CharacterRestricted
• ColorSuffix
• ColorableLayerCount
• CraftGroup
• CreateLayerTypes
• CustomBlindBackground
• DefaultColor
• DefaultTint
• Description
• DialogSortOverride
• Difficulty
• DrawLocks
• DrawingLeft
• DrawingPriority
• DrawingTop
• DynamicActivity
• DynamicAfterDraw
• DynamicAllowInventoryAdd
• DynamicAudio
• DynamicBeforeDraw
• DynamicDescription
• DynamicGroupName
• DynamicName
• DynamicPreviewImage
• DynamicScriptDraw
• Effect
• Enable
• ExclusiveUnlock
• Expose
• ExpressionPrerequisite
• ExpressionTrigger
• Extended
• FamilyOnly
• Fetish
• FixedPosition
• FreezeActivePose
• FullAlpha
• Gender
• Group
• HasType
• HeightModifier
• Hide
• HideForPose
• HideItem
• HideItemAttribute
• HideItemExclude
• InheritColor
• InventoryID
• IsLock
• IsRestraint
• Layer
• LayerVisibility
• LoverOnly
• MaxOpacity
• MaxTimer
• MinOpacity
• MirrorExpression
• Name
• NeverSell
• NotVisibleOnScreen
• Opacity
• OverrideBlinking
• OverrideHeight
• OwnerOnly
• ParentGroupName
• ParentItem
• PickDifficulty
• PoseMapping
• Prerequisite
• PreviewIcons
• Random
• RemoveAtLogin
• RemoveItemOnRemove
• RemoveTime
• RemoveTimer
• Require
• SelfBondage
• SelfUnlock
• SetPose
• Tint
• Value
• Visible
• Wear
• WearTime
• WhitelistActivePose
• 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[]

optionalreadonlyAllowActivityOn

AllowActivityOn?: readonly AssetGroupItemName[]

optionalreadonlyAllowBlock

AllowBlock?: readonly AssetGroupItemName[]

readonlyAllowColorize

AllowColorize: boolean

readonlyAllowColorizeAll

AllowColorizeAll: boolean

optionalreadonlyAllowEffect

AllowEffect?: readonly EffectName[]

optionalreadonlyAllowExpression

AllowExpression?: readonly ExpressionName[]

optionalreadonlyAllowHide

AllowHide?: readonly AssetGroupName[]

optionalreadonlyAllowHideItem

AllowHideItem?: readonly string[]

readonlyAllowLock

AllowLock: boolean

readonlyAllowLockType

AllowLockType: Record<string, Set<number>>

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

optionalreadonlyAllowPose

AllowPose?: never

@deprecated

• Superceded by Asset.PoseMapping

readonlyAllowRemoveExclusive

AllowRemoveExclusive: boolean

optionalreadonlyAllowTighten

AllowTighten?: boolean

readonlyAllowTint

AllowTint: boolean

optionalreadonlyAllowTypes

AllowTypes?: never

@deprecated

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[]

readonlyCharacterRestricted

CharacterRestricted: boolean

readonlyColorSuffix

ColorSuffix: Readonly<Record<string, string>>

readonlyColorableLayerCount

ColorableLayerCount: number

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

readonlyCraftGroup

CraftGroup: string

readonlyCreateLayerTypes

CreateLayerTypes: readonly string[]

A module for which the layer can have types. Allows one to define different module-specific assets for a single layer.

optionalreadonlyCustomBlindBackground

CustomBlindBackground?: string

readonlyDefaultColor

DefaultColor: readonly string[]

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

optionalreadonlyDefaultTint

DefaultTint?: string

readonlyDescription

Description: string

optionalreadonlyDialogSortOverride

DialogSortOverride?: DialogSortOrder

readonlyDifficulty

Difficulty: number

readonlyDrawLocks

DrawLocks: boolean

readonlyDrawingLeft

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

optionalreadonlyDrawingPriority

DrawingPriority?: number

readonlyDrawingTop

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

readonlyDynamicActivity

DynamicActivity: (C: Character) => ActivityName

Type declaration

• • (C: Character): ActivityName

  • Parameters

    • C: Character

    Returns ActivityName

readonlyDynamicAfterDraw

DynamicAfterDraw: boolean

readonlyDynamicAllowInventoryAdd

DynamicAllowInventoryAdd: (C: Character) => boolean

Type declaration

• • (C: Character): boolean

  • Parameters

    • C: Character

    Returns boolean

readonlyDynamicAudio

DynamicAudio: (C: Character) => string

Type declaration

• • (C: Character): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicBeforeDraw

DynamicBeforeDraw: boolean

readonlyDynamicDescription

DynamicDescription: (C: Character) => string

Type declaration

• • (C: Character): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicGroupName

DynamicGroupName: AssetGroupName

readonlyDynamicName

DynamicName: (C: Character) => string

Type declaration

• • (C: Character): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicPreviewImage

DynamicPreviewImage: (C: Character) => string

Type declaration

• • (C: Character): string

  • Parameters

    • C: Character

    Returns string

readonlyDynamicScriptDraw

DynamicScriptDraw: 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

optionalreadonlyFreezeActivePose

FreezeActivePose?: never

@deprecated

Use Asset.AllowActivePose instead

readonlyFullAlpha

FullAlpha: boolean

optionalreadonlyGender

Gender?: AssetGender

readonlyGroup

Group: AssetGroup

optionalreadonlyHasType

HasType?: never

@deprecated

• superceded by CreateLayerTypes

readonlyHeightModifier

HeightModifier: number

optionalreadonlyHide

Hide?: readonly AssetGroupName[]

optionalreadonlyHideForPose

HideForPose?: never

@deprecated

• Superceded by Asset.PoseMapping

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

readonlyParentGroupName

ParentGroupName: AssetGroupName

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[]

readonlyTint

Tint: readonly Readonly<TintDefinition>[]

readonlyValue

Value: number

readonlyVisible

Visible: boolean

readonlyWear

Wear: boolean

readonlyWearTime

WearTime: number

optionalreadonlyWhitelistActivePose

WhitelistActivePose?: never

@deprecated

Use Asset.AllowActivePose instead

readonlyZoomModifier

ZoomModifier: number