Package gg.xp.xivsupport.events.actlines.events

Class SnapshotLocationDataEvent

java.lang.Object

gg.xp.reevent.events.BaseEvent

gg.xp.xivsupport.events.actlines.events.SnapshotLocationDataEvent

All Implemented Interfaces:

Event, DescribesCastLocation<AbilityUsedEvent>, HasAbility, HasSourceEntity, Serializable

public class SnapshotLocationDataEvent
extends BaseEvent
implements DescribesCastLocation<AbilityUsedEvent>, HasSourceEntity, HasAbility

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SnapshotLocationDataEvent(AbilityUsedEvent event, double heading)
SnapshotLocationDataEvent(AbilityUsedEvent event, Position pos)

Method Summary

Modifier and Type	Method	Description
XivAbility	getAbility()
@Nullable Double	getHeadingOnly()	If the cast is not targeted on a location, but is targeted in a direction from the caster, return that direction.
@Nullable Position	getPos()	If the cast is targeted on a location (including an optional rotation), then it will be returned in this method.
XivCombatant	getSource()
AbilityUsedEvent	originalEvent()

Methods inherited from class gg.xp.reevent.events.BaseEvent

delayedEnqueueAt, effectiveTimeNow, getCreatedAt, getEffectiveHappenedAt, getEffectiveTimeSince, getEnqueuedAt, getHappenedAt, getParent, getPumpedAt, getPumpFinishedAt, getSourceEventHandler, isImported, setDelayedEnqueueAt, setDelayedEnqueueOffset, setDelayedEnqueueOffset, setEnqueuedAt, setHappenedAt, setImported, setParent, setPumpedAt, setPumpFinishedAt, setSourceEventHandler, setTimeSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface gg.xp.reevent.events.Event

combineWith, delayedEnqueueAtFront, dumpFields, getThisOrParentOfType, shouldSave

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

abilityIdMatches

Constructor Details

SnapshotLocationDataEvent

public SnapshotLocationDataEvent(AbilityUsedEvent event,
 Position pos)

SnapshotLocationDataEvent

public SnapshotLocationDataEvent(AbilityUsedEvent event,
 double heading)

Method Details

originalEvent

public AbilityUsedEvent originalEvent()

Specified by:

originalEvent in interface DescribesCastLocation<AbilityUsedEvent>

Returns:

The event being described by this additional data. If the event contains its own data, rather than being provided after-the-fact, then this should point to itself.

getPos

@Nullable
public @Nullable Position getPos()

Description copied from interface: DescribesCastLocation

If the cast is targeted on a location (including an optional rotation), then it will be returned in this method. If it is only a rotation, or a non-location target, then this will be null.

Specified by:

getPos in interface DescribesCastLocation<AbilityUsedEvent>

Returns:

The position, else null.

getHeadingOnly

@Nullable
public @Nullable Double getHeadingOnly()

Description copied from interface: DescribesCastLocation

If the cast is not targeted on a location, but is targeted in a direction from the caster, return that direction.

Specified by:

getHeadingOnly in interface DescribesCastLocation<AbilityUsedEvent>

Returns:

The direction, else null.

getAbility

public XivAbility getAbility()

Specified by:

getAbility in interface HasAbility

getSource

public XivCombatant getSource()

Specified by:

getSource in interface HasSourceEntity

Returns:

The source of this action. Note that this is a snapshot of the source at the point in time when the action occurred. To see the current data, use XivState.getLatestCombatantData(XivCombatant).