Package gg.xp.xivsupport.models

Class XivCombatant

java.lang.Object

gg.xp.xivsupport.models.XivEntity

gg.xp.xivsupport.models.XivCombatant

All Implemented Interfaces:

NameIdPair, Serializable

Direct Known Subclasses:

XivPlayerCharacter

public class XivCombatant
extends XivEntity

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final XivCombatant	ENVIRONMENT

Constructor Summary

Constructors

Constructor	Description
XivCombatant(long id, String name)	Simplified ctor for entity lookups that miss
XivCombatant(long id, String name, boolean isPc, boolean isThePlayer, long rawType, @Nullable HitPoints hp, @Nullable ManaPoints mp, @Nullable Position pos, long bNpcId, long bNpcNameId, long partyType, long level, long ownerId, long shieldAmount)
XivCombatant(long id, String name, boolean isPc, boolean isThePlayer, long rawType, @Nullable HitPoints hp, @Nullable ManaPoints mp, @Nullable Position pos, long bNpcId, long bNpcNameId, long partyType, long level, long ownerId, long shieldAmount, short transformationId, short weaponId, float radius)

Method Summary

Modifier and Type	Method	Description
long	getbNpcId()
long	getbNpcNameId()
@Nullable HitPoints	getHp()
long	getLevel()
@Nullable ManaPoints	getMp()
long	getOwnerId()
@Nullable XivCombatant	getParent()
long	getPartyType()
@Nullable Position	getPos()
float	getRadius()
long	getRawType()	Some of these are in OverlayPlugin EnmityMemoryCommon.cs 0 = ? 1 = PC 2 = Combatant NPCs and pets? Both Selene and Chocobo seem to be in here, as do enemies 3 = Non-combat NPC? 4 = Treasure coffer? 5 = Aetheryte? 6 = Gathering point? I got "Mature Tree" in here 7 = Gardening patch? 9 = Minion? 12 = Interactable housing instance?
long	getShieldAmount()
short	getTransformationId()
CombatantType	getType()
short	getWeaponId()
boolean	isCombative()
boolean	isFake()
boolean	isPc()
boolean	isThePlayer()
boolean	npcIdMatches(long... expected)
void	setFake(boolean fake)
void	setParent(XivCombatant parent)
RawXivCombatantInfo	toRaw()
String	toString()
@NotNull XivCombatant	walkParentChain()

Methods inherited from class gg.xp.xivsupport.models.XivEntity

equals, fmtShortList, getId, getName, hashCode, isEnvironment, toShortString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gg.xp.xivsupport.events.actlines.events.NameIdPair

matchesFilter

Field Details

ENVIRONMENT

public static final XivCombatant ENVIRONMENT

Constructor Details

XivCombatant

public XivCombatant(long id,
 String name,
 boolean isPc,
 boolean isThePlayer,
 long rawType,
 @Nullable
 @Nullable HitPoints hp,
 @Nullable
 @Nullable ManaPoints mp,
 @Nullable
 @Nullable Position pos,
 long bNpcId,
 long bNpcNameId,
 long partyType,
 long level,
 long ownerId,
 long shieldAmount,
 short transformationId,
 short weaponId,
 float radius)

XivCombatant

public XivCombatant(long id,
 String name,
 boolean isPc,
 boolean isThePlayer,
 long rawType,
 @Nullable
 @Nullable HitPoints hp,
 @Nullable
 @Nullable ManaPoints mp,
 @Nullable
 @Nullable Position pos,
 long bNpcId,
 long bNpcNameId,
 long partyType,
 long level,
 long ownerId,
 long shieldAmount)

XivCombatant

public XivCombatant(long id,
 String name)

Simplified ctor for entity lookups that miss

Parameters:

id - numerical ID

name - human-readable name

Method Details

isPc

public boolean isPc()

isThePlayer

public boolean isThePlayer()

toString

public String toString()

Overrides:

toString in class XivEntity

getType

public CombatantType getType()

getRawType

public long getRawType()

Some of these are in OverlayPlugin EnmityMemoryCommon.cs 0 = ? 1 = PC 2 = Combatant NPCs and pets? Both Selene and Chocobo seem to be in here, as do enemies 3 = Non-combat NPC? 4 = Treasure coffer? 5 = Aetheryte? 6 = Gathering point? I got "Mature Tree" in here 7 = Gardening patch? 9 = Minion? 12 = Interactable housing instance?

Returns:

Raw type from ACT

getHp

@Nullable
public @Nullable HitPoints getHp()

getMp

@Nullable
public @Nullable ManaPoints getMp()

getPos

@Nullable
public @Nullable Position getPos()

getbNpcId

public long getbNpcId()

npcIdMatches

public boolean npcIdMatches(long... expected)

getbNpcNameId

public long getbNpcNameId()

getPartyType

public long getPartyType()

getLevel

public long getLevel()

getOwnerId

public long getOwnerId()

isFake

public boolean isFake()

setFake

public void setFake(boolean fake)

getParent

@Nullable
public @Nullable XivCombatant getParent()

getRadius

public float getRadius()

walkParentChain

@NotNull
public @NotNull XivCombatant walkParentChain()

setParent

public void setParent(XivCombatant parent)

isCombative

public boolean isCombative()

getShieldAmount

public long getShieldAmount()

getTransformationId

public short getTransformationId()

getWeaponId

public short getWeaponId()

toRaw

public RawXivCombatantInfo toRaw()