Skip to main content

PlayerCharacter

Pandora Player extension

Hierarchy

Index

Properties

Accessors

Methods

Properties

inheritedAccountName

AccountName: string

The character's account name

Note that it's only meaningful for the logged in player as the server never provides account names. Online characters will use "Online-" plus their character ID, NPCs will have their dialog identifier, and simple characters set it to CharacterID.

readonlyinheritedActiveExpression

ActiveExpression: Partial<Record<keyof ExpressionNameMap, ExpressionName>> & { deleteWithoutReload: any; setWithoutReload: any }

An object mapping expression group names to their respective currently explicitly, manually selected expression (which may thus diverge from the actual currently active expression).

Setting or deleting an entry will potentially trigger a DialogSelfMenuMapping.Expression reload unless done so via setWithoutReload()/deleteWithoutReload() calls.

inheritedActivePoseMapping

ActivePoseMapping: Partial<Record<keyof AssetPoseMap, AssetPoseName>>

A record mapping pose categories to the last manually enabled pose belonging to it.

Note that these poses are by no means guaranteed to be enabled, as they do not reflect any item-specific automatic pose changes (see PoseMapping).

inheritedAllowedActivePoseMapping

AllowedActivePoseMapping: Partial<Record<keyof AssetPoseMap, AssetPoseName[]>>

A record mapping pose categories to all allowed poses belonging to it.

A value of null implies that all poses within the category are allowed.

@see

ItemProperties.AllowActivePose - The item-/asset-level equivalent of this property

AllowedInteractions

AllowedInteractions: AllowedInteractions

inheritedAllowItem

AllowItem: boolean

optionalinheritedAllowMove

AllowMove?: boolean

inheritedAppearance

Appearance: Item[]

optionalinheritedAppearanceFull

AppearanceFull?: Item[]

optionalinheritedAppearanceLayers

AppearanceLayers?: Mutable<AssetLayer>[]

optionalinheritedAppearanceMasks

AppearanceMasks?: AssetLayer[]

optionalinheritedArchetype

Archetype?: NPCArchetype

NPC type: Slave, Maid, etc.

inheritedArousalSettings

ArousalSettings: ArousalSettingsType

optionalinheritedArousalZoom

ArousalZoom?: boolean

inheritedAssetFamily

AssetFamily: Female3DCG

The asset family used by the character

inheritedAttribute

Attribute: AssetAttribute[]

AudioSettings

AudioSettings: AudioSettingsType

inheritedBlackList

BlackList: number[]

List of blacklisted member numbers for the character

Do not manipulate directly. Use ChatRoomListUpdate

inheritedBlinkFactor

BlinkFactor: number

optionalinheritedCage

Cage?: boolean

inheritedCanChangeClothesOn

CanChangeClothesOn: (C) => boolean

Check whether a character can change another one's outfit.

Type declaration

    • (C): boolean

inheritedCanChangeOwnClothes

CanChangeOwnClothes: () => boolean

Check whether a character can change its own outfit.

@warning

Only usable on Player

Type declaration

    • (): boolean

    • Returns boolean

      • TRUE if changing is possible, FALSE otherwise.

inheritedCanChangeToPose

CanChangeToPose: (Pose) => boolean

Type declaration

inheritedCanInteract

CanInteract: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedCanKneel

CanKneel: (minimumStatus) => boolean

Type declaration

    • (minimumStatus): boolean

inheritedCanPickLocks

CanPickLocks: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedCanTalk

CanTalk: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedCanvas

Canvas: HTMLCanvasElement

inheritedCanvasBlink

CanvasBlink: HTMLCanvasElement

inheritedCanWalk

CanWalk: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedCharacterID

CharacterID: string

The unique identifier for the character

A value of "" indicates the player before the login happens

ChatSearchFilterTerms

ChatSearchFilterTerms: never
@deprecated

ChatSearchSettings

ChatSearchSettings: ChatRoomSearchSettings

ChatSettings

ChatSettings: ChatSettingsType

inheritedClickedOption

ClickedOption: string

ConfiscatedItems

ConfiscatedItems: { Group: AssetGroupName; Name: string }[]

