# Functions

## Server:

<details>

<summary>Server</summary>

## convertGold

{% code lineNumbers="true" %}

```php
Server::convertGold($gold);
return string

1kkk
1kk
1k
```

{% endcode %}

## convertLocation

{% code lineNumbers="true" %}

```php
Server::convertLocation($location_id);
return string

'0' => 'All',
'1' => 'Africa',
'2' => 'Antarctica',
'3' => 'Asia',
'4' => 'Australia/Oceania',
'5' => 'Europe',
'6' => 'North America',
'7' => 'South America'
```

{% endcode %}

## convertLocationInitials

{% code lineNumbers="true" %}

```php
Server::convertLocationInitials($location_id);
return string

'0' => 'All',
'1' => 'EUR',
'2' => 'USA',
'3' => 'EUR',
'4' => 'EUR',
'5' => 'EUR',
'6' => 'USA',
'7' => 'BRA'
```

{% endcode %}

## getLocationIcon

{% code lineNumbers="true" %}

```php
Server::getLocationIcon($location_id);
return string

'0' => '/global/content/option_server_location_all.png',
'1' => '/global/content/option_server_location_', // no exists
'2' => '/global/content/option_server_location_', // no exists
'3' => '/global/content/option_server_location_', // no exists
'4' => '/global/content/option_server_location_', // no exists
'5' => '/global/content/option_server_location_eur.png',
'6' => '/global/content/option_server_location_usa.png',
'7' => '/global/content/option_server_location_bra.png'
```

{% endcode %}

## convertPvpType

{% code lineNumbers="true" %}

```php
Server::convertPvpType($pvp_type);
return string

'0' => 'Open PvP',
'1' => 'Optional PvP',
'2' => 'Hardcore PvP',
'3' => 'Retro Open PvP',
'4' => 'Retro Hardcore PvP'
```

{% endcode %}

## convertPvpTypeToCreateAccount

{% code lineNumbers="true" %}

```php
Server::convertPvpTypeToCreateAccount($pvp_type);
return string

'0' => 'open',
'1' => 'optional',
'2' => 'hardcore',
'3' => 'Retro Open',
'4' => 'Retro Hardcore'
```

{% endcode %}

## getPvpTypeIcon

{% code lineNumbers="true" %}

```php
Server::getPvpTypeIcon($pvp_type);
return string

'0' => '/global/content/option_server_pvp_type_open.gif',
'1' => '/global/content/option_server_pvp_type_optional.gif',
'2' => '/global/content/option_server_pvp_type_hardcore.gif',
'3' => '/global/content/option_server_pvp_type_retro.gif',
'4' => '/global/content/option_server_pvp_type_retrohardcore.gif'
```

{% endcode %}

## getWorldQuests

{% code lineNumbers="true" %}

```php
Server::getWorldQuests();
return array

[
    'name' => 'World Quest Name',
    'description' => 'Descrição'
]
```

{% endcode %}

## convertTown

{% code lineNumbers="true" %}

```php
Server::convertTown($town_id);
return string
```

{% endcode %}

## convertTransferType

{% code lineNumbers="true" %}

```php
Server::convertTransferType($transfertype_id);
return string

'0' => 'blocked',
'1' => 'released'
```

{% endcode %}

## convertPremiumType

{% code lineNumbers="true" %}

```php
Server::convertPremiumType($premium_type);
return string

'0' => 'premium',
'1' => 'free premium'
```

{% endcode %}

## convertBattleEye

{% code lineNumbers="true" %}

```php
Server::convertBattleEye($battleEye_id);
return string

'0' => 'Not protected by BattlEye.',
'1' => 'Protected by BattlEye for a while.',
'2' => 'Protected by BattlEye since its release.'
```

{% endcode %}

## convertBattleEyeIcon

{% code lineNumbers="true" %}

```php
Server::convertBattleEyeIcon($battleEye_id);
return string

'0' => '/global/content/icon_battleye.gif',
'1' => '/global/content/icon_battleyeinitial.gif',
'2' => '/global/content/icon_battleyeinitial.gif'
```

{% endcode %}

## convertWorldType

{% code lineNumbers="true" %}

