Skip to main content

ItemColorProperties

An item properties subtype with a guaranteed opacity field.

Hierarchy

Index

Properties

Properties

optionalinheritedAccessMode

AccessMode?: ItemVulvaFuturisticVibratorAccessMode

A string denoting who has permission to use the vibrator's trigger words

optionalinheritedAllowActivePose

AllowActivePose?: AssetPoseName[]

A list of poses

See more at Asset.AllowActivePose

optionalinheritedAllowActivity

AllowActivity?: ActivityName[]

A list of allowed activities

See more at Asset.AllowActivity

optionalinheritedAllowActivityOn

AllowActivityOn?: AssetGroupName[]

A list of groups allowed activities

See more at Asset.AllowActivityOn

optionalinheritedAttribute

Attribute?: AssetAttribute[]

???

See more at Asset.Attribute

optionalinheritedAutoPunish

AutoPunish?: 0 | 1 | 2 | 3

The item's auto-punishment sensitivity

optionalinheritedAutoPunishUndoTime

AutoPunishUndoTime?: number

The remaining time for the gag's auto-inflation

optionalinheritedAutoPunishUndoTimeSetting

AutoPunishUndoTimeSetting?: 120000 | 300000 | 900000 | 3600000 | 72000000

The default time for the gag's auto-inflation

optionalinheritedBlinkState

BlinkState?: boolean

Whether gag's blinking light is on or off

optionalinheritedBlock

Block?: AssetGroupItemName[]

The groups that this item blocks

See more at Asset.Block

optionalinheritedBlockRemotes

BlockRemotes?: boolean

Whether the usage of remotes is blocked

optionalinheritedCombinationNumber

CombinationNumber?: string

/^[0-9]{4}$/, Used by CombinationPadlock lock

optionalinheritedDefaultColor

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 more at Asset.DefaultColor

optionalinheritedDifficulty

Difficulty?: number

The difficulty of the item

See more at Asset.Difficulty

optionalinheritedDoor

Door?: boolean

Whether the kennel door is open

optionalinheritedDrawingLeft

DrawingLeft?: Partial<Record<string, Partial<Record< | AssetPoseName, number>>>>

Override the left-position of a layer. A value of AssetOverride will be override the relative position of each and every layer individually.

optionalinheritedDrawingTop

DrawingTop?: Partial<Record<string, Partial<Record< | AssetPoseName, number>>>>

Override the top-position of a layer. A value of AssetOverride will be override the relative position of each and every layer individually.

optionalinheritedEffect

Effect?: EffectName[]

Effects that are applied by this item

See more at Asset.Effect

optionalinheritedEnableRandomInput

EnableRandomInput?: boolean

Enable input; used by LoversTimerPadlock, MistressTimerPadlock, OwnerTimerPadlock, TimerPasswordPadlock

optionalinheritedExpression

Expression?: ExpressionName

A facial expression

optionalinheritedFetish

Fetish?: FetishName[]

A list of fetishes affected by the item

See more at Asset.Fetish

optionalinheritedHeartRate

HeartRate?: number

The futuristic bra's heart rate value

optionalinheritedHeightModifier

HeightModifier?: number

How much the character should be moved up

See more at Asset.HeightModifier

optionalinheritedHide

Hide?: AssetGroupName[]

Items groups that should be hidden by this item

See more at Asset.Hide

optionalinheritedHideItem

HideItem?: string[]

Items that should be hidden by this item

See more at Asset.HideItem

optionalinheritedHideItemExclude

HideItemExclude?: string[]

Items that should not be hidden by this item

See more at Asset.HideItemExclude

optionalinheritedHint

Hint?: string

Used by PasswordPadlock, SafewordPadlock and TimerPasswordPadlock locks

optionalinheritedInflateLevel

InflateLevel?: 0 | 1 | 2 | 3 | 4

The inflation level of inflatable items

optionalinheritedInsertedBeads

InsertedBeads?: 1 | 2 | 3 | 4 | 5

The number of inserted beads

optionalinheritedIntensity

Intensity?: VibratorIntensity

The vibrator intensity

optionalinheritedIterations

