Platform

Index

Interfaces

• AnimationSpec
• Character
• CharacterTemplate
• Cooldown
• DialogCharacter
• DummyTemplate
• Event
• Item
• PartyMember
• Projectile
• Room

Type Aliases

• AnimationName
• CharacterStatus
• CooldownType
• EffectType
• EventType
• ItemName
• KeyCode
• Perk
• PerkName
• ProjectileName
• ProjectileType
• RoomType
• SoundCategory
• SoundEffect

Interfaces

AnimationSpec

AnimationSpec:

optionalAudio

Audio?: string[]

optionalCycle

Cycle?: number[]

optionalCycleLeft

CycleLeft?: number[]

optionalHeight

Height?: number

optionalImage

Image?: number

optionalMirror

Mirror?: boolean

Name

Name: AnimationName

optionalOffsetX

OffsetX?: number

optionalOffsetY

OffsetY?: number

optionalSpeed

Speed?: number

optionalWidth

Width?: number

Character

Character:

Action

Action: { Done?: boolean; Expire: number; Name: AnimationName; Start: number; Target?: number }

Type declaration

• optionalDone?: boolean

• Expire: number

• Name: AnimationName

• Start: number

• optionalTarget?: number

optionalAnim

Anim?: AnimationSpec

Animation

Animation: AnimationSpec[]

Inherited from CharacterTemplate.Animation

optionalAttack

Attack?: { Cooldown?: number; Damage?: number[]; HitAnimation?: number[]; HitAudio?: string[]; HitBox?: RectTuple; JumpForce?: number; Magic?: number; Name: string; Speed: number; StartAudio?: string[] }[]

Inherited from CharacterTemplate.Attack

BaseHealth

BaseHealth: number

optionalBaseMagic

BaseMagic?: number

optionalBaseProjectile

BaseProjectile?: number

optionalBaseProjectileTime

BaseProjectileTime?: number

BaseRunSpeed

BaseRunSpeed: number

BaseWalkSpeed

BaseWalkSpeed: number

optionalBindAudio

BindAudio?: string[]

Inherited from CharacterTemplate.BindAudio

Bound

Bound: boolean

Camera

Camera: boolean

optionalCollisionDamage

CollisionDamage?: number

Inherited from CharacterTemplate.CollisionDamage

Combat

Combat: boolean

CrawlSpeed

CrawlSpeed: number

Inherited from CharacterTemplate.CrawlSpeed

Damage

Damage: { Expire: number; Value: number }[]

optionalDamageAudio

DamageAudio?: string[]

Inherited from CharacterTemplate.DamageAudio

DamageBackOdds

DamageBackOdds: number

Overrides CharacterTemplate.DamageBackOdds

DamageFaceOdds

DamageFaceOdds: number

Overrides CharacterTemplate.DamageFaceOdds

optionalDamageKnockForce

DamageKnockForce?: number

Inherited from CharacterTemplate.DamageKnockForce

Dialog

Dialog: string

optionalDownAudio

DownAudio?: string[]

Inherited from CharacterTemplate.DownAudio

optionalEffect

Effect?: { End: number; Name: EffectType }

Type declaration

• End: number

• Name: EffectType

Experience

Experience: number

optionalExperienceValue

ExperienceValue?: number

Inherited from CharacterTemplate.ExperienceValue

FaceLeft

FaceLeft: boolean

Fix

Fix: boolean

optionalFlyingHeight

FlyingHeight?: number

Inherited from CharacterTemplate.FlyingHeight

ForceX

ForceX: number

ForceY

ForceY: number

Gravity

Gravity: number

Inherited from Projectile.Gravity

HalfBound

HalfBound: boolean

Health

Health: number

Inherited from CharacterTemplate.Health

optionalHealthPerLevel

HealthPerLevel?: number

Inherited from CharacterTemplate.HealthPerLevel

Height

Height: number

