Class UniPlayer

Hierarchy

Properties

_eventListeners runtimeProviders

Methods

Click GetAttackingEntity GetCombatOrigin GetCurrentHealth GetDistance GetDistanceTo GetEquippedItemID GetID GetInternalEntity GetLevel GetMaxHealth GetPosition GetQuestInProgress GetRank GetRemainingTimeOfBuff GetRemainingTimeOfSkillCooldown GetTargetedEntity GetTargetingId IsAggressive IsDead IsFlying IsHuman IsInParty IsMasquerpet IsNPC IsObstructed IsOnScreen IsQuestCompleted IsQuestInProgress IsSittingDown On SetInternalEntity Trigger UpdateState get

Properties

Protected _eventListeners

_eventListeners: {
    event: string;
    listener: Function;
}[] = []

Type declaration

  • event: string
  • listener: Function

Protected runtimeProviders

runtimeProviders: RuntimeProviders

Methods

Click

  • Returns void

GetAttackingEntity

  • Returns UniMover

GetCombatOrigin

  • Returns IVector3

GetCurrentHealth

  • Returns the current healthpoints of the mover.

    Returns number

GetDistance

  • Parameters

    • is2D: boolean = false

    Returns number

GetDistanceTo

  • Parameters

    Returns number

GetEquippedItemID

  • Parameters

    • slot: PLAYER_EQUIP_SLOT

    Returns number

GetID

  • Returns number

Protected GetInternalEntity

  • Returns IPlayer

GetLevel

  • Returns number

GetMaxHealth

  • Returns the current maximum healthpoints of the mover.

    Returns number

GetPosition

GetQuestInProgress

  • Parameters

    • questID: number

    Returns {
        questID: number;
        requirement1: number;
        requirement2: number;
        requirement3: number;
    }

    • questID: number
    • requirement1: number
    • requirement2: number
    • requirement3: number

GetRank

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

    Returns MonsterRank

GetRemainingTimeOfBuff

  • 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

GetRemainingTimeOfSkillCooldown

  • Returns the remaining time in milliseconds that the skill has cooldown for, returns 0 for no cooldown.

    Parameters

    • skillName: string

      Name of the skill you want the remaining cooldown time for.

    Returns number

GetTargetedEntity

  • Returns UniMover

GetTargetingId

  • Returns number

IsAggressive

  • Returns boolean

IsDead

  • Returns boolean

IsFlying

  • Returns boolean

IsHuman

  • Returns true if this UniMover represents a player.

    Returns boolean

IsInParty

  • Returns boolean

IsMasquerpet

  • Returns boolean

IsNPC

  • Retruns true if the UniMover represents an NPC.

    Returns boolean

IsObstructed

  • Returns boolean

IsOnScreen

  • Returns boolean

IsQuestCompleted

  • Parameters

    • questID: number

    Returns boolean

IsQuestInProgress

  • Parameters

    • questID: number

    Returns boolean

IsSittingDown

  • Returns true if the UniMover is currently sitting on ground.

    Returns boolean

