HeadIcon

Methods
7
Fields
15

Getting one

HeadIcon.valueOf(…)
HeadIcon.MELEE
HeadIcon.RANGED

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(HeadIcon)numberThis ordinal less other's.
equals(any)booleanWhether other is this constant. == answers the same.
values(){HeadIcon}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)HeadIconvalueOf(name): the constant named name; any other name is an error.

Fields

FieldTypeDescription
MELEEHeadIconMELEE: ordinal 0.
RANGEDHeadIconRANGED: ordinal 1.
MAGICHeadIconMAGIC: ordinal 2.
RETRIBUTIONHeadIconRETRIBUTION: ordinal 3.
SMITEHeadIconSMITE: ordinal 4.
REDEMPTIONHeadIconREDEMPTION: ordinal 5.
RANGE_MAGEHeadIconRANGE_MAGE: ordinal 6.
RANGE_MELEEHeadIconRANGE_MELEE: ordinal 7.
MAGE_MELEEHeadIconMAGE_MELEE: ordinal 8.
RANGE_MAGE_MELEEHeadIconRANGE_MAGE_MELEE: ordinal 9.
WRATHHeadIconWRATH: ordinal 10.
SOUL_SPLITHeadIconSOUL_SPLIT: ordinal 11.
DEFLECT_MELEEHeadIconDEFLECT_MELEE: ordinal 12.
DEFLECT_RANGEHeadIconDEFLECT_RANGE: ordinal 13.
DEFLECT_MAGEHeadIconDEFLECT_MAGE: ordinal 14.

Returned by

MethodReturnsDescription
HeadIconClass.valueOfHeadIconvalueOf(name): the constant named name; any other name is an error.
HeadIconClass.values{HeadIcon}Every constant in ordinal order, as a 1-based array: the same frozen array every values() call, so table.clone it before changing it.
Player.getOverheadIconHeadIcon?The protection prayer over the player's head, nil for none.

Method details

name

name: (HeadIcon) -> string

The constant's name as declared.

ordinal

ordinal: (HeadIcon) -> number

The constant's 0-based position in values().

equals

equals: (HeadIcon, any) -> boolean

Whether other is this constant. == answers the same.

values

values: () -> {HeadIcon}

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) -> HeadIcon

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