Inherited from CharacterTemplate.Height

HitAudio

HitAudio: string[]

Inherited from Projectile.HitAudio

HitBox

HitBox: RectTuple

Inherited from CharacterTemplate.HitBox

ID

ID: number

optionalIdleAudio

IdleAudio?: string[]

Inherited from CharacterTemplate.IdleAudio

optionalIdleTurnToFace

IdleTurnToFace?: boolean

Inherited from CharacterTemplate.IdleTurnToFace

Immunity

Immunity: number

IsProjectile

IsProjectile: true

Inherited from Projectile.IsProjectile

optionalJumpForce

JumpForce?: number

Inherited from CharacterTemplate.JumpForce

optionalJumpHitBox

JumpHitBox?: RectTuple

Inherited from CharacterTemplate.JumpHitBox

optionalJumpOdds

JumpOdds?: number

Inherited from CharacterTemplate.JumpOdds

Level

Level: number

optionalLoot

Loot?: { Expire: number; Name: ItemName }[]

Inherited from CharacterTemplate.Loot

optionalLootOdds

LootOdds?: number

Inherited from CharacterTemplate.LootOdds

optionalMagic

Magic?: number

Inherited from CharacterTemplate.Magic

optionalMagicPerLevel

MagicPerLevel?: number

Inherited from CharacterTemplate.MagicPerLevel

MaxHealth

MaxHealth: number

optionalMaxMagic

MaxMagic?: number

optionalMaxProjectile

MaxProjectile?: number

Name

Name: string

Inherited from CharacterTemplate.Name

NextJump

NextJump: number

optionalOnBind

OnBind?: () => void

Overrides CharacterTemplate.OnBind

Type declaration

• • (): void

  • Returns void

optionalPerk

Perk?: string

Inherited from CharacterTemplate.Perk

optionalPerkName

PerkName?: PerkName[]

Inherited from CharacterTemplate.PerkName

Petrified

Petrified: boolean

optionalPetrifyOnWound

PetrifyOnWound?: boolean

Inherited from CharacterTemplate.PetrifyOnWound

optionalProjectile

Projectile?: number

Inherited from CharacterTemplate.Projectile

ProjectileAim

ProjectileAim: number

optionalProjectileBothSides

ProjectileBothSides?: boolean

Inherited from CharacterTemplate.ProjectileBothSides

optionalProjectileDamage

ProjectileDamage?: number[]

Inherited from CharacterTemplate.ProjectileDamage

ProjectileForce

ProjectileForce: number

Inherited from Projectile.ProjectileForce

optionalProjectileHitAudio

ProjectileHitAudio?: string[]

Inherited from CharacterTemplate.ProjectileHitAudio

optionalProjectileName

ProjectileName?: ProjectileName

Inherited from CharacterTemplate.ProjectileName

optionalProjectileOdds

ProjectileOdds?: number

Inherited from CharacterTemplate.ProjectileOdds

optionalProjectileTime

ProjectileTime?: number

Inherited from CharacterTemplate.ProjectileTime

optionalProjectileType

ProjectileType?: ProjectileType

Inherited from CharacterTemplate.ProjectileType

RiseTime

RiseTime: number

Run

Run: boolean

optionalRunHeight

RunHeight?: number

Inherited from CharacterTemplate.RunHeight

optionalRunOdds

RunOdds?: number

Inherited from CharacterTemplate.RunOdds

optionalRunSpeed

RunSpeed?: number

Inherited from CharacterTemplate.RunSpeed

optionalStandAttackSlowOdds

StandAttackSlowOdds?: number

Inherited from CharacterTemplate.StandAttackSlowOdds

Status

Status: string

Inherited from CharacterTemplate.Status

WalkSpeed

WalkSpeed: number

Inherited from CharacterTemplate.WalkSpeed

Width

Width: number

Inherited from CharacterTemplate.Width

X

X: number

Y

Y: number

