Skip to main content

ItemProperties

Base properties for extended items

Those are the properties the main game code enforces.

Hierarchy

Index

Properties

optionalAccessMode

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

optionalAllowActivePose

AllowActivePose?: AssetPoseName[]

A list of poses

@see

optionalAllowActivity

AllowActivity?: ActivityName[]

A list of allowed activities

@see

optionalAllowActivityOn

AllowActivityOn?: AssetGroupName[]

A list of groups allowed activities

@see

optionalAllowPose

AllowPose?: never

A list of allowed poses

@see
@deprecated
  • Was never actually functional

optionalAttribute

Attribute?: AssetAttribute[]

optionalAutoPunish

AutoPunish?: 0 | 1 | 2 | 3

The item's auto-punishment sensitivity

optionalAutoPunishUndoTime

AutoPunishUndoTime?: number

The remaining time for the gag's auto-inflation

optionalAutoPunishUndoTimeSetting

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

The default time for the gag's auto-inflation

optionalBlinkState

BlinkState?: boolean

Whether gag's blinking light is on or off

optionalBlock

The groups that this item blocks

@see

optionalBlockRemotes

BlockRemotes?: boolean

Whether the usage of remotes is blocked

optionalCombinationNumber

CombinationNumber?: string

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

optionalCustomBlindBackground

CustomBlindBackground?: string

A custom background for this option that overrides the default

@see

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

optionalDifficulty

Difficulty?: number

The difficulty of the item

@see

optionalDoor

Door?: boolean

Whether the kennel door is open

optionalEffect

Effect?: EffectName[]

Effects that are applied by this item

@see

optionalEnableRandomInput

EnableRandomInput?: boolean

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

optionalExpression

Expression?: ExpressionName

A facial expression

optionalFetish

Fetish?: FetishName[]

A list of fetishes affected by the item

@see

optionalFreezeActivePose

FreezeActivePose?: never

A list of poses that should be frozen

@see
@deprecated

optionalHeartRate

HeartRate?: number

The futuristic bra's heart rate value

optionalHeightModifier

HeightModifier?: number

How much the character should be moved up

@see

optionalHide

Items groups that should be hidden by this item

@see

optionalHideItem

HideItem?: string[]

Items that should be hidden by this item

@see

optionalHideItemExclude

HideItemExclude?: string[]

Items that should not be hidden by this item

@see

optionalHint

Hint?: string

Used by PasswordPadlock, SafewordPadlock and TimerPasswordPadlock locks

optionalInflateLevel

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

The inflation level of inflatable items

optionalInsertedBeads

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

The number of inserted beads

optionalIntensity

Intensity?: VibratorIntensity

The vibrator intensity

optionalItemMemberNumber

ItemMemberNumber?: number

The member number of the player adding the item. Only set if the asset is marked as AssetDefinition.CharacterRestricted.

optionalIterations

Iterations?: number

Number of times the suitcase got cracked

optionalLockButt

LockButt?: boolean

Whether the item blocks access to the butt

optionalLockMemberNumber

LockMemberNumber?: string | number

The member number of the person that applied the lock

optionalLockPickSeed

LockPickSeed?: string

Comma separated numbers

optionalLockSet

LockSet?: boolean

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

optionalLockedBy

LockedBy?: AssetLockType

Asset name of the lock

optionalMemberNumberList

MemberNumberList?: number[]

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

optionalMemberNumberListKeys

MemberNumberListKeys?: string

Comma separated numbers; used by HighSecurityPadlock

optionalMode

The vibrator mode

optionalModules

Modules?: number[]

KD modules

optionalNextShockTime

NextShockTime?: number

Internal cooldown timer for automatic shocks

optionalOpacity

Opacity?: number | number[]

The asset's draw opacity

@see

optionalOpenPermission

OpenPermission?: boolean

Whether all players can use futuristic head devices

optionalOpenPermissionArm

OpenPermissionArm?: boolean

Whether all players can use futuristic arm devices

optionalOpenPermissionChastity

OpenPermissionChastity?: boolean

