House Misc¶

Collection of enums and function utilities for the WaspLib’s House handler.

Everything in this page are helper utilities that you are unlikely to ever need to use directly.

EHouseLocation¶

EHouseLocation = enum(RIMMINGTON..PRIFDDINAS);

Enum representing the House locations in game.

EHouseDecoration¶

EHouseDecoration = enum(WOOD..WINTER);
Enum representing the {ref}`House`

EHouseDecoration.GetColors¶

function EHouseDecoration.GetColors(): THouseColor;

Returns the color palette of the current EHouseDecoration as a THouseColor.

Example:

WriteLn EHouseDecoration.FREMENNIK.GetColors();

EHouseRoom¶

EHouseRoom = enum(UNKNOWN, GARDEN..WORKSHOP);

Enum representing the House rooms available.

EHouseRoom.IsOutdoors¶

function EHouseRoom.IsOutdoors(): Boolean;

Returns True/False whether a EHouseRoom is an outdoors room or not.

Example:

WriteLn EHouseRoom.GARDEN.IsOutdoors();

EHouseObject¶

EHouseObject = enum(EXIT, REPAIR_STAND..OCCULT_ALTAR, CAPE_HANGER);

Enum representing the TRSObjects available in a House.

This doesn’t cover everything a house can have but should cover everything that is of interest for a script.

Constants¶

KITCHEN_LARDERS
STUDY_LECTERNS
CHAPEL_BURNERS
CHAPEL_ALTARS
SUPERIOR_GARDEN_POOLS
SUPERIOR_GARDEN_TELEPORTS
JEWELLERY_BOXES
ACHIEVEMENT_GALLERY_ALTARS

Several constants represeting multiple tiers of house objects that functional virtually the same way.

EHouseObject.GetSize¶

function EHouseObject.GetSize(): TVector3;

Returns the TVector3 that represents the object size in 3D space, X and Y is measured in tiles.

For example, an object that is [1, 2, 6] would be the size of an object that is 1 tile from West to East, 2 tiles from North to South and roughly the player height.

EHouseObject.GetOffset¶

function EHouseObject.GetOffset(): TPoint;

Returns the coordinate of the object in the room it belongs to. This assumes the room is not rotated, if you think you need this, in reality you probably want to use EHouseObject.RotatedOffset.

EHouseObject.RotatedOffset¶

function EHouseObject.RotatedOffset(size, rotation: Integer): TPoint;

Returns the coordinate of the object in the room regardeless of it’s rotation.

EHouseObject.GetUpText¶

function EHouseObject.GetUpText(): TStringArray;

Returns a UpText for the current EHouseObject.

Example:

WriteLn EHouseObject.SPIRIT_TREE.GetUpText();

EHouseObject.GetFinder¶

function EHouseObject.GetFinder(): TColorFinder;

Returns a TColorFinder for the current EHouseObject.

Example:

EHouseObject.SPIRIT_TREE.GetFinder().Find(atpa);
ShowOnTarget(atpa);

EHouseTeleport¶

EHouseTeleport = enum(EMPTY, ARCEUUS_LIBRARY..XERIC);

Enum represinting all the available teleports in a House.

EHouseTeleport.GetUpText¶

function EHouseTeleport.GetUpText(): TStringArray;

Returns a UpText for the current EHouseTeleport.

Example:

WriteLn EHouseTeleport.FALADOR.GetUpText();

EHouseTeleport.GetFinder¶

function EHouseTeleport.GetFinder(): TColorFinder;

Returns a TColorFinder for the current EHouseTeleport.

Example:

EHouseTeleport.FALADOR.GetFinder().Find(atpa);
ShowOnTarget(atpa);

THouseRoom¶

Type helper to represent a house room. This type will hold the Room EHouseRoom type, information about it’s Rotation and the Objects it holds as a set of EHouseObject.

THouseRoomMatrix¶

2D array of THouseRoom.

THouseRoomMatrix.ToBytes¶

function THouseRoomMatrix.ToBytes(): TByteArray;

Encode a THouseRoomMatrix into bytes. Useful for storing them.

THouseRoomMatrix.ToBytes¶

function THouseRoomMatrix.ToBytes(): TByteArray;

Decode a THouseRoomMatrix from bytes. Useful to load them from storage.

TTeleportRoom¶

Type helper to represent a house teleport room.

TTeleportRoomMatrix¶

2D array of TTeleportRoom.

TTeleportRoomMatrix.ToBytes¶

function TTeleportRoomMatrix.ToBytes(): TByteArray;

Encode a TTeleportRoomMatrix into bytes. Useful for storing them.

TTeleportRoomMatrix.ToBytes¶

function TTeleportRoomMatrix.ToBytes(): TByteArray;

Decode a TTeleportRoomMatrix from bytes. Useful to load them from storage.

EHouseTeleportMode¶

EHouseTeleportMode = enum(SPELL, TABLET, CAPE);

Enum representing modes of teleporting the the POH.

EHouseTeleportPlace¶

EHouseTeleportPlace = enum(UNKNOWN, INSIDE, OUTSIDE);

Enum representing modes of teleporting the the POH.