```php
Server::convertWorldType($worldtype_id);
return string

'0' => 'Regular',
'1' => 'Experimental'
```

{% endcode %}

## getRecordPlayers

{% code lineNumbers="true" %}

```php
Server::getRecordPlayers($world_id = 1);
return array

[
    'record' => 0,
    'timestamp' => 10/30/2022 11:00:00
]
```

{% endcode %}

## getRecordPlayersWorlds

{% code lineNumbers="true" %}

```php
Server::getRecordPlayersWorlds();
return array

[
    'record' => 0,
    'timestamp' => 10/30/2022 11:00:00
]
```

{% endcode %}

## getPlayersOnline

{% code lineNumbers="true" %}

```php
Server::getPlayersOnline();
return array

[
    [
        'name' => 'Player Sample',
        'vocation' => 1,
        'level' => 10
    ],
]
```

{% endcode %}

## getCountPlayersOnline

{% code lineNumbers="true" %}

```php
Server::getCountPlayersOnline();
return int
```

{% endcode %}

## getServerStatus

{% code lineNumbers="true" %}

```php
Server::getServerStatus();
return string
```

{% endcode %}

## getMonsterImage

{% code lineNumbers="true" %}

```php
Server::getMonsterImage();
return string
```

{% endcode %}

## getBoostedBoss

{% code lineNumbers="true" %}

```php
Server::getBoostedBoss();
return array

[
    'image_url' => string,
    'looktype' => 87,
    'lookfeet' => 0,
    'looklegs' => 0,
    'lookhead' => 0,
    'lookbody' => 0,
    'lookaddons' => 0,
    'lookmount' => 0,
    'date' => 156489,
    'boostname' => 'Demon',
    'raceid' => 1
]
```

{% endcode %}

## getBoostedCreature

{% code lineNumbers="true" %}

```php
Server::getBoostedCreature();
return array

[
    'image_url' => string,
    'looktype' => 87,
    'lookfeet' => 0,
    'looklegs' => 0,
    'lookhead' => 0,
    'lookbody' => 0,
    'lookaddons' => 0,
    'lookmount' => 0,
    'date' => 156489,
    'boostname' => 'Demon',
    'raceid' => 1
]
```

{% endcode %}

## getWorlds

{% code lineNumbers="true" %}

```php
Server::getWorlds();
return array

[
    [
        'id' => 1,
        'name' => 'Canary',
        'creation' => 10/30/2022 11:00:00,
        'creation_int' => 453123,
        'location' => Server::convertLocation($location),
        'location_icon' => Server::getLocationIcon($location),
        'location_initial' => Server::convertLocationInitials($location),
        'pvp_type' => Server::convertPvpType($pvp_type),
        'pvp_type_icon' => Server::getPvpTypeIcon($pvp_type),
        'pvp_type_initial' => Server::convertPvpTypeToCreateAccount($pvp_type),
        'premium_type' => Server::convertPremiumType($premium_type),
        'transfer_type' => Server::convertTransferType($transfer_type),
        'world_quests' => Server::getWorldQuests(),
        'battle_eye' => Server::convertBattleEye($battle_eye),
        'battle_eye_int' => 1,
        'battle_eye_icon' => Server::convertBattleEyeIcon($battle_eye),
        'world_type' => Server::convertWorldType($world_type),
        'players_record' => Server::getRecordPlayers($id),
        'players_online' => Server::getCountPlayersOnline(),
        'server_status' => Server::getServerStatus(),
        'ipaddress' => 127.0.0.1,
        'port' => 7172,
    ],
]
```

{% endcode %}

## getWorldById

{% code lineNumbers="true" %}

