Function reference

Built In helpers

The helpers the in-game Functions tab lists as Built In. Public ones are called by name; the others are bound as a dependency (choose the completion, or add it under Dependencies) and called by their qualified name.

88 of 240 helpers. Clear filters

`Platform.actions.call` dependency	Calls a native API function in protected mode and returns its first result only when Rotation Master can read it.
`Platform.actions.findSlot` dependency	Finds the spell-book slot of a spell with FindSpellBookSlotBySpellID.
`Platform.actions.GetSpellRangeState` public	Read spell-specific range for a unit using the appropriate client API or spell-book slot.
`Platform.actions.spellID` dependency	Validates a spell ID argument.
`Platform.announcement_recipient.GetAnnouncementRecipientGroupMembership` public	Resolve an exact cast-recipient name against the current bounded party or raid roster, then observe membership through a unit token.
`Platform.casting.durationSeconds` dependency	Computes the total length of a cast or channel in seconds from the millisecond start and end times in a UnitCastingInfo or UnitChannelInfo result.
`Platform.casting.finite` dependency	Returns true when value is a number that is neither NaN nor infinite, and false for anything else.
`Platform.casting.GetUnitCastObservation` public	Observe a unit casting or channeling on probe- and restricted-policy clients.
`Platform.casting.interruptibility` dependency	Converts the native notInterruptible flag of a cast or channel into an interruptible Boolean (its inverse).
`Platform.casting.remainingSeconds` dependency	Converts the millisecond end time of a cast or channel into the seconds left, measured against a fresh GetTime() and clamped at zero.
`Platform.casting.spellIdentity` dependency	Validates the spell ID field of a cast or channel result.
`Platform.creature_type.GetUnitCreatureTypeID` public	Observe creature identity from native UnitCreatureType return two on probe- and restricted-policy clients.
`Platform.form.GetPlayerFormObservation` public	Observe the current player form with one protected zero-argument GetShapeshiftForm call.
`Platform.glyphs.GetGlyphItemInfo` public	Classify a numeric item as a glyph for the requested class, using guarded native item metadata.
`Platform.glyphs.GetGlyphSocketSnapshot` public	Observe glyph sockets on verified Wrath, Cata and Mists client layouts.
`Platform.glyphs.integer` dependency	Returns true when value is a finite whole number no smaller than minimum, and false for anything else (including NaN and infinity).
`Platform.glyphs.layout` dependency	Maps client information to the position in the GetGlyphSocketInfo result that holds the glyph spell ID.
`Platform.glyphs.socket` dependency	Reads one glyph socket by calling fn(index) in protected mode and always returns a slot record with slot=index.
`Platform.groups.GetGroupMembership` public	Read public group membership on identified client families.
`Platform.groups.GetUnitGroupMembership` public	Read a specified unit membership in the player party or raid.
`Platform.health_forecast.finite` dependency	Returns true when value is a number that is neither NaN nor infinite, and false for anything else.
`Platform.health_forecast.GetHealthForecastIdentityObservation` public	On probe- and restricted-policy clients, observe exact UnitExists(unit), then UnitGUID(unit) only for a present unit.
`Platform.health_forecast.GetHealthForecastProviderObservation` public	Read optional RealMobHealth using its exact one-argument dot call.
`Platform.health_forecast.GetHealthForecastTimeObservation` public	Observe a fresh protected zero-argument GetTime for a needed health forecast.
`Platform.health_forecast.GetHealthForecastValueObservation` public	Read a lazy health scalar after a separate identity gate.
`Platform.health_forecast.providerValue` dependency	Normalizes one health figure returned by the RealMobHealth provider.
`Platform.health_forecast.readField` dependency	Reads object[key] in protected mode.
`Platform.instance.GetInstanceObservation` public	Observe one protected zero-argument IsInInstance tuple.
`Platform.items.finite` dependency	Returns true when value is a finite, nonnegative number (not NaN or infinity), and false for anything else.
`Platform.items.GetItemInfoInstant` public	Read normalized native item classification metadata.
`Platform.items.identifier` dependency	Validates an item argument.
`Platform.loss_of_control.GetLossOfControlCount` public	Read the documented active loss-of-control count with a protected zero-argument dot call.
`Platform.loss_of_control.GetLossOfControlEvent` public	Read one documented active loss-of-control row by its native index and requested subject kind.
`Platform.mobinfo2.finite` dependency	Checks that a value is a readable finite number.
`Platform.mobinfo2.GetMobInfo2Observation` public	Read optional MobInfo2 historical observations on probe- and restricted-policy clients.
`Platform.mobinfo2.hitCount` dependency	Reads the hit count for a spell school from a MobInfo2 resists table (the field named school.."Hits").
`Platform.mobinfo2.presence` dependency	Checks whether a unit exists with one protected UnitExists call.
`Platform.mobinfo2.readField` dependency	Reads object[key] in protected mode for MobInfo2 data.
`Platform.pet.GetPetObservation` public	Observe exact pet existence and optionally its formatted GetUnitName display name.
`Platform.player_flags.GetPlayerFlagObservation` public	Observe one independent zero-argument player flag: stealthed uses IsStealthed, control uses HasFullControl, and outdoors uses IsOutdoors.
`Platform.player_movement.GetPlayerMovementObservation` public	Observe the player current movement speed on supported readable clients.
`Platform.points.GetPlayerComboPointObservation` public	Observe the explicitly selected TBC player combo transport.
`Platform.points.GetUnitPointFragmentObservation` public	Observe a point resource that the client reports in fragments (Mists of Pandaria Burning Embers).
`Platform.points.GetUnitPointIdentityObservation` public	Observe exact selected-unit existence and optionally its class filename for point-resource conditions.
`Platform.points.GetUnitPointPowerObservation` public	Read one explicitly selected point-resource quantity with an exact two-argument UnitPower or UnitPowerMax query.
`Platform.range.GetNameplateMaxDistance` public	Read the current positive nameplate visibility distance using the supported CVar API.
`Platform.range.GetRangeCheckBounds` public	Read the public LibRangeCheck interval for a unit.
`Platform.role.GetInspectRoleObservation` public	Observe a selected unit role on probe- and restricted-policy clients without issuing inspection requests.
`Platform.role.GetTalentGroupRoleObservation` public	Observe the first role result of the exact legacy GetTalentGroupRole(group) dot call on probe- and restricted-policy clients.
`Platform.role.readField` dependency	Reads object[key] in protected mode, used to look up optional APIs.
`Platform.role.roleValue` dependency	Validates a role returned by a native API.
`Platform.roster_class.GetRosterClassObservation` public	Read public roster identity on identified client families.
`Platform.roster_class.rosterUnit` dependency	Returns true when unit is exactly player, party1 through party4, or raid1 through raid40 (no leading zeros), and false for any other string.
`Platform.rotation_owner.GetPlayerOwnerClassObservation` public	Read a fresh protected UnitClass player observation for rotation ownership.
`Platform.runes.finite` dependency	Returns true when value is a number that is neither NaN nor infinite, and false for anything else.
`Platform.runes.GetRuneCooldownObservation` public	Read one protected GetRuneCooldown tuple for an exact native slot.
`Platform.runes.GetRuneEvaluationTime` public	Read a fresh protected zero-argument GetTime for rune cooldown arithmetic.
`Platform.runes.GetRuneTypeObservation` public	Observe one exact native rune slot using GetRuneType with its single index argument.
`Platform.runes.numberField` dependency	Normalizes one numeric field of a native result.
`Platform.runes.validIndex` dependency	Validates a rune slot index.
`Platform.spells.cooldownFlags` dependency	Extracts the never-secret isEnabled, isActive and isOnGCD flags from a C_Spell.GetSpellCooldown record whose times are secret.
`Platform.spells.cooldownValues` dependency	Reads a spell cooldown as separate values for the readiness checks.
`Platform.spells.copy` dependency	Copies the expected fields of a native result table into a new table, checking each type.
`Platform.spells.finiteNonNegative` dependency	Returns true when value is a nonnegative number that is not NaN or infinity, and false for anything else.
`Platform.spells.flagReadiness` dependency	Decides cooldown readiness from the never-secret flags when the cooldown times are hidden.
`Platform.spells.gcdRunning` dependency	Reports whether the global cooldown is running at time now.
`Platform.spells.GetSpellCharges` public	Read a normalized charge record: currentCharges, maxCharges, cooldownStartTime, cooldownDuration, chargeModRate and isActive.
`Platform.spells.GetSpellCooldown` public	Read and normalize a spell cooldown across supported clients.
`Platform.spells.identifier` dependency	Validates a spell argument.
`Platform.spells.IsAutoRepeatActive` public	Read the player auto-repeat state for a spell such as Shoot or Auto Shot.
`Platform.spells.IsSpellReady` public	Check whether a spell can be recommended now, allowing a spell whose remaining cooldown ends with the current global cooldown.
`Platform.spells.own` dependency	Returns a record holding only the expected fields, each checked by type.
`Platform.threat.GetUnitThreatObservation` public	Observe ordered selected-unit existence, hostility from player, then the player threat status on that unit.
`Platform.unit_attackability.GetUnitAttackabilityObservation` public	Observe whether the player can attack a selected unit that is not dead, using the exact UnitExists, UnitCanAttack and UnitIsDead predicates.
`Platform.unit_flags.GetUnitFlagObservation` public	Observe one current unit flag: combat uses UnitAffectingCombat, enemy uses UnitIsEnemy with player as the first unit, and pvp uses UnitIsPVP.
`Platform.unit_health.finite` dependency	Returns true when value is a number that is neither NaN nor infinite, and false for anything else.
`Platform.unit_health.GetUnitHealthObservation` public	Observe readable current health and optionally maximum health on supported clients.
`Platform.unit_identity.GetUnitIdentityObservation` public	Compare two exact unit tokens using UnitIsUnit after checking only the first token with UnitExists.
`Platform.unit_level.finite` dependency	Returns true when value is a number that is neither NaN nor infinite, and false for anything else.
`Platform.unit_level.GetUnitLevelObservation` public	Observe a readable raw unit level on known clients.
`Platform.unit_metadata.GetUnitMetadataObservation` public	Observe one consumed native unit metadata field after checking UnitExists: class uses UnitClass return two, creature uses the localized UnitCreatureType name, and classification uses UnitClassification.
`Platform.unit_power.finite` dependency	Returns true when value is a number that is neither NaN nor infinite, and false for anything else.
`Platform.unit_power.GetUnitPowerObservation` public	Observe explicit mana or the current raw power resource on supported readable clients.
`Platform.unit_presence.GetUnitPresenceObservation` public	Observe unit presence on identified client families.
`Platform.unit_stat.finite` dependency	Returns true when value is a number that is neither NaN nor infinite, and false for anything else.
`Platform.unit_stat.GetUnitStatObservation` public	Observe the effective statistic from native return two only.
`Platform.unit_states.GetUnitStateObservation` public	Observe death or ghost state, or friendliness to the player, for the exact selected unit on probe- and restricted-policy clients.
`Platform.zone_pvp.GetZonePVPObservation` public	Observe the first zone PvP classification result with one protected zero-argument dot call.