The list of items we got confiscated in the Prison

ControllerSettings

ControllerSettings: ControllerSettingsType

Crafting

Crafting: CraftingItem[]

Creation

Creation: number

optionalinheritedCurrentTraining

CurrentTraining?: number

optionalinheritedCustomBackground

CustomBackground?: string

The custom background to use for the current room Only valid on Player

Description

Description: string

inheritedDialog

Dialog: DialogLine[]

optionalinheritedDialogInfo

DialogInfo?: DialogInfo<any>

The character's loaded dialog info

Difficulty

Difficulty: { LastChange?: number; Level: DifficultyLevel }

Type declaration

inheritedDrawAppearance

DrawAppearance: Item[]

inheritedDrawPoseMapping

DrawPoseMapping: Partial<Record<keyof AssetPoseMap, AssetPoseName>>

A record mapping pose categories to something something.

optionalinheritedDrinkValue

DrinkValue?: number

inheritedEffect

Effect: EffectName[]

optionalinheritedExpectedTraining

ExpectedTraining?: number

optionalinheritedExpressionQueue

ExpressionQueue?: ExpressionQueueItem[]

ExtensionSettings

ExtensionSettings: ExtensionSettings

optionalinheritedFixedImage

FixedImage?: string

inheritedFocusGroup

FocusGroup: AssetItemGroup

FriendList

FriendList: number[]

FriendNames

FriendNames: Map<number, string>

optionalinheritedFriendship

Friendship?: string

optionalinheritedFromPandora

FromPandora?: boolean

Game

Game: CharacterGameParameters

GameplaySettings

GameplaySettings: GameplaySettingsType

GenderSettings

GenderSettings: GenderSettingsType

inheritedGetBlindLevel

GetBlindLevel: (eyesOnly) => number

Type declaration

    • (eyesOnly): number

    • Parameters

      • optionaleyesOnly: boolean

      Returns number

inheritedGetBlurLevel

GetBlurLevel: () => number

Type declaration

    • (): number

    • Returns number

inheritedGetClumsiness

GetClumsiness: () => number

Type declaration

    • (): number

    • Returns number

inheritedGetDeafLevel

GetDeafLevel: () => number

Type declaration

    • (): number

    • Returns number

inheritedGetDifficulty

GetDifficulty: () => number

Type declaration

    • (): number

    • Returns number

inheritedGetGenders

GetGenders: () => AssetGender[]

Type declaration

inheritedGetLovership

GetLovership: (MembersOnly) => Lovership[]

Returns the lovership data for the character

Type declaration

inheritedGetPronouns

GetPronouns: () => CharacterPronouns

Type declaration

inheritedGetSlowLevel

GetSlowLevel: () => number

Type declaration

    • (): number

    • Returns number

inheritedGetTints

GetTints: () => RGBAColor[]

Type declaration

GhostList

GhostList: number[]

List of ghosted member numbers for the player

Do not manipulate directly. Use ChatRoomListUpdate

GraphicsSettings

GraphicsSettings: GraphicsSettingsType

inheritedHasAttribute

HasAttribute: (attribute) => boolean

Type declaration

    • (attribute): boolean

inheritedHasEffect

HasEffect: (Effect) => boolean

Type declaration

    • (Effect): boolean

inheritedHasHiddenItems

HasHiddenItems: boolean

inheritedHasNoItem

HasNoItem: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedHasOnBlacklist

HasOnBlacklist: (target) => boolean

Check if the player is blacklisting the given target character (or member number)

Type declaration

    • (target): boolean

    • Parameters

      Returns boolean

inheritedHasOnFriendlist

HasOnFriendlist: (this, target) => boolean

Check if the player is friend with the given target character (or member number)

Type declaration

inheritedHasOnGhostlist

HasOnGhostlist: (this, target) => boolean

Check if the player is ghosting the given target character (or member number)

Type declaration

inheritedHasOnWhitelist

HasOnWhitelist: (target) => boolean

Check if the player is whitelisting the given target character (or member number)

Type declaration

    • (target): boolean

    • Parameters

      Returns boolean

inheritedHasOwnerNotes

HasOwnerNotes: () => boolean