Whether all players can use futuristic chastity devices

optionalOpenPermissionLeg

OpenPermissionLeg?: boolean

Whether all players can use futuristic leg devices

optionalOption

An extended item option

@todo

Investigate whether this property still actually exists

optionalOrgasmCount

OrgasmCount?: number

Modular Belt: Number of times the wearer had orgasm;

optionalOriginalSetting

OriginalSetting?: 0 | 1 | 2 | 3

The gag module-index prior to triggering auto-inflation

optionalOverrideHeight

OverrideHeight?: AssetOverrideHeight

Override the height of the item

@see

optionalOverridePriority

OverridePriority?: AssetLayerOverridePriority

The drawing priority of the item

@see

Asset.OverridePriority

optionalPadding

Padding?: boolean

Whether the kennel has padding

optionalPassword

Password?: string

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

optionalPortalLinkCode

PortalLinkCode?: string

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

optionalPublicModeCurrent

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

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

optionalPublicModePermission

PublicModePermission?: 0 | 1 | 2

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

optionalPunishActivity

PunishActivity?: boolean

Whether performing activities should result in punishment

optionalPunishOrgasm

PunishOrgasm?: boolean

Whether orgasms should result in punishment

optionalPunishProhibitedSpeech

PunishProhibitedSpeech?: 0 | 1 | 2 | 3

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

optionalPunishProhibitedSpeechWords

PunishProhibitedSpeechWords?: string

A string with comma-separated prohibited words

optionalPunishRequiredSpeech

PunishRequiredSpeech?: 0 | 1 | 2 | 3

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

optionalPunishRequiredSpeechWord

PunishRequiredSpeechWord?: string

A string with comma-separated required words

optionalPunishSpeech

PunishSpeech?: 0 | 1 | 2 | 3

The punishment for talking; represents an index of FuturisticTrainingBeltSpeechPunishments

optionalPunishStandup

PunishStandup?: boolean

Whether standing up should result in punishment

optionalPunishStruggle

PunishStruggle?: boolean

Whether attempting to remove the belt should result in punishment

optionalPunishStruggleOther

PunishStruggleOther?: boolean

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

optionalRemoveItem

RemoveItem?: boolean

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

optionalRemoveOnUnlock

RemoveOnUnlock?: boolean

Only for PasswordPadlock

optionalRemoveTimer

RemoveTimer?: number

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

@see

optionalRevert

Revert?: boolean

Allows reverting back to these properties on exiting an extended menu

optionalRuinedOrgasmCount

RuinedOrgasmCount?: number

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

optionalSelfUnlock

SelfUnlock?: boolean

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

@see

optionalSetPose

SetPose?: AssetPoseName[]

A list of poses that should forcefully be set

@see

optionalShockLevel

ShockLevel?: 0 | 1 | 2

How intense the shock should be

optionalShowText

ShowText?: boolean

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

optionalShowTimer

ShowTimer?: boolean

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

optionalState

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

optionalSuctionLevel

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

The suction level of items with a suction effect

optionalTargetAngle

TargetAngle?: number

Lucky Wheel: the angle the wheel should spin to

optionalText

Text?: string

1st line of text for user-entered text data

optionalText2

Text2?: string

2nd line of text for user-entered text data

optionalText3

Text3?: string

3rd line of text for user-entered text data

optionalTexts

Texts?: string[]

Lucky Wheel: the section labels

optionalTimeSinceLastOrgasm

TimeSinceLastOrgasm?: number

Modular Belt: Amount of time since last detected orgasm;

optionalTimeWorn

TimeWorn?: number

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

optionalTint

A list of custom tints

@see

optionalTriggerCount

TriggerCount?: number

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

optionalTriggerValues

TriggerValues?: string

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

optionalType

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.

optionalTypeRecord

TypeRecord?: TypeRecord

A record mapping screen names to option indices.

optionalUnHide

UnHide?: AssetGroupName[]

Only available as overrides on the script item

optionalWhitelistActivePose

WhitelistActivePose?: never

A list of poses

@see
@deprecated