Documentation

Alliance

in package

• Application

Table of Contents

Constants

MAXLENGTH_DESCRIPTION  = 255

MAXLENGTH_NAME  = 36

RECRUIT_CLOSED  = 'closed'

RECRUIT_OPEN  = 'open'

RECRUIT_PASSWORD  = 'password'

SQL  = 'alliance_id = :alliance_id AND game_id = :game_id'

Properties

$SQLID  : array{alliance_id: int, game_id: int}

$allianceID  : int

$allianceName  : string

$bank  : int

$CACHE_ALLIANCES  : array<int, array<int, self>>

$deaths  : int

$description  : string|null

$discordChannel  : string|null

$discordServer  : string|null

$flagshipID  : int

$gameID  : int

$imgSrc  : string

$ircChannel  : string

$kills  : int

$leaderID  : int

$memberList  : array<string|int, int>

$motd  : string

$password  : string

$recruiting  : bool

$seedlist  : array<string|int, int>

Methods

allRecruitTypes()  : array<string, string>

List of all recruitment types and their descriptions.

clearCache()  : void

createAlliance()  : self

Create an alliance and return the new object.

createDefaultRoles()  : void

Create the default roles for this alliance.

decreaseBank()  : void

getActiveIDs()  : array<string|int, int>

getAlliance()  : self

getAllianceBBLink()  : string

getAllianceByDiscordChannel()  : self

getAllianceByIrcChannel()  : self

getAllianceByName()  : self

getAllianceDisplayName()  : string

getAllianceID()  : int

getAllianceName()  : string

Returns the alliance name.

getBank()  : int

Get the total credits in the alliance bank account.

getDeaths()  : int

getDescription()  : string

Get (HTML-safe) alliance description for display.

getDiscordChannel()  : string|null

getDiscordServer()  : string|null

getFlagshipID()  : int

Get account ID of the player designated as the alliance flagship.

getGame()  : Game

getGameID()  : int

getImageURL()  : string

getIrcChannel()  : string

getJoinRestriction()  : string|false

getKills()  : int

getLeader()  : AbstractPlayer

getLeaderID()  : int

getMemberIDs()  : array<string|int, int>

getMembers()  : array<int, Player>

Returns the members of this alliance as an array of Player objects.

getMotD()  : string

Get (HTML-safe) alliance Message of the Day for display.

getNumMembers()  : int

getNumVeterans()  : int

getPassword()  : string

getPlanets()  : array<string|int, Planet>

Return all planets owned by members of this alliance.

getRecruitType()  : string

getSeedlist()  : array<string|int, int>

Return array of sector_id for sectors in the alliance seedlist.

hasDisbanded()  : bool

hasFlagship()  : bool

hasImageURL()  : bool

hasLeader()  : bool

hasPassword()  : bool

increaseBank()  : int

Increases alliance bank account up to the maximum allowed credits.

isInSeedlist()  : bool

Is the given sector in the alliance seedlist?

isNHA()  : bool

Returns true if the alliance is the Newbie Help Alliance.

isRecruiting()  : bool

setAllianceDescription()  : void

setBank()  : void

setDiscordChannel()  : void

setDiscordServer()  : void

setFlagshipID()  : void

Designate a player as the alliance flagship by their account ID.

setImageURL()  : void

setIrcChannel()  : void

setLeaderID()  : void

setMotD()  : void

setRecruitType()  : void

Set the password and recruiting attributes.

update()  : void

__construct()  : mixed