CharacterTemplate

CharacterTemplate:

Animation

Animation: AnimationSpec[]

optionalAttack

Attack?: { Cooldown?: number; Damage?: number[]; HitAnimation?: number[]; HitAudio?: string[]; HitBox?: RectTuple; JumpForce?: number; Magic?: number; Name: string; Speed: number; StartAudio?: string[] }[]

optionalBindAudio

BindAudio?: string[]

optionalCollisionDamage

CollisionDamage?: number

CrawlSpeed

CrawlSpeed: number

optionalDamageAudio

DamageAudio?: string[]

optionalDamageBackOdds

DamageBackOdds?: number

optionalDamageFaceOdds

DamageFaceOdds?: number

optionalDamageKnockForce

DamageKnockForce?: number

optionalDownAudio

DownAudio?: string[]

optionalExperienceValue

ExperienceValue?: number

optionalFlyingHeight

FlyingHeight?: number

Health

Health: number

optionalHealthPerLevel

HealthPerLevel?: number

Height

Height: number

HitBox

HitBox: RectTuple

optionalIdleAudio

IdleAudio?: string[]

optionalIdleTurnToFace

IdleTurnToFace?: boolean

optionalJumpForce

JumpForce?: number

optionalJumpHitBox

JumpHitBox?: RectTuple

optionalJumpOdds

JumpOdds?: number

optionalLoot

Loot?: { Expire: number; Name: ItemName }[]

optionalLootOdds

LootOdds?: number

optionalMagic

Magic?: number

optionalMagicPerLevel

MagicPerLevel?: number

Name

Name: string

optionalOnBind

OnBind?: () => void

Type declaration

• • (): void

  • Returns void

optionalPerk

Perk?: string

optionalPerkName

PerkName?: PerkName[]

optionalPetrifyOnWound

PetrifyOnWound?: boolean

optionalProjectile

Projectile?: number

optionalProjectileBothSides

ProjectileBothSides?: boolean

optionalProjectileDamage

ProjectileDamage?: number[]

optionalProjectileHitAudio

ProjectileHitAudio?: string[]

optionalProjectileName

ProjectileName?: ProjectileName

optionalProjectileOdds

ProjectileOdds?: number

optionalProjectileTime

ProjectileTime?: number

optionalProjectileType

ProjectileType?: ProjectileType

optionalRunHeight

RunHeight?: number

optionalRunOdds

RunOdds?: number

optionalRunSpeed

RunSpeed?: number

optionalStandAttackSlowOdds

StandAttackSlowOdds?: number

Status

Status: string

WalkSpeed

WalkSpeed: number

Width

Width: number

Cooldown

Cooldown:

Delay

Delay: number

Time

Time: number

Type

Type: CooldownType

DialogCharacter

DialogCharacter:

Color

Color: string

optionalDomination

Domination?: number

optionalIdlePose

IdlePose?: CharacterStatus[]

optionalLove

Love?: number

optionalLoverLevel

LoverLevel?: number

optionalLoverName

LoverName?: string

Name

Name: string

optionalNickName

NickName?: string

optionalOwnerLevel

OwnerLevel?: number

optionalOwnerName

OwnerName?: string

DummyTemplate

DummyTemplate:

Animation

Animation: AnimationSpec[]

Height

Height: number

optionalLoot

Loot?: { Expire: number; Name: ItemName }[]

Name

Name: string

optionalOnBind

OnBind?: () => void

Type declaration

• • (): void

  • Returns void

Status

Status: string

Width

Width: number

Event

Event:

Item

Item:

Description

Description: string

DisplayName

DisplayName: string

Name

Name: ItemName

OnGive

OnGive: (Char: DialogCharacter) => void

Type declaration

• • (Char: DialogCharacter): void

  • Parameters

    • Char: DialogCharacter

    Returns void

PartyMember

PartyMember:

Character

Character: string

Experience