Whether the owner of this character (if any) has left any public notes.

Type declaration

    • (): boolean

    • Returns boolean

inheritedHasPenis

HasPenis: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

optionalinheritedHasScriptedAssets

HasScriptedAssets?: boolean

inheritedHasTints

HasTints: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedHasVagina

HasVagina: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedHeightModifier

HeightModifier: number

inheritedHeightRatio

HeightRatio: number

optionalinheritedHeightRatioProportion

HeightRatioProportion?: number

inheritedHooks

Hooks: Map<CharacterHook, Map<string, () => void>>

optionalinheritedHouse

House?: | MagicSchoolHouse

inheritedID

ID: number

The character's cache slot ID in the Character array

Usually meaningless, except that ID 0 is always the player, but please use IsPlayer() instead of checking that.

ImmersionSettings

ImmersionSettings: ImmersionSettingsType

optionalInfiltration

Infiltration?: InfiltrationType

optionalinheritedInterviewCleanCount

InterviewCleanCount?: number

inheritedInventory

Inventory: InventoryItem[]

optionalinheritedInventoryData

InventoryData?: string

inheritedIsAssFull

IsAssFull: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsBirthday

IsBirthday: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsBlacklisted

IsBlacklisted: () => boolean

Check if this character is blacklisted by the player

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsBlind

IsBlind: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsBreastChaste

IsBreastChaste: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsButtChaste

IsButtChaste: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsChaste

IsChaste: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsDeaf

IsDeaf: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsEdged

IsEdged: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsEgged

IsEgged: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsEnclose

IsEnclose: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsFamilyOfPlayer

IsFamilyOfPlayer: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsFixedHead

IsFixedHead: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsFlatChested

IsFlatChested: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsFriend

IsFriend: () => boolean

Check if this character is friended by the player

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsFullyOwned

IsFullyOwned: () => boolean

Whether the character has completed their ownership trial

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsFullyOwnedByPlayer

IsFullyOwnedByPlayer: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsGagged

IsGagged: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsGhosted

IsGhosted: () => boolean

Check if this character is ghosted by the player

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsInFamilyOfMemberNumber

IsInFamilyOfMemberNumber: (MemberNum) => boolean

Type declaration

    • (MemberNum): boolean

    • Parameters

      • MemberNum: number

      Returns boolean

inheritedIsInverted

IsInverted: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsKneeling

IsKneeling: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsLocked

IsLocked: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsLoverOfCharacter

IsLoverOfCharacter: (C) => boolean

Whether the character is in love with the given character

Type declaration

    • (C): boolean

inheritedIsLoverOfMemberNumber

IsLoverOfMemberNumber: (memberNumber) => boolean

Whether the character is in love with the given character, number form

Type declaration

    • (memberNumber): boolean

    • Parameters

      • memberNumber: number

      Returns boolean

inheritedIsLoverOfPlayer

IsLoverOfPlayer: () => boolean

Whether the character is in love with the player

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsMounted

IsMounted: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsMouthBlocked

IsMouthBlocked: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsMouthOpen

IsMouthOpen: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsNaked

IsNaked: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsNpc

IsNpc: () => this is NPCCharacter

Type declaration

inheritedIsOnline

IsOnline: () => this is Character

Type declaration

inheritedIsOwned

IsOwned: () => false | player | online | npc | ggts

Whether the character is owned, and who owns it

Type declaration

    • (): false | player | online | npc | ggts

    • Returns false | player | online | npc | ggts

inheritedIsOwnedByCharacter

IsOwnedByCharacter: (C) => boolean

Whether the character is owned by the given character

Type declaration

    • (C): boolean

inheritedIsOwnedByMemberNumber

IsOwnedByMemberNumber: (memberNumber) => boolean

Whether the character is owned by the given character, number form

Type declaration

    • (memberNumber): boolean

    • Parameters

      • memberNumber: number

      Returns boolean

inheritedIsOwnedByPlayer

IsOwnedByPlayer: () => boolean

Whether the player owns that character

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsOwner

IsOwner: () => boolean

Whether the given character owns the player

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsPlayer

IsPlayer: () => this is PlayerCharacter

Type declaration

