This post is not a full documentation of the SDK but of the return types only. Whereas almost all methods are listed, the post lacks information to the parameters which must or may be passed to them. To get additional information to them, have a look at the generated documentation of the SDK.
Some information is still missing. For example, I did not figure out the meanings of all the fields, mostly because they always were empty during my tests. If you see any missing (or wrong) information, feel free to contact me so that I can correct them. Additionally, I did not have the time to look into the Competitions yet, so I cannot list the return data structure for the methods of this class. If you are using methods with missing information, feel free to send me a of the return value, so I can look into it and can add it to the list
Last Update: 22.11.2013
SDK-Version: 4.2
Maniaplanet\WebServices\Competitions
- getMapPool($competitionId)
- getInvitationKey($competitionId, [...])
- inviteTeam($competitionId, $teamId)
- removeTeam($competitionId, $teamId)
- create($name, $titleIdString, $isLan, [...])
- update($id, $name, $titleIdString, $isLan, [...])
- registerResults($competitionId, array $results)
Unknown return data structure...
- createForTeam($teamId, $link, $name, $category, [...])
- createForCompetition($competitionId, $link, $name, $category, [...])
Unknown return data structure...
- getPlayer()
Requires Scope: basic
Returns: object containing the following fields:- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- getOnlineStatus()
Requires Scope: online_status
Returns: object containing the following fields:- online: boolean - Whether the player is currently online in the game.
- login: string - The login of the player.
- nickname: string - The nickname of the player.
- serverLogin: string - The login of the server the player is currently playing on.
- serverName: string - The name of the server the player is currently playing on.
- serverJoinManialink: string - The ManiaLink to join the server the player is currently playing on.
- getEmail()
Requires Scope: email
Returns: string - The email address. - getBuddies()
Requires Scope: buddies
Returns: array of object, each element containing the following fields:- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- getDedicated()
Requires Scope: dedicated
Returns: array of object, each element containing the following fields:- id: int - The ID of the server.
- login: string - The login of the server account.
- owner: string - The login of the owning player.
- serverName: string - The name of the server, including the $-formats.
- description: string - The description of the server.
- isOnline: boolean - Whether this server is currently online.
- isDedicated: boolean - Whether this server is a dedicated server.
- mapsList: array of string - The list of maps on the server.
- idZone: int - The ID of the zone of the server.
- playerCount: int - The number of players currently playing on the server.
- maxPlayerCount: int - The maximal number of players allowed on the server.
- titleId: int - The ID of the title played on the server.
- isPrivate: boolean - Whether this server is a private server.
- scriptName: string - The name of the script used by the server.
- scriptVersion: string - The version of the script, format is 'YYYY-MM-DD'.
- scriptTeam: boolean - Whether the script is using team mode.
- isLadder: boolean - Whether this server is a ladder server.
- isLobby: boolean - Whether this server is a lobby server.
- ladderLimitMax: float - The upper ladder limit of the server.
- ladderLimitMin: float - The lower ladder limit of the server.
- adequacy: unknown field...
- buildVersion: string - The build version of the server, format is 'YYYY-MM-DD_HH_MM'.
- broadcasters: unknown field...
- relayOf: unknown field...
- ladderPointsAvg: float - The average ladder points of the players on the server.
- ladderPointsMin: float - The minimal ladder points of the players on the server.
- ladderPointsMax: float - The maximal ladder points of the players on the server.
- zone: object containing the following fields:
- id: int - The ID of the zone.
- name: string - The name of the zone.
- path: string - The path of the zone, separated with |.
- iconDDSURL: string - The URL of the DDS icon of the zone, may be null.
- iconURL: string - The URL of the icon of the zone, can be either a DDS or a JPEG.
- iconJPEGURL: string - The URL of the JPEG icon of the zone, may be empty.
- pathIds: string - The IDs of the zones in the path of this zone.
- title: object containing the following fields:
- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- getReportAbuses($serverLogin)
Requires Scope: dedicated
Unknown return data structure... - getManialinks()
Requires Scope: manialinks
Returns: array of array of string - The ManiaLinks owned by the player. - getContracts()
Requires Scope: teams
Returns: array of object, each element containing the following fields:- id: int - The ID of the team contract.
- teamId: int - The ID of the team involved in the contract.
- team: object containing the following fields:
- id: int - The id of the team.
- creatorLogin: string - The login of the creator of the team.
- tag: string - The tag of the team.
- level: int - The level of the team.
- name: string - The name of the team.
- primaryColor: string - The primary color of the team, format RGB in hex.
- secondaryColor: string - The secondary color of the team, format RGB in hex.
- description: string - The description of the team.
- emblem: string - The URL to the emblem image of the team.
- emblemWeb: string - The URL to the emblem image of the team for the web.
- logo: string - The URL to the logo of the team.
- creationDate: object containing the following fields:
- date: string - The date of creation, format is YYYY-MM-DD HH:MM:SS.
- timezone_type: int - The timezone as id, seems to always be 3.
- timezone: string - The timezone as string, seems to always be 'Europe/Berlin'
- city: string - The city of the team.
- zoneId: int - The id of the zone of the team.
- zone: object containing the following fields:
- id: int - The ID of the zone.
- name: string - The name of the zone.
- path: string - The path of the zone, separated with |.
- iconDDSURL: string - The URL of the DDS icon of the zone, may be null.
- iconURL: string - The URL of the icon of the zone, can be either a DDS or a JPEG.
- iconJPEGURL: string - The URL of the JPEG icon of the zone, may be empty.
- pathIds: string - The IDs of the zones in the path of this zone.
- titleId: int - The id of the title of the team.
- title: object containing the following fields:
- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- rank: unknown field...
- score: unknown field...
- points: unknown field...
- ladderPoints: int - The ladder points of the team.
- teamSize: int - The size of the team.
- maxTeamSize: int - The maximal size of the team.
- minTeamSize: int - The minimal size of the team.
- deleted: boolean - Whether the team has been deleted.
- login: string - The login of the player involved in the contract.
- player: object containing the following fields:
- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- state: int - The state of the contract, concrete values unknown.
- date: object containing the following fields:
- date: string - The date of the contract, format is 'YYYY-MM-DD HH:MM:SS'.
- timezone_type: int - The timezone as id, seems to always be 3.
- timezone: string - The timezone as string, seems to always be 'Europe/Berlin'
- getTeams()
Requires Scope: teams
Returns: array of object, each element containing the following fields:- id: int - The id of the team.
- creatorLogin: string - The login of the creator of the team.
- tag: string - The tag of the team.
- level: int - The level of the team.
- name: string - The name of the team.
- primaryColor: string - The primary color of the team, format RGB in hex.
- secondaryColor: string - The secondary color of the team, format RGB in hex.
- description: string - The description of the team.
- emblem: string - The URL to the emblem image of the team.
- emblemWeb: string - The URL to the emblem image of the team for the web.
- logo: string - The URL to the logo of the team.
- creationDate: object containing the following fields:
- date: string - The date of creation, format is YYYY-MM-DD HH:MM:SS.
- timezone_type: int - The timezone as id, seems to always be 3.
- timezone: string - The timezone as string, seems to always be 'Europe/Berlin'
- city: string - The city of the team.
- zoneId: int - The id of the zone of the team.
- zone: object containing the following fields:
- id: int - The ID of the zone.
- name: string - The name of the zone.
- path: string - The path of the zone, separated with |.
- iconDDSURL: string - The URL of the DDS icon of the zone, may be null.
- iconURL: string - The URL of the icon of the zone, can be either a DDS or a JPEG.
- iconJPEGURL: string - The URL of the JPEG icon of the zone, may be empty.
- pathIds: string - The IDs of the zones in the path of this zone.
- titleId: int - The id of the title of the team.
- title: object containing the following fields:
- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- rank: unknown field...
- score: unknown field...
- points: unknown field...
- ladderPoints: int - The ladder points of the team.
- teamSize: int - The size of the team.
- maxTeamSize: int - The maximal size of the team.
- minTeamSize: int - The minimal size of the team.
- deleted: boolean - Whether the team has been deleted.
- getOwnedTitles()
Requires Scope: titles
Returns: array of object, each element containing the following fields:- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- getInstalledTitles()
Requires Scope: titles
Returns: array of object, each element containing the following fields:- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- getFavoriteServers()
Requires Scope: favorite_servers
Unknown return data structure...
- getChannel($id)
Returns: object containing the following fields:- id: string - The ID of the channel.
- name: string - The name of the channel.
- description: string - The description of the channel.
- getMessages($id, [...])
Returns: array of object, each element containing the following fields:- id: int - The ID of the message.
- login: string - The login of the author of the message.
- dateCreated: string - The date when the message has been created, format is 'YYYY-MM-DD HH:MM:SS'.
- message: string - The actual message.
- link: string - The link associated with the message.
- iconStyle: string - The style of the icon of the message.
- iconSubStyle: string - The substyle of the icon of the message.
- mediaURL: string - The URL of the image used instead of the icon.
- postMessage($channelId, $message, [...])
Returns: boolean - Whether posting the message has succeeded.
- count($notificationId)
Returns: int - The number of comments of the specified notification.
- postPublicNotification($message, [...])
- postPersonalNotification($message, $receiverName, [...])
- postPrivateNotification($message, $receiverName, [...])
Returns: int - The ID of the created notification. - postPrivateEvent($message, $eventDate, $receiverName, [...])
- postPublicEvent($message, $eventDate, [...])
Returns: int - The ID of the created event.
- postPublicNotification($message, [...])
- postPersonalNotification($message, $receiverName, [...])
- postPrivateNotification($message, $receiverName, [...])
Returns: int - The ID of the created notification. - postPrivateEvent($message, $eventDate, $receiverName, [...])
- postPublicEvent($message, $eventDate, [...])
Returns: int - The ID of the created event.
- get($code)
Returns: object containing the following fields:- code: string - The code of the ManiaLink.
- url: string - The URL of the ManiaLink.
- planetCost: int - The planet cost of this ManiaLink.
- login: string - The login of the owner of this ManiaLink.
- create($transaction)
Returns: int - The ID of the created transaction. - isPaid($id)
Returns: boolean - Whether the transaction has been paid. - pay($transaction)
Returns: Nothing
- get($login)
Returns: object containing the following fields:- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- getManiaStars($login)
Returns: int - The ManiaStars of the player.
- getMultiplayerPlayer($titleId, $login)
Returns: object containing the following fields:- environment: string - The ID-String fo the title of the rank.
- unit: string - The unit of the rank.
- points: float - The points of the rank.
- ranks: array of object, each element containing the following fields:
- idZone: int - The ID of the zone of the rank.
- path: string - The path of the zone, separated with |.
- rank: int - The actual rank in the zone.
- environment: string - The ID-String fo the title of the rank.
- unit: string - The unit of the rank, either 'Ladder Points' or 'Skill Points'.
- points: float - The points of the rank.
- ranks: array of object, each element containing the following fields:
- idZone: int - The ID of the zone of the rank.
- path: string - The path of the zone, separated with |.
- rank: int - The actual rank in the zone.
- getMultiplayerWorld($titleId, [...])
- getMultiplayerZone($titleId, $path, [...])
Returns: object containing the following fields:- idZone: int - The ID of the zone.
- path: string - The path of the zone, separated with |.
- environment: string - The ID-String fo the title of the ranks.
- unit: string - The unit of the ranks.
- players: array of object, each element containing the following fields:
- rank: int - The actual rank of the player.
- points: float - The points of the rank.
- player: object containing the following fields:
- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- getSoloPlayer($titleId, $login)
Returns: object containing the following fields:- environment: string - The ID-String fo the title of the rank.
- unit: string - The unit of the rank.
- points: float - The points of the rank.
- ranks: array of object, each element containing the following fields:
- idZone: int - The ID of the zone of the rank.
- path: string - The path of the zone, separated with |.
- rank: int - The actual rank in the zone.
- environment: string - The ID-String fo the title of the rank.
- unit: string - The unit of the rank, either 'Ladder Points' or 'Skill Points'.
- points: float - The points of the rank.
- ranks: array of object, each element containing the following fields:
- idZone: int - The ID of the zone of the rank.
- path: string - The path of the zone, separated with |.
- rank: int - The actual rank in the zone.
- getSoloWorld($titleId, [...])
- getSoloZone($titleId, $path, [...])
Returns: object containing the following fields:- idZone: int - The ID of the zone.
- path: string - The path of the zone, separated with |.
- environment: string - The ID-String fo the title of the ranks.
- unit: string - The unit of the ranks.
- players: array of object, each element containing the following fields:
- rank: int - The actual rank of the player.
- points: float - The points of the rank.
- player: object containing the following fields:
- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- getSoloChallengeWorld($titleId, $challengeuid, [...])
- getSoloChallengeZone($titleId, $challengeuid, $path, [...])
Returns: object containing the following fields:- idZone: int - The ID of the zone of the ranks.
- path: string - The path of the zone, separated with |.
- environment: string - The ID-String fo the title of the ranks.
- challengeUID: string - The unique ID of the challenge.
- gameMode: string - The game mode of the challenge.
- unit: string - The unit of the ranks.
- players: array of object, each element containing the following fields:
- rank: int - The actual rank of the player.
- points: float - The points of the rank.
- player: object containing the following fields:
- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- get($login)
Returns: object containing the following fields:- id: int - The ID of the server.
- login: string - The login of the server account.
- owner: string - The login of the owning player.
- serverName: string - The name of the server, including the $-formats.
- description: string - The description of the server.
- isOnline: boolean - Whether this server is currently online.
- isDedicated: boolean - Whether this server is a dedicated server.
- mapsList: array of string - The list of maps on the server.
- idZone: int - The ID of the zone of the server.
- playerCount: int - The number of players currently playing on the server.
- maxPlayerCount: int - The maximal number of players allowed on the server.
- titleId: int - The ID of the title played on the server.
- isPrivate: boolean - Whether this server is a private server.
- scriptName: string - The name of the script used by the server.
- scriptVersion: string - The version of the script, format is 'YYYY-MM-DD'.
- scriptTeam: boolean - Whether the script is using team mode.
- isLadder: boolean - Whether this server is a ladder server.
- isLobby: boolean - Whether this server is a lobby server.
- ladderLimitMax: float - The upper ladder limit of the server.
- ladderLimitMin: float - The lower ladder limit of the server.
- adequacy: unknown field...
- buildVersion: string - The build version of the server, format is 'YYYY-MM-DD_HH_MM'.
- broadcasters: unknown field...
- relayOf: unknown field...
- ladderPointsAvg: float - The average ladder points of the players on the server.
- ladderPointsMin: float - The minimal ladder points of the players on the server.
- ladderPointsMax: float - The maximal ladder points of the players on the server.
- zone: object containing the following fields:
- id: int - The ID of the zone.
- name: string - The name of the zone.
- path: string - The path of the zone, separated with |.
- iconDDSURL: string - The URL of the DDS icon of the zone, may be null.
- iconURL: string - The URL of the icon of the zone, can be either a DDS or a JPEG.
- iconJPEGURL: string - The URL of the JPEG icon of the zone, may be empty.
- pathIds: string - The IDs of the zones in the path of this zone.
- title: object containing the following fields:
- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- getOnlinePlayers($login)
Returns: array of object, each element containing the following fields:- id: int - The ID of the player.
- login: string - The login of the player.
- nickname: string - The nick of the player, including the $-formats.
- path: string - The path of the player, zones are separated with |.
- idZone: int - The ID of the player's zone
- getFavoritedCount($login)
Returns: int - The number of players having the server favorited. - getReportAbuses($login)
Unknown return data structure... - getFilteredList($filteredList = array())
Returns: array of object, each element containing the following fields:- id: int - The ID of the server.
- login: string - The login of the server account.
- owner: string - The login of the owning player.
- serverName: string - The name of the server, including the $-formats.
- description: string - The description of the server.
- isOnline: boolean - Whether this server is currently online.
- isDedicated: boolean - Whether this server is a dedicated server.
- mapsList: array of string - The list of maps on the server.
- idZone: int - The ID of the zone of the server.
- playerCount: int - The number of players currently playing on the server.
- maxPlayerCount: int - The maximal number of players allowed on the server.
- titleId: int - The ID of the title played on the server.
- isPrivate: boolean - Whether this server is a private server.
- scriptName: string - The name of the script used by the server.
- scriptVersion: string - The version of the script, format is 'YYYY-MM-DD'.
- scriptTeam: boolean - Whether the script is using team mode.
- isLadder: boolean - Whether this server is a ladder server.
- isLobby: boolean - Whether this server is a lobby server.
- ladderLimitMax: float - The upper ladder limit of the server.
- ladderLimitMin: float - The lower ladder limit of the server.
- adequacy: unknown field...
- buildVersion: string - The build version of the server, format is 'YYYY-MM-DD_HH_MM'.
- broadcasters: unknown field...
- relayOf: unknown field...
- ladderPointsAvg: float - The average ladder points of the players on the server.
- ladderPointsMin: float - The minimal ladder points of the players on the server.
- ladderPointsMax: float - The maximal ladder points of the players on the server.
- zone: object containing the following fields:
- id: int - The ID of the zone.
- name: string - The name of the zone.
- path: string - The path of the zone, separated with |.
- iconDDSURL: string - The URL of the DDS icon of the zone, may be null.
- iconURL: string - The URL of the icon of the zone, can be either a DDS or a JPEG.
- iconJPEGURL: string - The URL of the JPEG icon of the zone, may be empty.
- pathIds: string - The IDs of the zones in the path of this zone.
- title: object containing the following fields:
- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- get($id)
Returns: object containing the following fields:- id: int - The id of the team.
- creatorLogin: string - The login of the creator of the team.
- tag: string - The tag of the team.
- level: int - The level of the team.
- name: string - The name of the team.
- primaryColor: string - The primary color of the team, format RGB in hex.
- secondaryColor: string - The secondary color of the team, format RGB in hex.
- description: string - The description of the team.
- emblem: string - The URL to the emblem image of the team.
- emblemWeb: string - The URL to the emblem image of the team for the web.
- logo: string - The URL to the logo of the team.
- creationDate: object containing the following fields:
- date: string - The date of creation, format is YYYY-MM-DD HH:MM:SS.
- timezone_type: int - The timezone as id, seems to always be 3.
- timezone: string - The timezone as string, seems to always be 'Europe/Berlin'
- city: string - The city of the team.
- zoneId: int - The id of the zone of the team.
- zone: object containing the following fields:
- id: int - The ID of the zone.
- name: string - The name of the zone.
- path: string - The path of the zone, separated with |.
- iconDDSURL: string - The URL of the DDS icon of the zone, may be null.
- iconURL: string - The URL of the icon of the zone, can be either a DDS or a JPEG.
- iconJPEGURL: string - The URL of the JPEG icon of the zone, may be empty.
- pathIds: string - The IDs of the zones in the path of this zone.
- titleId: int - The id of the title of the team.
- title: object containing the following fields:
- id: int - The ID of the title.
- idString: string - The ID-String of the title.
- name: string - The name of the title.
- isCustom: boolean - Whether this is a custom (i.e. user-made) title.
- web: string - The website of the title.
- cost: string - The cost of the title.
- environment: unknown field...
- dependencies: array of string - The titles this title depends on.
- rank: unknown field...
- score: unknown field...
- points: unknown field...
- ladderPoints: int - The ladder points of the team.
- teamSize: int - The size of the team.
- maxTeamSize: int - The maximal size of the team.
- minTeamSize: int - The minimal size of the team.
- deleted: boolean - Whether the team has been deleted.
- getContracts($id)
Returns: array of object, each element containing the following fields:- id: int - The ID of the team contract.
- teamId: int - The ID of the team involved in the contract.
- team: object containing the following fields:
- id: int - The id of the team.
- creatorLogin: string - The login of the creator of the team.
- tag: string - The tag of the team.
- level: int - The level of the team.
- name: string - The name of the team.
- primaryColor: string - The primary color of the team, format RGB in hex.
- secondaryColor: string - The secondary color of the team, format RGB in hex.
- description: string - The description of the team.
- emblem: string - The URL to the emblem image of the team.
- emblemWeb: string - The URL to the emblem image of the team for the web.
- logo: string - The URL to the logo of the team.
- creationDate: object containing the following fields:
- date: string - The date of creation, format is YYYY-MM-DD HH:MM:SS.
- timezone_type: int - The timezone as id, seems to always be 3.
- timezone: string - The timezone as string, seems to always be 'Europe/Berlin'
- city: string - The city of the team.
- zoneId: int - The id of the zone of the team.
- zone: object containing the following fields:
- id: int - The ID of the zone.
- [b]name[/b]: [b]string[/b] - The name of the zone.
- [b]path[/b]: [b]string[/b] - The path of the zone, separated with |.
- [b]iconDDSURL[/b]: [b]string[/b] - The URL of the DDS icon of the zone, may be null.
- [b]iconURL[/b]: [b]string[/b] - The URL of the icon of the zone, can be either a DDS or a JPEG.
- [b]iconJPEGURL[/b]: [b]string[/b] - The URL of the JPEG icon of the zone, may be empty.
- [b]pathIds[/b]: [b]string[/b] - The IDs of the zones in the path of this zone.
- [b]titleId[/b]: [b]int[/b] - The id of the title of the team.
- [b]title[/b]: [b]object[/b] containing the following fields:
- [b]id[/b]: [b]int[/b] - The ID of the title.
- [b]idString[/b]: [b]string[/b] - The ID-String of the title.
- [b]name[/b]: [b]string[/b] - The name of the title.
- [b]isCustom[/b]: [b]boolean[/b] - Whether this is a custom (i.e. user-made) title.
- [b]web[/b]: [b]string[/b] - The website of the title.
- [b]cost[/b]: [b]string[/b] - The cost of the title.
- [b]environment[/b]: [b]unknown field...[/b]
- [b]dependencies[/b]: [b]array[/b] of [b]string[/b] - The titles this title depends on.
- [b]rank[/b]: [b]unknown field...[/b]
- [b]score[/b]: [b]unknown field...[/b]
- [b]points[/b]: [b]unknown field...[/b]
- [b]ladderPoints[/b]: [b]int[/b] - The ladder points of the team.
- [b]teamSize[/b]: [b]int[/b] - The size of the team.
- [b]maxTeamSize[/b]: [b]int[/b] - The maximal size of the team.
- [b]minTeamSize[/b]: [b]int[/b] - The minimal size of the team.
- [b]deleted[/b]: [b]boolean[/b] - Whether the team has been deleted.
- [b]login[/b]: [b]string[/b] - The login of the player involved in the contract.
- [b]player[/b]: [b]object[/b] containing the following fields:
- [b]id[/b]: [b]int[/b] - The ID of the player.
- [b]login[/b]: [b]string[/b] - The login of the player.
- [b]nickname[/b]: [b]string[/b] - The nick of the player, including the $-formats.
- [b]path[/b]: [b]string[/b] - The path of the player, zones are separated with |.
- [b]idZone[/b]: [b]int[/b] - The ID of the player's zone
- [b]state[/b]: [b]int[/b] - The state of the contract, concrete values unknown.
- [b]date[/b]: [b]object[/b] containing the following fields:
- [b]date[/b]: [b]string[/b] - The date of the contract, format is 'YYYY-MM-DD HH:MM:SS'.
- [b]timezone_type[/b]: [b]int[/b] - The timezone as id, seems to always be 3.
- [b]timezone[/b]: [b]string[/b] - The timezone as string, seems to always be 'Europe/Berlin'
- [b]getAdmins($id)[/b]
Returns: [b]array[/b] of [b]object[/b], each element containing the following fields:- [b]id[/b]: [b]int[/b] - The ID of the player.
- [b]login[/b]: [b]string[/b] - The login of the player.
- [b]nickname[/b]: [b]string[/b] - The nick of the player, including the $-formats.
- [b]path[/b]: [b]string[/b] - The path of the player, zones are separated with |.
- [b]idZone[/b]: [b]int[/b] - The ID of the player's zone
- [b]getRank($id)[/b]
Returns: [b]array[/b] of [b]object[/b], each element containing the following fields:
- [b]get($idString)[/b]
Returns: [b]object[/b] containing the following fields:- [b]id[/b]: [b]int[/b] - The ID of the title.
- [b]idString[/b]: [b]string[/b] - The ID-String of the title.
- [b]name[/b]: [b]string[/b] - The name of the title.
- [b]isCustom[/b]: [b]boolean[/b] - Whether this is a custom (i.e. user-made) title.
- [b]web[/b]: [b]string[/b] - The website of the title.
- [b]cost[/b]: [b]string[/b] - The cost of the title.
- [b]environment[/b]: [b]unknown field...[/b]
- [b]dependencies[/b]: [b]array[/b] of [b]string[/b] - The titles this title depends on.
- [b]getKarma($circle, $player)[/b]
Returns: [b]object[/b] containing the following fields:- [b]whites[/b]: [b]int[/b] - The number of times the player has been whitelisted.
- [b]blacks[/b]: [b]int[/b] - The number of times the player has been blacklisted.
- [b]getBlackList($circle = null)[/b]
- [b]getWhiteList($circle = null)[/b]
Returns: [b]object[/b] containing the following fields:- [b]login[/b]: [b]string[/b] - The login of the player.
- [b]count[/b]: [b]int[/b] - The number of times the player has been set on this list.
- [b]blackList($player)[/b]
- [b]whiteList($player)[/b]
- [b]unBlackList($player)[/b]
- [b]unWhiteList($player)[/b]
Returns: Nothing
- [b]get($id)[/b]
- [b]getByPath($path)[/b]
Returns: [b]object[/b] containing the following fields:- [b]id[/b]: [b]int[/b] - The ID of the zone.
- [b]name[/b]: [b]string[/b] - The name of the zone.
- [b]path[/b]: [b]string[/b] - The path of the zone, separated with |.
- [b]iconDDSURL[/b]: [b]string[/b] - The URL of the DDS icon of the zone, may be null.
- [b]iconURL[/b]: [b]string[/b] - The URL of the icon of the zone, can be either a DDS or a JPEG.
- [b]iconJPEGURL[/b]: [b]string[/b] - The URL of the JPEG icon of the zone, may be empty.
- [b]pathIds[/b]: [b]string[/b] - The IDs of the zones in the path of this zone.
- [b]getAll([...])[/b]
- [b]getChildren($id, [...])[/b]
- [b]getChildrenByPath($path, [...])[/b]
Returns: [b]array[/b] of [b]object[/b], each element containing the following fields:- [b]id[/b]: [b]int[/b] - The ID of the zone.
- [b]name[/b]: [b]string[/b] - The name of the zone.
- [b]path[/b]: [b]string[/b] - The path of the zone, separated with |.
- [b]iconDDSURL[/b]: [b]string[/b] - The URL of the DDS icon of the zone, may be null.
- [b]iconURL[/b]: [b]string[/b] - The URL of the icon of the zone, can be either a DDS or a JPEG.
- [b]iconJPEGURL[/b]: [b]string[/b] - The URL of the JPEG icon of the zone, may be empty.
- [b]pathIds[/b]: [b]string[/b] - The IDs of the zones in the path of this zone.
- [b]getId($path)[/b]
Returns: [b]int[/b] - The id of the zone with the specified path. - [b]getPopulation($id)[/b]
Returns: [b]int[/b] - The number of players in the zone.