```php
Server::getWorldById($world_id);
return array

[
    'id' => 1,
    'name' => 'Canary',
    'creation' => 10/30/2022 11:00:00,
    'location' => Server::convertLocation($location),
    'location_icon' => Server::getLocationIcon($location),
    'pvp_type' => Server::convertPvpType($pvp_type),
    'pvp_type_icon' => Server::getPvpTypeIcon($pvp_type),
    'premium_type' => Server::convertPremiumType($premium_type),
    'transfer_type' => Server::convertTransferType($transfer_type),
    'world_quests' => Server::getWorldQuests(),
    'battle_eye' => Server::convertBattleEye($battle_eye),
    'battle_eye_icon' => Server::convertBattleEyeIcon($battle_eye),
    'world_type' => Server::convertWorldType($world_type),
    'players_record' => Server::getRecordPlayers($id),
    'players_online' => Server::getCountPlayersOnline(),
    'server_status' => Server::getServerStatus(),
    'ipaddress' => 127.0.0.1,
    'port' => 7172,
]
```

{% endcode %}

</details>

## Player:

<details>

<summary>Player</summary>

## getAllCharacters

{% code lineNumbers="true" %}

```php
Player::getAllCharacters($account_id);
return array

[
  [
    'id' => 1,
    'name' => 'Player Sample',
    'level' => 8,
    'vocation' => 'Sorcerer',
    'main' => 1,
    'world' => 1,
    'online' => false,
    'outfit' => [
      'image_url' => string URL,
      'lookbody' => 130,
      'lookfeet' => 10,
      'lookhead' => 0,
      'looklegs' => 0,
      'looktype' => 10,
      'lookaddons' => 0,
    ],
    'group' => 'Player',
    'marriage' => [
      'status' => 1,
      'spouse' => 'Sample Druid',
    ],
    'deletion' => 0,
    'display' => [
      'account' => 0,
      'outfit' => 0,
      'inventory' => 0,
      'health_mana' => 0,
      'skills' => 0,
      'bonus' => 1,
      'comment' => 'Comentário string',
    ],
  ],
]
```

{% endcode %}

## convertVocation

{% code lineNumbers="true" %}

```php
Player::convertVocation($vocation_id);
return string

'0' => 'None',
'1' => 'Sorcerer',
'2' => 'Druid',
'3' => 'Paladin',
'4' => 'Knight',
'5' => 'Master Sorcerer',
'6' => 'Elder Druid',
'7' => 'Royal Paladin',
'8' => 'Elite Knight',
```

{% endcode %}

## convertMarried

{% code lineNumbers="true" %}

```php
Player::convertMarried($player_id);
return array

[
  'status' => 1,
  'spouse' => 'Player Sample',
]
```

{% endcode %}

## getAchievements

{% code lineNumbers="true" %}

```php
Player::getAchievements($player_id, $storage);
return array
[
  [
    'key' => 30000,
    'value' => 50594264,
  ],
  [
    'key' => 30000,
    'value' => 50594264,
  ],
]
```

{% endcode %}

## getAchievementPoints

{% code lineNumbers="true" %}

```php
Player::getAchievementPoints($player_id);
return int
```

{% endcode %}

## convertWorld

{% code lineNumbers="true" %}

```php
Player::convertWorld($world_id);
return string
```

{% endcode %}

## getOutfitImage

{% code lineNumbers="true" %}

```php
Player::getOutfitImage($looktype = 0, $lookaddons = 0, $lookbody = 0, $lookfeet = 0, $lookhead = 0, $looklegs = 0, $mount = 0);
return string URL Outfit Imagem
```

{% endcode %}

## getOutfit

{% code lineNumbers="true" %}

```php
Player::getOutfit($player_id);
return array

[
  'image_url' => string URL,
  'lookbody' => 128,
  'lookfeet' => 10,
  'lookhead' => 10,
  'looklegs' => 0,
  'looktype' => 0,
  'lookaddons' => 0,
]
```

{% endcode %}

## getEquipaments

{% code lineNumbers="true" %}

```php
Player::getEquipaments($player_id);
return array

[
  'url' => string só nome da imagem (3028.gif),
  'pid' => 0,
  'sid' => 0,
  'itemtype' => 0,
  'count' => 1
]
```

{% endcode %}

## getSkull

{% code lineNumbers="true" %}

```php
Player::getSkull($player_id);
return string

0 => '',
1 => 'yellow_skull.gif',
2 => 'green_skull.gif',
3 => 'white_skull.gif',
4 => 'red_skull.gif',
5 => 'black_skull.gif'
```

{% endcode %}

## getSkullTime