inheritedIsPlugged

IsPlugged: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsRestrained

IsRestrained: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsShackled

IsShackled: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsSiblingOfCharacter

IsSiblingOfCharacter: (C) => boolean

Type declaration

    • (C): boolean

inheritedIsSimple

IsSimple: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsSlow

IsSlow: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsStanding

IsStanding: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsSuspended

IsSuspended: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsVulvaChaste

IsVulvaChaste: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsVulvaFull

IsVulvaFull: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedIsWhitelisted

IsWhitelisted: () => boolean

Check if this character is whitelisted by the player

Type declaration

    • (): boolean

    • Returns boolean

KeybindingSettings

KeybindingSettings: string

optionalinheritedKidnapCard

KidnapCard?: KidnapCard[]

optionalinheritedKidnapMaxWillpower

KidnapMaxWillpower?: number

optionalinheritedKidnapStat

KidnapStat?: [number, number, number, number]

optionalinheritedKidnapWillpower

KidnapWillpower?: number

optionalKinkyDungeonExploredLore

KinkyDungeonExploredLore?: any[]

optionalKinkyDungeonKeybindings

KinkyDungeonKeybindings?: any

LabelColor

LabelColor: `#${string}`

optionalinheritedLastActivity

LastActivity?: PandoraPrisonActivity

optionalLastChatRoom

LastChatRoom?: { Access: ServerChatRoomRole[]; Admin: number[]; Background: string; Ban: number[]; BlockCategory: ServerChatRoomBlockCategory[]; Custom?: ServerChatRoomCustomData; Description: string; Game: ServerChatRoomGame; Language: ServerChatRoomLanguage; Limit: number; MapData?: ServerChatRoomMapData; Name: string; Space?: ServerChatRoomSpace; Visibility: ServerChatRoomRole[]; Whitelist: number[] }

The chat room we were previous in. Used for relog room re-creation

Type declaration

optionalinheritedLastMapData

LastMapData?: ChatRoomMapData

optionalinheritedLove

Love?: number

optionalinheritedLover

Lover?: string

inheritedLoverName

LoverName: () => string

The character's lover name. NPC-only

Type declaration

    • (): string

    • Returns string

inheritedLovership

Lovership: Lovership[]

optionalinheritedMapData

MapData?: ChatRoomMapData

MemberNumber

MemberNumber: number

inheritedMoney

Money: number

inheritedMustDraw

MustDraw: boolean

inheritedName

Name: string

optionalNickname

Nickname?: string

NotificationSettings

NotificationSettings: NotificationSettingsType

optionalinheritedOnlineID

OnlineID?: string

A deprecated identifier for online characters Only exists on the player, has the same value as their character ID.

@deprecated

OnlineSettings

OnlineSettings: PlayerOnlineSettings

OnlineSharedSettings

OnlineSharedSettings: CharacterOnlineSharedSettings

optionalinheritedOrgasmDone

OrgasmDone?: boolean

optionalinheritedOrgasmMeter

OrgasmMeter?: number

inheritedOwnedSince

OwnedSince: () => number

The number of days since the character has been owned (-1 means not owned)

Type declaration

    • (): number

    • Returns number

inheritedOwnedSinceMs

OwnedSinceMs: () => number

Epoch timestamp of ownership start (-1 means not owned)

Type declaration

    • (): number

    • Returns number

inheritedOwner

Owner: string

inheritedOwnerName

OwnerName: () => string

The name of this character's owner

Type declaration

    • (): string

    • Returns string

inheritedOwnerNumber

OwnerNumber: () => number

The character's owner number. Might be -1 for non-online characters

Type declaration

    • (): number

    • Returns number

inheritedOwnership

Ownership: Ownership

inheritedPermissionItems