On

  • Type Parameters

    • J extends OptionalMergeKeys<{
          EXP-changed: ((newValue) => void);
          FP-changed: ((newValue) => void);
          HP-changed: ((newValue) => void);
          MP-changed: ((newValue) => void);
          actionState-changed: ((newValue) => void);
          animationState-changed: ((newValue) => void);
          attacking-changed: ((newValue) => void);
          baseStats-changed: ((newValue) => void);
          bonusStats-changed: undefined;
          buffs-changed: ((newValue) => void);
          centroid-changed: ((newValue) => void);
          collisionData-changed: ((newValue) => void);
          distanceToCamera-changed: ((newValue) => void);
          entityBase-changed: ((newValue) => void);
          equips-changed: ((newValue) => void);
          expLockMobCount-changed: ((newValue) => void);
          flySpeed-changed: ((newValue) => void);
          flyingState-changed: ((newValue) => void);
          following-changed: ((newValue) => void);
          gamePropID-changed: ((newValue) => void);
          inventory-changed: ((newValue) => void);
          isAutoRunning-changed: ((newValue) => void);
          isCSPetSpawned-changed: ((newValue) => void);
          isDead-changed: ((newValue) => void);
          isExpLockEnabled-changed: ((newValue) => void);
          isInSameParty-changed: ((newValue) => void);
          isRedMob-changed: ((newValue) => void);
          isRotatingCCW-changed: ((newValue) => void);
          isRotatingCW-changed: ((newValue) => void);
          isTeleportingOrMounting-changed: ((newValue) => void);
          jobID-changed: ((newValue) => void);
          jobName-changed: ((newValue) => void);
          lastUsedPotionTimestamps-changed: ((newValue) => void);
          lockedInventorySlots-changed: ((newValue) => void);
          maxFP-changed: ((newValue) => void);
          maxHP-changed: ((newValue) => void);
          maxInventorySlots-changed: ((newValue) => void);
          maxMP-changed: ((newValue) => void);
          movingTowards-changed: ((newValue) => void);
          name-changed: ((newValue) => void);
          objectType-changed: ((newValue) => void);
          penya-changed: ((newValue) => void);
          premiumItems-changed: ((newValue) => void);
          premiumItems2-changed: ((newValue) => void);
          quests-changed: ((newValue) => void);
          remainingStatPoints-changed: ((newValue) => void);
          rotation-changed: ((newValue) => void);
          screenPos-changed: ((newValue) => void);
          skillCooldowns-changed: ((newValue) => void);
          targetID-changed: ((newValue) => void);
          targeting-changed: ((newValue) => void);
          worldBbox-changed: ((newValue) => void);
          worldName-changed: ((newValue) => void);
          worldPos-changed: ((newValue) => void);
      }, StaticChangeEventType>

    Parameters

    • event: J
    • listener: {
          EXP-changed: ((newValue) => void);
          FP-changed: ((newValue) => void);
          HP-changed: ((newValue) => void);
          MP-changed: ((newValue) => void);
          actionState-changed: ((newValue) => void);
          animationState-changed: ((newValue) => void);
          attacking-changed: ((newValue) => void);
          baseStats-changed: ((newValue) => void);
          bonusStats-changed: undefined;
          buffs-changed: ((newValue) => void);
          centroid-changed: ((newValue) => void);
          collisionData-changed: ((newValue) => void);
          despawned: (() => void);
          distanceToCamera-changed: ((newValue) => void);
          entityBase-changed: ((newValue) => void);
          equips-changed: ((newValue) => void);
          expLockMobCount-changed: ((newValue) => void);
          flySpeed-changed: ((newValue) => void);
          flyingState-changed: ((newValue) => void);
          following-changed: ((newValue) => void);
          gamePropID-changed: ((newValue) => void);
          inventory-changed: ((newValue) => void);
          isAutoRunning-changed: ((newValue) => void);
          isCSPetSpawned-changed: ((newValue) => void);
          isDead-changed: ((newValue) => void);
          isExpLockEnabled-changed: ((newValue) => void);
          isInSameParty-changed: ((newValue) => void);
          isRedMob-changed: ((newValue) => void);
          isRotatingCCW-changed: ((newValue) => void);
          isRotatingCW-changed: ((newValue) => void);
          isTeleportingOrMounting-changed: ((newValue) => void);
          jobID-changed: ((newValue) => void);
          jobName-changed: ((newValue) => void);
          lastUsedPotionTimestamps-changed: ((newValue) => void);
          lockedInventorySlots-changed: ((newValue) => void);
          maxFP-changed: ((newValue) => void);
          maxHP-changed: ((newValue) => void);
          maxInventorySlots-changed: ((newValue) => void);
          maxMP-changed: ((newValue) => void);
          movingTowards-changed: ((newValue) => void);
          name-changed: ((newValue) => void);
          objectType-changed: ((newValue) => void);
          penya-changed: ((newValue) => void);
          premiumItems-changed: ((newValue) => void);
          premiumItems2-changed: ((newValue) => void);
          quests-changed: ((newValue) => void);
          remainingStatPoints-changed: ((newValue) => void);
          rotation-changed: ((newValue) => void);
          screenPos-changed: ((newValue) => void);
          skillCooldowns-changed: ((newValue) => void);
          targetID-changed: ((newValue) => void);
          targeting-changed: ((newValue) => void);
          worldBbox-changed: ((newValue) => void);
          worldName-changed: ((newValue) => void);
          worldPos-changed: ((newValue) => void);
      }[J]

    Returns void

Protected SetInternalEntity

  • Parameters

    Returns void

Trigger

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns void

UpdateState

  • Parameters

    Returns void

get

  • Accesss internal properties of the underlying IFlyffEntity object.

    Type Parameters

    Parameters

    • propertyName: string & {} | J

    Returns IPlayer[J]

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc