Clan
Functions for clan of characters.
Table of Contents
- expelPlayersFromDeletedClan() : int
- Expel characters from a deleted clan.
- getCharacterFromAcctidAndRank() : object|null
- Get information of character with acctId and rank less or equal to.
- getClanLeadersCount() : int
- Count leaders of a clan.
- getClanMembershipDetails() : array<string|int, mixed>|null
- Get details of membership of clan.
- getClanMembershipList() : array<string|int, mixed>
- Get list of membership of clan.
- getLeadersFromClan() : array<string|int, mixed>
- Get leaders of clan exclude select acctId.
- getViableLeaderForClan() : array<string|int, mixed>|null
- Get one member of clan that can be promote to leader.
- setNewClanLeader() : int
- Set new leader for a clan.
Methods
expelPlayersFromDeletedClan()
Expel characters from a deleted clan.
public
expelPlayersFromDeletedClan(int $clanId) : int
Parameters
- $clanId : int
Return values
int —getCharacterFromAcctidAndRank()
Get information of character with acctId and rank less or equal to.
public
getCharacterFromAcctidAndRank(int $acctId, int $rank) : object|null
Parameters
- $acctId : int
- $rank : int
Return values
object|null —getClanLeadersCount()
Count leaders of a clan.
public
getClanLeadersCount(int $clanId) : int
Parameters
- $clanId : int
Return values
int —getClanMembershipDetails()
Get details of membership of clan.
public
getClanMembershipDetails(int $clanId) : array<string|int, mixed>|null
Parameters
- $clanId : int
Return values
array<string|int, mixed>|null —getClanMembershipList()
Get list of membership of clan.
public
getClanMembershipList(int $clanId) : array<string|int, mixed>
Parameters
- $clanId : int
Return values
array<string|int, mixed> —getLeadersFromClan()
Get leaders of clan exclude select acctId.
public
getLeadersFromClan(int $clanId, int $acctId) : array<string|int, mixed>
Parameters
- $clanId : int
- $acctId : int
-
Exclude this acctId
Return values
array<string|int, mixed> —getViableLeaderForClan()
Get one member of clan that can be promote to leader.
public
getViableLeaderForClan(int $clanId, int $acctId) : array<string|int, mixed>|null
Parameters
- $clanId : int
- $acctId : int
Return values
array<string|int, mixed>|null —setNewClanLeader()
Set new leader for a clan.
public
setNewClanLeader(int $characterId) : int
Parameters
- $characterId : int