PermissionItems: Partial<Record<`BodyUpper/${string}` | `BodyLower/${string}` | `Eyebrows/${string}` | `Eyes/${string}` | `Eyes2/${string}` | `Mouth/${string}` | `Pussy/${string}` | `Blush/${string}` | `Fluids/${string}` | `Emoticon/${string}` | `AnkletLeft/${string}` | `AnkletRight/${string}` | `ArmsLeft/${string}` | `ArmsRight/${string}` | `BodyStyle/${string}` | `BodyMarkings/${string}` | `Bra/${string}` | `Bracelet/${string}` | `Cloth/${string}` | `ClothAccessory/${string}` | `ClothLower/${string}` | `ClothOuter/${string}` | `Corset/${string}` | `Decals/${string}` | `EyeShadow/${string}` | `FacialHair/${string}` | `Garters/${string}` | `Glasses/${string}` | `Gloves/${string}` | `HairAccessory1/${string}` | `HairAccessory2/${string}` | `HairAccessory3/${string}` | `HairBack/${string}` | `HairFront/${string}` | `HandAccessoryLeft/${string}` | `HandAccessoryRight/${string}` | `Hat/${string}` | `Head/${string}` | `Height/${string}` | `Jewelry/${string}` | `Mask/${string}` | `Necklace/${string}` | `Nipples/${string}` | `Panties/${string}` | `Pronouns/${string}` | `Shoes/${string}` | `Socks/${string}` | `SocksLeft/${string}` | `SocksRight/${string}` | `Suit/${string}` | `SuitLower/${string}` | `TailStraps/${string}` | `Wings/${string}` | `HandsLeft/${string}` | `HandsRight/${string}` | `FaceMarkings/${string}` | `ItemAddon/${string}` | `ItemArms/${string}` | `ItemBoots/${string}` | `ItemBreast/${string}` | `ItemButt/${string}` | `ItemDevices/${string}` | `ItemEars/${string}` | `ItemFeet/${string}` | `ItemHands/${string}` | `ItemHead/${string}` | `ItemHood/${string}` | `ItemLegs/${string}` | `ItemMisc/${string}` | `ItemMouth/${string}` | `ItemMouth2/${string}` | `ItemMouth3/${string}` | `ItemNeck/${string}` | `ItemNeckAccessories/${string}` | `ItemNeckRestraints/${string}` | `ItemNipples/${string}` | `ItemNipplesPiercings/${string}` | `ItemNose/${string}` | `ItemPelvis/${string}` | `ItemTorso/${string}` | `ItemTorso2/${string}` | `ItemVulva/${string}` | `ItemVulvaPiercings/${string}` | `ItemHandheld/${string}` | `ItemScript/${string}`, ItemPermissions>>

A record with all asset- and type-specific permission settings

inheritedPoseMapping

PoseMapping: Partial<Record<keyof AssetPoseMap, AssetPoseName>>

A record mapping pose categories to the currently enabled pose belonging to it.

@see

ItemProperties.SetPose - The item-/asset-level equivalent of this property

optionalinheritedPrivateBed

PrivateBed?: boolean

optionalinheritedPrivateBedActivityTimer

PrivateBedActivityTimer?: number

optionalinheritedPrivateBedAppearance

PrivateBedAppearance?: string

optionalinheritedPrivateBedLeft

PrivateBedLeft?: number

optionalinheritedPrivateBedMoveTimer

PrivateBedMoveTimer?: number

optionalinheritedPrivateBedTop

PrivateBedTop?: number

optionalinheritedQuizFail

QuizFail?: number

optionalinheritedQuizLog

QuizLog?: number[]

optionalinheritedRandomOdds

RandomOdds?: number

optionalinheritedRecruit

Recruit?: number

optionalinheritedRecruitOdds

RecruitOdds?: number

inheritedRegisterHook

RegisterHook: (hookName, hookInstance, callback) => boolean

Type declaration

    • (hookName, hookInstance, callback): boolean

    • Parameters

      Returns boolean

inheritedReputation

Reputation: Reputation[]

RestrictionSettings

RestrictionSettings: RestrictionSettingsType

optionalinheritedRule

Rule?: LogRecord[]

inheritedRunHooks

RunHooks: (hookName) => void

Type declaration

optionalinheritedRunScripts

RunScripts?: boolean

SavedColors

SavedColors: HSVColor[]

SavedExpressions

SavedExpressions: { CurrentExpression?: ExpressionName; Group: keyof ExpressionNameMap }[][]

inheritedSkill

Skill: Skill[]

optionalinheritedStatus

Status?: string