Experience: number

Level

Level: number

Perk

Perk: string

Status

Status: CharacterStatus

Projectile

Projectile:

Gravity

Gravity: number

HitAudio

HitAudio: string[]

IsProjectile

IsProjectile: true

ProjectileForce

ProjectileForce: number

Room

Room:

optionalAlternateBackground

AlternateBackground?: string

Background

Background: string

optionalBackgroundFilter

BackgroundFilter?: string

optionalCharacter

Character?: { Battle?: boolean; Combat?: boolean; Dialog?: string; Fix?: boolean; Name: string; Status: string; X: number }[]

optionalDoor

Door?: { FromH: number; FromType: RoomType; FromW: number; FromX: number; FromY: number; Name: string; ToFaceLeft?: boolean; ToX: number }[]

optionalEntry

Entry?: () => void

Type declaration

• • (): void

  • Returns void

optionalHeal

Heal?: number

optionalHeight

Height?: number

optionalLimitLeft

LimitLeft?: number

optionalLimitRight

LimitRight?: number

Music

Music: string

Name

Name: string

optionalText

Text?: string

optionalWidth

Width?: number

Type Aliases

AnimationName

AnimationName: Petrified | Bound | HalfBoundWounded | Wounded | Aim | AimReady | AimFull | Bind | Jump | HalfBoundJump | Crawl | Stun | HalfBoundStun | Walk | HalfBoundWalk | WalkHit | Run | HalfBoundRun | Crouch | Block | Idle | HalfBoundIdle | Uppercut | StandAttackFast | StandAttackSlow | CrouchAttackFast | CrouchAttackSlow | Scream | Backflip | FireProjectile | Left | Right

CharacterStatus

CharacterStatus: Maid | Oracle | Archer | Thief

CooldownType

CooldownType: AnimationName | EffectType

EffectType

EffectType: Teleport | Heal

EventType

EventType: ThiefBossIntro | ThiefBossDefeat | ThiefBossSecondDefeat | ThiefBossRetreat | EdlaranKey | EdlaranForestKey | EdlaranIntro | EdlaranCurseIntro | EdlaranUnlock | EdlaranBedroomIsabella | EdlaranCountessBedroomOrgasmDom | EdlaranCountessBedroomOrgasmSub | EdlaranWineCellar | EdlaranJoin | EdlaranForestIntro | IntroForestBandit | ForestBanditCrate | ForestCapture | ForestCaptureEnd | ForestCaptureRescueMelody | BarnThiefRescueMelody | CamilleEscape | CamilleDefeat | JealousMaid | CursedMaid | OliviaCollarKey | OliviaUnchain | OliviaBath | OliviaBathOrgasm | OliviaCurseIntro | OliviaCurseRelease | OliviaTerrace | OliviaTerraceKiss | OliviaCabin | EdlaranCabin | LynCabin | OliviaTent | EdlaranTent | LynTent | IntroGuard | IntroGuardCurse | DesertEntrance | Curse | LynJoin

ItemName

ItemName: RedRose | PoisonApple | LeatherWhip | AnimalCollar

KeyCode

KeyCode: string

Perk

Perk: string

PerkName

PerkName: Healthy | Robust | Vigorous | Spring | Impact | Block | Deflect | Seduction | Persuasion | Manipulation | Apprentice | Witch | Meditation | Scholar | Heal | Cure | Howl | Roar | Teleport | Freedom | Fletcher | Burglar | Athletic | Sprint | Backflip | Acrobat | Archery | Celerity | Capacity | Sneak | Backstab | Kidnapper | Rigger | Thief | Bounce | Inventory | Duplicate

ProjectileName

ProjectileName: Barrel | Arrow | Dagger

ProjectileType

ProjectileType: Wood | Iron

RoomType

RoomType: Up | Down | Left | Right

SoundCategory

SoundCategory: string

SoundEffect

SoundEffect: string