name
name: (FriendsChatRank) -> stringThe constant's name as declared.
FriendsChatRank.valueOf(…)
FriendsChatRank.UNRANKED
FriendsChatRank.FRIEND| Method | Returns | Description |
|---|---|---|
name() | string | The constant's name as declared. |
ordinal() | number | The constant's 0-based position in values(). |
toString() | string | name(); tostring(c) answers the same. |
compareTo(FriendsChatRank) | number | This ordinal less other's. |
equals(any) | boolean | Whether other is this constant. == answers the same. |
getValue() | number | This 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) | FriendsChatRank | valueOf(name): the constant named name; any other name is an error. |
| Field | Type | Description |
|---|---|---|
UNRANKED | FriendsChatRank | UNRANKED: ordinal 0; getValue() -1. |
FRIEND | FriendsChatRank | FRIEND: ordinal 1; getValue() 0. |
RECRUIT | FriendsChatRank | RECRUIT: ordinal 2; getValue() 1. |
CORPORAL | FriendsChatRank | CORPORAL: ordinal 3; getValue() 2. |
SERGEANT | FriendsChatRank | SERGEANT: ordinal 4; getValue() 3. |
LIEUTENANT | FriendsChatRank | LIEUTENANT: ordinal 5; getValue() 4. |
CAPTAIN | FriendsChatRank | CAPTAIN: ordinal 6; getValue() 5. |
GENERAL | FriendsChatRank | GENERAL: ordinal 7; getValue() 6. |
OWNER | FriendsChatRank | OWNER: ordinal 8; getValue() 7. |
JMOD | FriendsChatRank | JMOD: ordinal 9; getValue() 127. |
| Method | Returns | Description |
|---|---|---|
FriendsChatManager.getKickRank | FriendsChatRank? | The lowest rank that may kick, or nil. |
FriendsChatManager.getMyRank | FriendsChatRank? | Your rank in the channel (your own entry's), or nil. |
FriendsChatMember.getRank | FriendsChatRank? | Their rank in the channel, or nil for a value FriendsChatRank lacks. |
FriendsChatRankClass.valueOf | FriendsChatRank | valueOf(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. |
namename: (FriendsChatRank) -> stringThe constant's name as declared.
ordinalordinal: (FriendsChatRank) -> numberThe constant's 0-based position in values().
toStringtoString: (FriendsChatRank) -> stringname(); tostring(c) answers the same.
compareTocompareTo: (FriendsChatRank, FriendsChatRank) -> numberThis ordinal less other's.
equalsequals: (FriendsChatRank, any) -> booleanWhether other is this constant. == answers the same.
getValuegetValue: (FriendsChatRank) -> numberThis constant's getValue() value, listed on each constant.
valuesvalues: () -> {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.
valueOfvalueOf: (string) -> FriendsChatRankvalueOf(name): the constant named name; any other name is an error.