ClanSettings

Group
player
Methods
4
Fields
None

Getting one

client:getClanSettings()
client:getGuestClanSettings()

Methods

MethodReturnsDescription
getName()stringThe clan's name.
getMembers(){ClanMember}Every member. Lua arrays start at 1.
findMember(string)ClanMember?The member called name (any case; a space matches the no-break space the game stores), or nil (also when the settings carry no names).
titleForRank(ClanRank)ClanTitle?The title the clan gives rank, or nil (no title, or settings that are no longer the client's).

Returned by

MethodReturnsDescription
Client.getClanSettingsClanSettings?(Client) -> ClanSettings?: The player's clan's settings (its members, online or not), or nil.
Client.getGuestClanSettingsClanSettings?The settings of the guest clan the player is in, or nil.

Method details

findMember

findMember: (ClanSettings, string) -> ClanMember?

The member called name (any case; a space matches the no-break space the game stores), or nil (also when the settings carry no names).