Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Actions

Index

Variables

registered

registered: object

Type declaration

Functions

add

addFuel

  • Parameters

    Returns void

attack

  • Parameters

    • weaponHandle: IItem | null
    • Default value attackType: AttackType | null = null

    Returns void

attackGeneric

  • Parameters

    Returns boolean

build

  • build(item: IItem): void
  • Parameters

    Returns void

canTryCarve

  • canTryCarve(): boolean
  • Returns boolean

carve

  • carve(item: IItem): void
  • canTryCarve should check the same things as this

    Parameters

    Returns void

closeDoor

  • closeDoor(): boolean
  • Returns boolean

consume

  • Parameters

    Returns boolean

consumeItem

  • Parameters

    Returns void

cure

  • cure(item: IItem): void
  • Parameters

    Returns void

decode

  • decode(item: IItem): boolean
  • Parameters

    Returns boolean

dig

  • dig(tool?: IItem | null): void
  • Parameters

    • Optional tool: IItem | null

    Returns void

disassemble

  • disassemble(item: IItem): void
  • Parameters

    Returns void

dismantle

  • dismantle(item: IItem): void
  • Parameters

    Returns void

drawMap

  • drawMap(paper: IItem): void
  • Parameters

    Returns void

drink

  • drink(item: IItem): void
  • Parameters

    Returns void

eat

  • Parameters

    Returns void

execute

  • Parameters

    • use: ActionType
    • item: IItem | null
    • Default value itemBypass: boolean = false

    Returns void

extinguish

  • extinguish(torch: IItem): void
  • Parameters

    Returns void

fillWater

  • fillWater(waterskin: IItem): void
  • Parameters

    Returns void

fire

  • fire(weapon: IItem): void
  • Parameters

    Returns void

fishing

  • fishing(tool: IItem): void
  • Parameters

    Returns void

garden

  • garden(item: IItem): void
  • Parameters

    Returns void

gather

  • gather(tool?: IItem | null, toolBypass?: boolean): void
  • Parameters

    • Optional tool: IItem | null
    • Default value toolBypass: boolean = false

    Returns void

gatherTreasure

  • gatherTreasure(tool: IItem): void
  • Parameters

    Returns void

heal

  • heal(item: IItem): void
  • Parameters

    Returns void

healCreature

  • healCreature(item: IItem): void
  • Parameters

    Returns void

hurtTerrain

  • hurtTerrain(x: number, y: number, z: number, tile: ITile): boolean
  • Parameters

    • x: number
    • y: number
    • z: number
    • tile: ITile

    Returns boolean

inspect

  • inspect(tileX: any, tileY: number): void
  • Parameters

    • tileX: any
    • tileY: number

    Returns void

lightItem

  • lightItem(item: IItem): void
  • Parameters

    Returns void

lockpick

  • lockpick(lockpick: IItem): void
  • Parameters

    Returns void

openBottle

  • openBottle(bottle: IItem): void
  • Parameters

    Returns void

openContainer

  • openContainer(container: IContainer, containerName: string, silent?: boolean): void
  • Parameters

    • container: IContainer
    • containerName: string
    • Optional silent: boolean

    Returns void

openDoor

  • openDoor(): boolean
  • Returns boolean

pet

  • pet(): void
  • Returns void

placeTile

  • placeTile(item: IItem): void
  • Parameters

    Returns void

plant

  • plant(item: IItem): void
  • Parameters

    Returns void

pour

  • pour(item: IItem): void
  • Parameters

    Returns void

pourOnYourself

  • pourOnYourself(item: IItem): void
  • Parameters

    Returns void

preserve

  • preserve(preserver: IItem, preservee?: IItem | null): void
  • Parameters

    • preserver: IItem
    • Default value preservee: IItem | null = null

    Returns void

raft

  • raft(raftItem: IItem): void
  • Parameters

    Returns void

read

  • read(item: IItem): void
  • Parameters

    Returns void

reduceDismantleWeight

  • reduceDismantleWeight(createdItems: IItemArray, itemWeight: number, mod?: number): void
  • Parameters

    • createdItems: IItemArray
    • itemWeight: number
    • Default value mod: number = 0

    Returns void

reinforce

  • reinforce(reinforcer: IItem, reinforcee?: IItem | null): void
  • Parameters

    • reinforcer: IItem
    • Default value reinforcee: IItem | null = null

    Returns void

release

  • release(): void
  • Returns void

remove

  • Parameters

    Returns void

repair

  • Parameters

    Returns void

rest

  • Parameters

    Returns void

rub

  • rub(item: IItem, clockwise: boolean): void
  • Parameters

    • item: IItem
    • clockwise: boolean

    Returns void

shoot

  • shoot(weapon: IItem): void
  • Parameters

    Returns void

sleep

  • sleep(item: IItem): void
  • Parameters

    Returns void

sling

  • sling(weapon: IItem): void
  • Parameters

    Returns void

squeeze

  • squeeze(item: IItem): void
  • Parameters

    Returns void

startFire

  • startFire(item: IItem): void
  • Parameters

    Returns void

stokeFire

  • stokeFire(item: IItem): void
  • Parameters

    Returns void

tame

  • tame(): void
  • Returns void

teleport

  • teleport(item: IItem): void
  • Parameters

    Returns void

tellTime

  • tellTime(item: IItem): void
  • Parameters

    Returns void

transmogrify

  • transmogrify(transmogrifier: IItem, transmogrifee?: IItem | null): void
  • Parameters

    • transmogrifier: IItem
    • Optional transmogrifee: IItem | null

    Returns void

travelAway

  • travelAway(boat: IItem, toAnotherIsland: boolean): void
  • Parameters

    • boat: IItem
    • toAnotherIsland: boolean

    Returns void

Generated using TypeDoc