HouseOptions

Methods to interact with the house options that live on the options gametab.

_images/houseoptions.png

ERSHouseOptionsButton

ERSHouseOptionsButton = enum(CLOSE, VIEWER, EXPEL, SERVANT, LEAVE);

It should be self explanatory what they represent.


TRSHouseOptions

Main record responsible with interacting with the house options.


HouseOptions.SetupGameTab

procedure TRSHouseOptions.SetupGameTab();

Internal method used to setup the TRSHouseOptions coordinates. This is automatically called for you on the HouseOptions variable.


TRSHouseOptions.Buttons

Buttons: TBoxArray;

TBoxes for each of the HouseOptions buttons.

Example:

ShowOnTarget(HouseOptions.Buttons);
_images/houseoptions_buttons.png

You can also access each button with an index or, more conveniently, with a ERSHouseOptionsButton.

Example:

ShowOnTarget(HouseOptions.Buttons[ERSHouseOptionsButton.VIEWER]);
_images/houseoptions_button.png

HouseOptions.IsOpen

function TRSHouseOptions.IsOpen(): Boolean;

Returns True/False on whether the house options are open.

Example:

WriteLn HouseOptions.IsOpen();

HouseOptions.WaitOpen

function TRSHouseOptions.WaitOpen(time: Integer = 600; interval: Integer = -1): Boolean;

Returns true if the house options open within time milliseconds.

Example:

WriteLn HouseOptions.WaitOpen();

HouseOptions.Open

function TRSHouseOptions.Open(): Boolean;

Attempts to open the house options on the options gametab.

This method is overriden after Options, for more information check HouseOptions.Open override.

Example:

WriteLn HouseOptions.Open();

HouseOptions.Close

function TRSHouseOptions.Close(): Boolean;

Attempts to close the house options.

Example:

WriteLn HouseOptions.Close();

HouseOptions.ExpelGuests

function TRSHouseOptions.ExpelGuests(): Boolean;

Attempts to expel guests through the house options button.

Example:

WriteLn HouseOptions.ExpelGuests();

HouseOptions.CallServant

function TRSHouseOptions.CallServant(): Boolean;

Attempts to call the house servant through the house options button.

For this to work you need to have a servant at your house and a bell-pull.

Example:

WriteLn HouseOptions.CallServant();

HouseOptions.LeaveHouse

function TRSHouseOptions.LeaveHouse(): Boolean;

Attempts to leave the house through the house options button.

Example:

WriteLn HouseOptions.LeaveHouse();

HouseOptions variable

Global TRSHouseOptions variable.