{% code lineNumbers="true" %}

```php
Player::getSkullTime($player_id);
return boolean
```

{% endcode %}

## getDisplay

{% code lineNumbers="true" %}

```php
Player::getDisplay($player_id);
return array

[
  'account' => 1,
  'outfit' => 1,
  'inventory' => 0,
  'health_mana' => 1,
  'skills' => 1,
  'bonus' => 0,
  'comment' => 'Comentário string',
]p
```

{% endcode %}

## getHouse

{% code lineNumbers="true" %}

```php
Player::getHouse($player_id);
return array

[
  [
    'id' => 358,
    'owner' => 1,
    'paid' => 0,
    'warnings' => 0,
    'name' => 'House Name',
    'rent' => 350000,
    'town_id' => 1,
    'bid' => 1,
    'bid_end' => 0,
    'last_bid' => 0,
    'highest_bidder' => 1,
    'size' => 68,
    'guildid' => 1,
    'beds' => 10,
  ],
]
```

{% endcode %}

## isOnline

{% code lineNumbers="true" %}

```php
Player::isOnline($player_id);
return boolean
```

{% endcode %}

## convertLastLogin

{% code lineNumbers="true" %}

```php
Player::convertLastLogin($lastlogin);
return string
```

{% endcode %}

## convertPremy

{% code lineNumbers="true" %}

```php
Player::convertPremy($account_id);
return string
```

{% endcode %}

## getPremDays

{% code lineNumbers="true" %}

```php
Player::getPremDays($account_id);
return date('d m Y')
```

{% endcode %}

## getCoins

{% code lineNumbers="true" %}

```php
Player::getCoins($account_id);
return float
```

{% endcode %}

## getGuildMember

{% code lineNumbers="true" %}

```php
Player::getGuildMember($player_id);
return array

[
  'guild_id' => 1,
  'guild_name' => 'Guild Name',
  'rank_id' => 1,
  'nick' => 'Nick player',
  'rank_name' => 'Leader',
];
```

{% endcode %}

## getGuildOwner

{% code lineNumbers="true" %}

```php
Player::getGuildOwner($player_id);
return array

[
  [
    'level' => 1,
    'name' => 'Name',
    'ownerid' => 1,
    'creationdata' => 1042758,
    'motd' => 'Motd Guild',
    'residence' => 1047,
    'balance' => 0,
    'points' => 0,
  ],
];
```

{% endcode %}

## getDeaths

{% code lineNumbers="true" %}

```php
Player::getDeaths($player_id);
return array

[
  [
    'time' => 16578912,
    'description' => 'Killed at level 100 by Demon (soloed)',
  ],
];
```

{% endcode %}

## getFrags

{% code lineNumbers="true" %}

```php
Player::getFrags($player_id);
return array

[
  'time' => 15678641,
  'description' => 'Fragged Player Sample at level 100.',
  'unjustified' => 0,
];
```

{% endcode %}

## convertSex

{% code lineNumbers="true" %}

```php
Player::convertSex($sex_id);
return string

'1' => 'male',
'0' => 'female'
```

{% endcode %}

## convertGroup

{% code lineNumbers="true" %}

```php
Player::convertGroup($group_id);
return string
```

{% endcode %}

## convertTown

{% code lineNumbers="true" %}

```php
Player::convertTown($town_id);
return string
```

{% endcode %}

## getPlayerStorage

{% code lineNumbers="true" %}

```php
Player::getPlayerStorage($player_id, $storage);
return boolean
```

{% endcode %}

## getPlayerStorageByValue

{% code lineNumbers="true" %}

```php
Player::getPlayerStorageByValue($player_id, $storage, $value);
return boolean
```

{% endcode %}

</details>

## Guilds:

<details>

<summary>Guilds</summary>

## getGuilds

{% code lineNumbers="true" %}

```php
Guilds::getGuilds();
return array

[
    [
        'id' => 1,
        'level' => 1,
        'name' => 'Guild Name',
        'ownerid' => 1,
        'creationdata' => date('d M Y H:i'),
        'motd' => 'Motd Guild',
        'residence' => 1,
        'balance' => 0,
        'points' => 0,
        'description' => 'Descrição da guild.',
        'logo_name' => 'image name.gif',
    ],
]
```

