Package com.wingman.defaultplugins.devutils.game

Class CharacterUtil

java.lang.Object

com.wingman.defaultplugins.devutils.game.CharacterUtil

public class CharacterUtil
extends java.lang.Object

Provides API related to Character.

Constructor Summary

Constructors

Constructor	Description
CharacterUtil()

Method Summary

Modifier and Type	Method	Description
static java.util.Optional<java.lang.Float>	getHealthDecimal(Character ofCharacter)	Gets the health of a Character represented as a floating point number between 0 and 1, or -1 if the subject's health could not be retrieved: The value returned is only guaranteed to be up to date if the subject's health bar is visible.
static java.util.Optional<java.lang.Integer>	getHealthPercentage(Character ofCharacter)	Gets the health percentage of a Character.
static java.util.Optional<Character>	getTargetCharacter(Character ofCharacter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CharacterUtil

public CharacterUtil()

Method Detail

getHealthDecimal

public static java.util.Optional<java.lang.Float> getHealthDecimal(Character ofCharacter)

Gets the health of a Character represented as a floating point number between 0 and 1, or -1 if the subject's health could not be retrieved:
The value returned is only guaranteed to be up to date if the subject's health bar is visible.

Parameters:

ofCharacter - the character to get health percentage of

Returns:

a value from 0 to 1; or nothing if the health could not be retrieved

getHealthPercentage

public static java.util.Optional<java.lang.Integer> getHealthPercentage(Character ofCharacter)

Gets the health percentage of a Character. The value returned is only guaranteed to be up to date if the subject's health bar is visible.

Parameters:

ofCharacter - the character to get health percentage of

Returns:

a value from 0 to 100 to signify health percentage; or nothing if the health percentage could not be retrieved

getTargetCharacter

public static java.util.Optional<Character> getTargetCharacter(Character ofCharacter)

Parameters:

ofCharacter - the character to get target of

Returns:

the target of the subject; or nothing if they have no target