Iterations?: number

Number of times the suitcase got cracked

optionalinheritedLockButt

LockButt?: boolean

Whether the item blocks access to the butt

optionalinheritedLockedBy

LockedBy?: AssetLockType

Asset name of the lock

optionalinheritedLockMemberName

LockMemberName?: string

The member name of the person that applied the lock

optionalinheritedLockMemberNumber

LockMemberNumber?: number

The member number of the person that applied the lock. If set to a positive number, LockMemberName is the name of the character that added the lock. Otherwise it's either -1 and the name of an NPC, or null and a message.

optionalinheritedLockMessage

LockMessage?: string

A short message describing where the lock comes from. Only used by the Nursery and KD

optionalinheritedLockPickSeed

LockPickSeed?: string

Comma separated numbers

optionalinheritedLockSet

LockSet?: boolean

Used by PasswordPadlock, SafewordPadlock and TimerPasswordPadlock locks; if the lock has been set with password

optionalinheritedMemberNumberList

MemberNumberList?: number[]

List of people who publicly modified time on lock; used by LoversTimerPadlock, MistressTimerPadlock, OwnerTimerPadlock, TimerPasswordPadlock

optionalinheritedMemberNumberListKeys

MemberNumberListKeys?: string

Comma separated numbers; used by HighSecurityPadlock

optionalinheritedMode

Mode?: VibratorMode

The vibrator mode

optionalinheritedModules

Modules?: number[]

KD modules

optionalinheritedNextShockTime

NextShockTime?: number

Internal cooldown timer for automatic shocks

Opacity

Opacity: number[]

The asset's draw opacity

See more at Asset.Opacity

optionalinheritedOpenPermission

OpenPermission?: boolean

Whether all players can use futuristic head devices

optionalinheritedOpenPermissionArm

OpenPermissionArm?: boolean

Whether all players can use futuristic arm devices

optionalinheritedOpenPermissionChastity

OpenPermissionChastity?: boolean

Whether all players can use futuristic chastity devices

optionalinheritedOpenPermissionLeg

OpenPermissionLeg?: boolean

Whether all players can use futuristic leg devices

optionalinheritedOption

Option?: ExtendedItemOption

An extended item option

Investigate whether this property still actually exists

optionalinheritedOrgasmCount

OrgasmCount?: number

Modular Belt: Number of times the wearer had orgasm;

optionalinheritedOriginalSetting

OriginalSetting?: 0 | 1 | 2 | 3

The gag module-index prior to triggering auto-inflation

optionalinheritedOverrideHeight

OverrideHeight?: AssetOverrideHeight

Override the height of the item

See more at Asset.OverrideHeight

optionalinheritedOverridePriority

OverridePriority?: AssetLayerOverridePriority

The drawing priority of the item

See more at Asset.OverridePriority

optionalinheritedPadding

Padding?: boolean

Whether the kennel has padding

optionalinheritedPassword

Password?: string

/^[A-Z]{1,8}$/, Used by PasswordPadlock, SafewordPadlock and TimerPasswordPadlock lock

optionalinheritedPortalLinkCode

PortalLinkCode?: string

PortalLink: Used to link a remote to its target asset.

optionalinheritedPublicModeCurrent

PublicModeCurrent?: 0 | 1 | 2 | 3 | 4 | 5 | 6

The mode of the belts vibrator; represents an index of FuturisticTrainingBeltModes

optionalinheritedPublicModePermission

PublicModePermission?: 0 | 1 | 2

An integer denoting who can access the belt; represents an index of FuturisticTrainingBeltPermissions

optionalinheritedPunishActivity

PunishActivity?: boolean

Whether performing activities should result in punishment

optionalinheritedPunishOrgasm

PunishOrgasm?: boolean

Whether orgasms should result in punishment

optionalinheritedPunishProhibitedSpeech

PunishProhibitedSpeech?: 0 | 1 | 2 | 3

The punishment for speaking a prohibited word; represents an index of FuturisticTrainingBeltSpeechPunishments

optionalinheritedPunishProhibitedSpeechWords

PunishProhibitedSpeechWords?: string

