Interface: UniMover

A class representing flyff entity

Extends

• UniEntity

Extended by

• UniHuman

Methods

Click()

Click(): void

Returns

void

---

CompareName()

CompareName(name): boolean

Parameters

• name: string

Returns

boolean

---

get()

get<T>(name): IFlyffMover[T]

Accesss internal properties of the underlying IFlyffMover object.

Type Parameters

• T extends "name" | keyof IFlyffEntity | "targetID" | "targeting" | "attacking" | "following" | "HP" | "isDead" | "isRedMob" | "animationState" | "actionState" | "flyingState" | "buffs" | "premiumItems" | "premiumItems2" | "movingTowards" | "isMasquerpet" | "isNPC" | "g"

Parameters

• name: T

Returns

IFlyffMover[T]

The value of the property on the internal IFlyffMover object. Returns undefined if the property does not exist.

Overrides

UniEntity.get

---

GetAttackingEntity()

GetAttackingEntity<T>(): T

Type Parameters

• T extends UniHuman | UniMover | UniPlayer

Returns

T

---

GetCombatOrigin()

GetCombatOrigin(): IVector3

Returns

IVector3

---

GetContinent()

GetContinent(): string

Returns

string

---

GetCurrentHealth()

GetCurrentHealth(): number

Returns the current healthpoints of the mover.

Returns

number

---

GetDistance()

GetDistance(is2D?): number

Parameters

• is2D?: boolean

Returns

number

Inherited from

UniEntity.GetDistance

---

GetDistanceTo()

GetDistanceTo(otherPos): number

Parameters

• otherPos: IVector3

Returns

number

Inherited from

UniEntity.GetDistanceTo

---

GetFollowingEntity()

GetFollowingEntity<T>(): T

Type Parameters

• T extends UniHuman | UniMover | UniPlayer

Returns

T

---

GetGamePropID()

GetGamePropID(): number

Returns

number

Inherited from

UniEntity.GetGamePropID

---

GetID()

GetID(): number

Returns

number

---

GetLevel()

GetLevel(): number

Returns

number

---

GetMaxHealth()

GetMaxHealth(): number

Returns the current maximum healthpoints of the mover.

Returns

number

---

GetName()

GetName(): string

Returns

string

---

GetPosition()

GetPosition(): IVector3

Returns

IVector3

Inherited from

UniEntity.GetPosition

---

GetRank()

GetRank(): MonsterRank

Returns the rank of the mover. NOTE: Fallback to "normal" for any non masquerpets.

Returns

MonsterRank

---

GetRemainingTimeOfBuff()

GetRemainingTimeOfBuff(buffSkillName): number

Returns the remaining time in milliseconds that this buff will be active for, returns 0 for non active buffs.

Parameters

• buffSkillName: string

Name of the buff you want the remaining active time for.

Returns

number

---

GetTargetedEntity()

GetTargetedEntity<T>(): T

Type Parameters

• T extends UniHuman | UniMover | UniPlayer

Returns

T

---

IsDead()

IsDead(): boolean

Returns

boolean

---

IsDespawned()

IsDespawned(): boolean

Returns true if the entity was not contained in a recent game state update. Data on this entity might be stale. Use .LastSeenAt() to check when the entity was last seen.

Returns

boolean

Inherited from

UniEntity.IsDespawned

---

IsEventMonster()

IsEventMonster(): boolean

Returns

boolean

---

IsGiant()

IsGiant(): boolean

Returns

boolean

---

IsHuman()

IsHuman(): boolean

Returns true if this UniMover represents a player.

Returns

boolean

---

IsInCombat()

IsInCombat(): boolean

Returns

boolean

---

IsMasquerpet()

IsMasquerpet(): boolean

Returns

boolean

---

IsNPC()

IsNPC(): boolean

Retruns true if the UniMover represents an NPC.

Returns

boolean

---

IsObstructed()

IsObstructed(): boolean

Returns

boolean

Inherited from

UniEntity.IsObstructed

---

IsOnScreen()

IsOnScreen(): boolean

Returns

boolean

Inherited from

UniEntity.IsOnScreen

---

IsRedMob()

IsRedMob(): boolean

Returns

boolean

---

IsSittingDown()

IsSittingDown(): boolean

Returns true if the UniMover is currently sitting on ground.

Returns

boolean

---

IsVendorShop()

IsVendorShop(): boolean

Returns

boolean

---

On()

On(event, listener): void

Parameters

• event: string

• listener

Returns

void

Inherited from

UniEntity.On

---

Timer()

Timer(timerName): number

Exposes the timers that the script runtime manages for this entity.

Parameters

• timerName: keyof TUniEntity_Timers

Returns

number

Inherited from

UniEntity.Timer