Interface ObjectComposition

interface ObjectComposition {
    getId(): number;
    getName(): string;
    getActions(): string[];
    getMapSceneId(): number;
    getMapIconId(): number;
    getImpostorIds(): number[];
    getImpostor(): ObjectComposition;
    getVarbitId(): number;
    getVarPlayerId(): number;
    getSizeX(): number;
    getSizeY(): number;
}

Index

Methods

getId getName getActions getMapSceneId getMapIconId getImpostorIds getImpostor getVarbitId getVarPlayerId getSizeX getSizeY

Methods

getId

getId(): number
Gets ID for the object.

Returns number

getName

getName(): string
Gets the name of the object.

Returns string

getActions

getActions(): string[]
The 5 menuops this NPC has when in world. Index 0 corresponds to MenuAction.GAME_OBJECT_FIRST_OPTION, Index 2 to MenuAction.GAME_OBJECT_SECOND_OPTION and so on.

Returns string[]

getMapSceneId

getMapSceneId(): number
Returns number

getMapIconId

getMapIconId(): number
Returns number

getImpostorIds

getImpostorIds(): number[]
Get the IDs of NPCs this can transform into, depending on a Varbit or VarPlayer id.

Returns number[]
null if this object can't transform

getImpostor

getImpostor(): ObjectComposition
Get the object composition the player's state says this object should transmogrify into.

Returns ObjectComposition
Throws
NullPointerException if getImpostorIds is null

getVarbitId

getVarbitId(): number
Gets the Varbit used to switch this multiloc, or -1 if this is not switched by a Varbit

Returns number
See
- getImpostor
- getImpostorIds

getVarPlayerId

getVarPlayerId(): number
Gets the Varbit used to switch this multiloc, or -1 if this is not switched by a VarPlayer

Returns number
See
- getImpostor
- getImpostorIds

getSizeX

getSizeX(): number
Get the size of the object on the X-axis in tiles

Returns number

getSizeY

getSizeY(): number
Get the size of the object on the Y-axis in tiles

Returns number