FriendsChatRank

Methods
8
Fields
10

Getting one

FriendsChatRank.valueOf(…)
FriendsChatRank.UNRANKED
FriendsChatRank.FRIEND

Methods

MethodReturnsDescription
name()stringThe constant's name as declared.
ordinal()numberThe constant's 0-based position in values().
toString()stringname(); tostring(c) answers the same.
compareTo(FriendsChatRank)numberThis ordinal less other's.
equals(any)booleanWhether other is this constant. == answers the same.
getValue()numberThis constant's getValue() value, listed on each constant.
values(){FriendsChatRank}Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.
valueOf(string)FriendsChatRankvalueOf(name): the constant named name; any other name is an error.

Fields

FieldTypeDescription
UNRANKEDFriendsChatRankUNRANKED: ordinal 0; getValue() -1.
FRIENDFriendsChatRankFRIEND: ordinal 1; getValue() 0.
RECRUITFriendsChatRankRECRUIT: ordinal 2; getValue() 1.
CORPORALFriendsChatRankCORPORAL: ordinal 3; getValue() 2.
SERGEANTFriendsChatRankSERGEANT: ordinal 4; getValue() 3.
LIEUTENANTFriendsChatRankLIEUTENANT: ordinal 5; getValue() 4.
CAPTAINFriendsChatRankCAPTAIN: ordinal 6; getValue() 5.
GENERALFriendsChatRankGENERAL: ordinal 7; getValue() 6.
OWNERFriendsChatRankOWNER: ordinal 8; getValue() 7.
JMODFriendsChatRankJMOD: ordinal 9; getValue() 127.

Returned by

MethodReturnsDescription
FriendsChatManager.getKickRankFriendsChatRank?The lowest rank that may kick, or nil.
FriendsChatManager.getMyRankFriendsChatRank?Your rank in the channel (your own entry's), or nil.
FriendsChatMember.getRankFriendsChatRank?Their rank in the channel, or nil for a value FriendsChatRank lacks.
FriendsChatRankClass.valueOfFriendsChatRankvalueOf(name): the constant named name; any other name is an error.
FriendsChatRankClass.values{FriendsChatRank}Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.

Method details

values

values: () -> {FriendsChatRank}

Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.

valueOf

valueOf: (string) -> FriendsChatRank

valueOf(name): the constant named name; any other name is an error.