# Logout
Methods to interact with the logout tab.
```{figure} ../../images/inventory.png
```


- - -

## ERSRating
```pascal
ERSRating = (ONE, TWO, THREE, FOUR, FIVE);
```
Enum representing the star buttons on the {ref}`Logout` gametab.


- - -

## ERSLogoutButton
```pascal
ERSLogoutButton = (WORLD_SWITCHER, CLICK_HERE);
```
Enum representing the buttons available on the {ref}`Logout` gametab.


- - -

## TRSLogout
Main record that holds and the methods to interact with the logout gametab.


- - -

## Logout.SetupGameTab
```pascal
procedure TRSLogout.SetupGameTab();
```
Internal method used to setup {ref}`TRSLogout` coordinates.
This is called automatically for you on the {ref}`Logout variable`.


- - -

## TRSLogout.Ratings
```pascal
Ratings: array [ERSRating] of TRSButton;
```
`TRSButton` for each of the {ref}`Logout` rating buttons.

Example:
```pascal
ShowOnTarget(Logout.Ratings);
```
```{figure} ../../images/logout_ratings.png
```

You can also access each button with an index or, more conveniently, with a
{ref}`ERSRating`.

Example:
```pascal
ShowOnTarget(Logout.Ratings[ERSRating.THREE]);
```
```{figure} ../../images/logout_rating.png
```


- - -

## TRSLogout.Buttons
```pascal
Buttons: array [ERSLogoutButton] of TRSButton;
```
`TRSButton` for each of the {ref}`Logout` buttons.

Example:
```pascal
ShowOnTarget(Logout.Buttons);
```
```{figure} ../../images/logout_buttons.png
```

You can also access each button with an index or, more conveniently, with a
{ref}`ERSLogoutButton`.

Example:
```pascal
ShowOnTarget(Logout.Buttons[ERSLogoutButton.WORLD_SWITCHER]);
```
```{figure} ../../images/logout_button.png
```


- - -

## Logout.IsOpen
```pascal
function TRSLogout.IsOpen(): Boolean;
```
Returns true if the logout gametab is open, false if it's not.

Example:
```pascal
WriteLn Logout.IsOpen();
```


- - -

## Logout.Open
```pascal
function TRSLogout.Open(): Boolean;
```
Attempts to open the logout tab, returns true if it succeeds.

Example:
```pascal
WriteLn Logout.Open();
```


- - -

## Logout.IsRated
```pascal
function TRSLogout.IsRated(): Boolean;
```
Returns true if a star button was clicked.

Example:
```pascal
WriteLn Logout.IsRated();
```


- - -

## Logout.Rate
```pascal
function TRSLogout.Rate(star: ERSRating): Boolean;
```
Click a star button to rate the game.

Example:
```pascal
WriteLn Logout.Rate(ERSRating.FOUR);
```


- - -

## Logout.Logout
```pascal
function TRSLogout.Logout(attempts: UInt32 = 5; time: UInt32 = 20000): Boolean;
```
Attempts to logout of the game. Returns true if we succesfully logout of the game.
If the {ref}`WorldSwitcher` is open, we will use {ref}`WorldSwitcher.Logout` instead.

Example:
```pascal
WriteLn Logout.Logout();
```


- - -

## Logout variable
Global {ref}`TRSLogout` variable.