optionalinheritedStatusTimer

StatusTimer?: number

SubmissivesList

SubmissivesList: Set<number>

inheritedTints

Tints: ResolvedTintDefinition[]

optionalinheritedTitle

Title?: TitleName

optionalinheritedTrainingCount

TrainingCount?: number

optionalinheritedTrainingCountHigh

TrainingCountHigh?: number

optionalinheritedTrainingCountLow

TrainingCountLow?: number

optionalinheritedTrainingCountPerfect

TrainingCountPerfect?: number

optionalinheritedTrainingIntensity

TrainingIntensity?: number

optionalinheritedTriggerIntro

TriggerIntro?: boolean

inheritedType

Type: CharacterType

The type of character: online, npc, or simple

inheritedUnregisterHook

UnregisterHook: (hookName, hookInstance) => boolean

Type declaration

    • (hookName, hookInstance): boolean

    • Parameters

      Returns boolean

VisualSettings

VisualSettings: VisualSettingsType

Wardrobe

Wardrobe: ServerItemBundle[][]

WardrobeCharacterNames

WardrobeCharacterNames: string[]

inheritedWearingCollar

WearingCollar: () => boolean

Type declaration

    • (): boolean

    • Returns boolean

inheritedWhiteList

WhiteList: number[]

List of whitelisted member numbers for the character

Do not manipulate directly. Use ChatRoomListUpdate

Accessors

inheritedActivePose

  • get ActivePose(): readonly AssetPoseName[]
  • set ActivePose(value): void

  • Get a copy or set the array of the last set of manually activated poses.

    Note that these poses are by no means guaranteed to be enabled, as they do not reflect any item-specific automatic pose changes (see Pose).

    @see

    ActivePoseMapping - The underlying record of this property, usage of which is recommended

    Returns readonly AssetPoseName[]

  • Parameters

    Returns void

inheritedAllowedActivePose

  • get AllowedActivePose(): readonly AssetPoseName[]
  • set AllowedActivePose(value): void

  • Get a copy or set the array of the last of a subset of all allowed poses.

    Only guaranteed to reflect the total number of allowed poses if, for a given pose category, at least one pose is allowed.

    @see

    ActivePoseMapping - The underlying record of this property, usage of which is recommended

    Returns readonly AssetPoseName[]

  • Parameters

    Returns void

inheritedCurrentDialog

  • get CurrentDialog(): string
  • set CurrentDialog(value): void

  • Set or get the current dialog, performing a dialog status update if required (see DialogSetStatus)

    Returns string

  • Parameters

    • value: string

    Returns void

inheritedDrawPose

  • get DrawPose(): readonly AssetPoseName[]
  • set DrawPose(value): void

  • Get a copy or set the array of something something poses.

    @see

    DrawPoseMapping - The underlying record of this property, usage of which is recommended

    Returns readonly AssetPoseName[]

  • Parameters

    Returns void

inheritedPose

  • Get a copy or set the array of currently enabled poses.

    @see

    PoseMapping - The underlying record of this property, usage of which is recommended

    Returns readonly AssetPoseName[]

  • Parameters

    Returns void

inheritedPosition

  • Returns ChatRoomMapPos

  • Parameters

    Returns void

inheritedStage

  • get Stage(): string
  • set Stage(value): void

  • Set or get the current stage, performing a dialog DialogMenu.Reload if required

    Returns string

  • Parameters

    • value: string

    Returns void

inheritedX

  • get X(): number
  • set X(X): void

  • Returns number

  • Parameters

    • X: number

    Returns void

inheritedY

  • get Y(): number
  • set Y(Y): void

  • Returns number

  • Parameters

    • Y: number

    Returns void

Methods

inheritedGetLoversNumbers

  • GetLoversNumbers(MembersOnly): number[]
  • GetLoversNumbers(MembersOnly): (string | number)[]
  • GetLoversNumbers(MembersOnly): (string | number)[]

  • Returns the list of member numbers (or names, for NPCs) the character is in love with

    Parameters

    • MembersOnly: true

    Returns number[]

optionalinheritedWillRelease

  • WillRelease(): boolean

  • Returns boolean

Page Options