{% endcode %}

## getGuildbyId

{% code lineNumbers="true" %}

```php
Guilds::getGuildbyId($guild_id);
return array

[
    'id' => 1,
    'level' => 1,
    'name' => 'Guild Name',
    'ownerid' => 1,
    'creationdata' => date('M d Y'),
    'motd' => 'Motd Guild',
    'residence' => 1,
    'balance' => 0,
    'points' => 0,
    'description' => 'Descrição da guild.',
    'logo_name' => 'image name.gif',
]
```

{% endcode %}

## getGuildbyWorldId

{% code lineNumbers="true" %}

```php
Guilds::getGuildbyWorldId($wold_id);
return array

[
    'id' => 1,
    'level' => 1,
    'name' => 'Guild Name',
    'ownerid' => 1,
    'creationdata' => date('M d Y'),
    'motd' => 'Motd Guild',
    'residence' => 1,
    'balance' => 0,
    'points' => 0,
    'description' => 'Descrição da guild.',
    'logo_name' => 'image name.gif',
]
```

{% endcode %}

## convertRankGuild

{% code lineNumbers="true" %}

```php
Guilds::convertRankGuild($rank_id);
return array

[
    'id' => 1,
    'guild_id' => 1,
    'name' => 'Guild Name',
    'rank_level' => 1,
]
```

{% endcode %}

## getRanks

{% code lineNumbers="true" %}

```php
Guilds::getRanks($guild_id);
return array

[
    'id' => 1,
    'guild_id' => 1,
    'name' => 'Rank Name',
    'level' => 1,
]
```

{% endcode %}

## getMembersbyRank

{% code lineNumbers="true" %}

```php
Guilds::getMembersbyRank($guild_id, $rank_id);
return array

[
    [
        'player_id' => 1,
        'player_name' => 'Player Sample',
        'player_vocation' => 'Sorcerer',
        'player_level' => 10,
        'player_online' => true,
        'guild_id' => 1,
        'rank_id' => 1,
        'nick' => 'Nick Player',
        'date' => date('M d Y'),
    ],
]
```

{% endcode %}

## getAllMembers

{% code lineNumbers="true" %}

```php
Guilds::getAllMembers($guild_id);
return array

[
    [
        'rank_name' => 'Rank Name',
        'rank_members' => [
                            [
                                'player_id' => 1,
                                'player_name' => 'Player Sample',
                                'player_vocation' => 'Sorcerer',
                                'player_level' => 10,
                                'player_online' => true,
                                'guild_id' => 1,
                                'rank_id' => 1,
                                'nick' => 'Nick Player',
                                'date' => date('M d Y'),
                            ],
                        ],
    ],
]
```

{% endcode %}

## getGuildMembership

{% code lineNumbers="true" %}

```php
Guilds::getGuildMembership($guild_id);
return array

[
    [
        'player_name' => 'Player Sample',
        'player_id' => 1,
        'guild_id' => 1,
        'rank_id' => 1,
        'nick' => 'Nick Player',
    ],
]
```

{% endcode %}

## getGuildInvites

{% code lineNumbers="true" %}

```php
Guilds::getGuildInvites($guild_id);
return array

[
    [
        'player_name' => 'Player Sample',
        'player_id' => 1,
        'guild_id' => 1,
        'date' => date('M d Y'),
    ],
]
```

{% endcode %}

## verifyAccountLeader

{% code lineNumbers="true" %}

```php
Guilds::verifyAccountLeader($guild_id);
return boolean
```

{% endcode %}

## verifyAccountViceLeader

{% code lineNumbers="true" %}

```php
Guilds::verifyAccountViceLeader($guild_id);
return boolean
```

{% endcode %}

## verifyAccountMember

{% code lineNumbers="true" %}

```php
Guilds::verifyAccountMember($guild_id);
return boolean
```

{% endcode %}

## verifyAccountInvited

{% code lineNumbers="true" %}

```php
Guilds::verifyAccountInvited($guild_id);
return boolean
```

{% endcode %}

</details>