A string with comma-separated prohibited words

optionalinheritedPunishRequiredSpeech

PunishRequiredSpeech?: 0 | 1 | 2 | 3

The punishment for not speaking a required word; represents an index of FuturisticTrainingBeltSpeechPunishments

optionalinheritedPunishRequiredSpeechWord

PunishRequiredSpeechWord?: string

A string with comma-separated required words

optionalinheritedPunishSpeech

PunishSpeech?: 0 | 1 | 2 | 3

The punishment for talking; represents an index of FuturisticTrainingBeltSpeechPunishments

optionalinheritedPunishStandup

PunishStandup?: boolean

Whether standing up should result in punishment

optionalinheritedPunishStruggle

PunishStruggle?: boolean

Whether attempting to remove the belt should result in punishment

optionalinheritedPunishStruggleOther

PunishStruggleOther?: boolean

Whether attempting to remove an item in general should result in punishment

optionalinheritedRemoveItem

RemoveItem?: boolean

Whether to remove item on timer lock unlock; used by LoversTimerPadlock, MistressTimerPadlock, OwnerTimerPadlock, TimerPadlock, TimerPasswordPadlock

optionalinheritedRemoveOnUnlock

RemoveOnUnlock?: boolean

Only for PasswordPadlock

optionalinheritedRemoveTimer

RemoveTimer?: number

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

See more at Asset.RemoveTimer

optionalinheritedRevert

Revert?: boolean

Allows reverting back to these properties on exiting an extended menu

optionalinheritedRuinedOrgasmCount

RuinedOrgasmCount?: number

Modular Belt: Number of times the wearer had ruined orgasm;

optionalinheritedSelfUnlock

SelfUnlock?: boolean

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

See more at Asset.SelfUnlock

optionalinheritedSetPose

SetPose?: AssetPoseName[]

A list of poses that should forcefully be set

See more at Asset.SetPose

optionalinheritedShockLevel

ShockLevel?: 0 | 1 | 2

How intense the shock should be

optionalinheritedShowText

ShowText?: boolean

Whether the item displays a chat message to all other people in the room

optionalinheritedShowTimer

ShowTimer?: boolean

Whether time is shown or "Unknown time left"; used by LoversTimerPadlock, MistressTimerPadlock, OwnerTimerPadlock, TimerPasswordPadlock

optionalinheritedState

State?: VibratorModeState

The vibrator's state; only relevant for advanced vibrator modes

optionalinheritedSuctionLevel

SuctionLevel?: 0 | 1 | 2 | 3 | 4

The suction level of items with a suction effect

optionalinheritedTargetAngle

TargetAngle?: number

Lucky Wheel: the angle the wheel should spin to

optionalinheritedText

Text?: string

1st line of text for user-entered text data

optionalinheritedText2

Text2?: string

2nd line of text for user-entered text data

optionalinheritedText3

Text3?: string

3rd line of text for user-entered text data

optionalinheritedTexts

Texts?: string[]

Lucky Wheel: the section labels

optionalinheritedTimeSinceLastOrgasm

TimeSinceLastOrgasm?: number

Modular Belt: Amount of time since last detected orgasm;

optionalinheritedTimeWorn

TimeWorn?: number

Modular Belt: Amount of time since the item is being worn;

optionalinheritedTint

Tint?: TintDefinition[]

A list of custom tints

See more at Asset.Tint

optionalinheritedTriggerCount

TriggerCount?: number

Number of times the item was triggered; often used by shock collars

optionalinheritedTriggerValues

TriggerValues?: string

A comma-separated string with the futuristic vibrator's trigger words

optionalinheritedType

Type?: string

A string (or null) denoting the state of an extended item. How the type-string translate to concrete properties depends on the Archetype in question.

Deprecated - Superseded by ItemPropertiesBase.TypeRecord. Old type strings can be convert to records via ExtendedItemTypeToRecord.

optionalinheritedTypeRecord

TypeRecord?: TypeRecord

A record mapping screen names to option indices.

optionalinheritedUnHide

UnHide?: AssetGroupName[]

Only available as overrides on the script item

Page Options