net.risingworld.api.utils

Enum Crosshair

java.lang.Object

java.lang.Enum<Crosshair>

net.risingworld.api.utils.Crosshair

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Crosshair>

public enum Crosshair
extends java.lang.Enum<Crosshair>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Chest Chest crosshair (chest icon)
Context Crosshair for context menu (circle with three dots)
Crafting Crafting crosshair (small hammer icon)
Default The default crosshair
Door Door crosshair (door icon)
Fire Fire crosshair (small fire icon)
Latch Latch icon
Mount Add/mount crosshair (circle with + in it)
Music Music icon
NoFire Crossed out fire crosshair
Pickup Pickup crosshair (small hand icon)
Recycle Recycle icon
Scissors Scissors icon
Sitdown Sitting crosshair (chair icon)
Sleep Sleeping crosshair (Zzz)
Toilet Toilet icon
Trash Trashbin icon
Wheel Wheel crosshair
Write Write crosshair (pen icon)

Method Summary

Modifier and Type	Method and Description
static Crosshair	getCrosshair(byte id) Gets the crosshair which has the provided id.
byte	getID() Used internally.
static Crosshair	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Crosshair[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Default

public static final Crosshair Default

The default crosshair

Pickup

public static final Crosshair Pickup

Pickup crosshair (small hand icon)

Crafting

public static final Crosshair Crafting

Crafting crosshair (small hammer icon)

Context

public static final Crosshair Context

Crosshair for context menu (circle with three dots)

Sitdown

public static final Crosshair Sitdown

Sitting crosshair (chair icon)

Door

public static final Crosshair Door

Door crosshair (door icon)

Scissors

public static final Crosshair Scissors

Scissors icon

Sleep

public static final Crosshair Sleep

Sleeping crosshair (Zzz)

Music

public static final Crosshair Music

Music icon

Mount

public static final Crosshair Mount

Add/mount crosshair (circle with + in it)

Trash

public static final Crosshair Trash

Trashbin icon

Recycle

public static final Crosshair Recycle

Recycle icon

Chest

public static final Crosshair Chest

Chest crosshair (chest icon)

Toilet

public static final Crosshair Toilet

Toilet icon

Latch

public static final Crosshair Latch

Latch icon

Write

public static final Crosshair Write

Write crosshair (pen icon)

Fire

public static final Crosshair Fire

Fire crosshair (small fire icon)

NoFire

public static final Crosshair NoFire

Crossed out fire crosshair

Wheel

public static final Crosshair Wheel

Wheel crosshair

Method Detail

values

public static Crosshair[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Crosshair c : Crosshair.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Crosshair valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getID

public byte getID()

Used internally.

Returns:

the crosshair id.

getCrosshair

public static Crosshair getCrosshair(byte id)

Gets the crosshair which has the provided id.

Parameters:

id - the id.

Returns:

the according Crosshair.