Class PlayerBotAI [-] [+]

Methods

AllowActive Returns the raw activity flag of the bot for the given type, without re-evaluating it.
ApplyInstanceStrategies Applies the instance specific strategies of the given map to the bot.
AutoScaleActivity Scales the given value by the current bot activity modifier.
CanCastSpell Returns true if the bot can currently cast the given spell on the target.
CanCastVehicleSpell Returns true if the bot can cast the given vehicle spell on the target.
CanDispel Returns true if the bot can dispel the given spell.
CanEquipItem Checks whether the bot could equip the given Item in the given slot.
CanMove Returns true if the bot is currently allowed to move.
CastSpell Makes the bot cast the given spell on the target.
CastVehicleSpell Makes the bot cast the given vehicle spell on the target.
ChangeEngine Switches the bot to the engine of the given state.
ChangeEngineOnCombat Switches the bot to its combat engine.
ChangeEngineOnNonCombat Switches the bot to its non combat engine.
ChangeStrategy Adds, removes or toggles a strategy for the given state.
Class2SpellFamilyName Returns the spell family matching the given class.
ClearStrategies Removes every strategy of the given state.
ContainsStrategy Returns true if the bot has any strategy of the given type.
DoNextAction Makes the bot immediately evaluate and run its next action.
DoSpecificAction Runs a specific bot action by name, for example "attack my target" or "follow".
EnchantItemT Applies a permanent enchant to the item in the given equipment slot.
EqualLowercaseName Returns true if both names are equal, ignoring the case.
EvaluateHealerDpsStrategy Re-evaluates whether a healer bot should also dps.
FindAmmo Returns the ammo the bot would use, or nil.
FindBandage Returns the bandage the bot would use, or nil.
FindConsumable Returns the given consumable carried by the bot, or nil.
FindEquipSlot Returns the equipment slot the given ItemTemplate would go to.
FindLockedItem Returns a locked item carried by the bot, or nil.
FindNewMaster Looks for a new master for this bot and returns it, or nil.
FindOilFor Returns the weapon oil the bot would apply to the given weapon, or nil.
FindOpenableItem Returns an openable item carried by the bot, or nil.
FindPoison Returns the poison the bot would use, or nil.
FindStoneFor Returns the sharpening stone the bot would apply to the given weapon, or nil.
GetAllPlayersInGroup Returns a table of every Player in the bots group, bots included.
GetAura Returns the named Aura carried by the given Unit, or nil.
GetBot Returns the bot Player this [PlayerbotAI] drives.
GetChatChannelSource Returns which chat source a message of the given type and channel maps to.
GetCheat Returns the cheat mask of the bot.
GetClassIndex Returns the index of the given Player among the group members of a class.
GetCreature Returns the Creature with the given GUID as seen by the bot, or nil.
GetCurrentAreaName Returns the localized name of the area the bot is standing in.
GetCurrentZoneName Returns the localized name of the zone the bot is standing in.
GetEquipGearScore Returns the equipped gear score of the given Player as computed by the bot AI.
GetFixedBotNumber Returns a stable pseudo random number for this bot in the range [0, maxNum).
GetGameObject Returns the GameObject with the given GUID as seen by the bot, or nil.
GetGlobalCooldown Returns the global cooldown the given spell would trigger, in milliseconds.
GetGroupLeader Returns the group leader of the bot, or its master when it is not grouped.
GetGroupSlotIndex Returns the group slot index of the given Player, or of the bot itself.
GetGrouperType Returns the grouper type of the bot.
GetGuilderType Returns the guilder type of the bot.
GetIncompleteQuestIds Returns a table with the IDs of the quests the bot has not completed yet.
GetInventoryItems Returns a table with every Item in the bags of the bot.
GetInventoryItemsCount Returns how many of the given item the bot carries in its inventory.
GetItemScoreMultiplier Returns the score multiplier the bot AI applies to items of the given quality.
GetJumpDestination Returns the jump destination currently set for the bot.
GetLocalizedCreatureName Returns the localized name of the given creature entry.
GetLocalizedGameObjectName Returns the localized name of the given gameobject entry.
GetMaster Returns the Player that masters this bot, or nil.
GetMeleeIndex Returns the melee index of the given Player in the group.
GetNearGroupMemberCount Returns the amount of group members near the bot.
GetPlayer Returns the Player with the given GUID as seen by the bot, or nil.
GetQuestIds Returns a table with the IDs of every quest currently in the bots log.
GetQuests Returns a table with the Quests currently in the bots log.
GetQuestsRequiringItem Returns the quests of the bot that still need the given item.
GetRange Returns a configured playerbot range by name.
GetRangedDpsIndex Returns the ranged dps index of the given Player in the group.
GetRangedIndex Returns the ranged index of the given Player in the group.
GetReactDelay Returns the reaction delay of the bot in milliseconds.
GetRealPlayersInGroup Returns a table of every real (human controlled) Player in the bots group.
GetState Returns the current state of the bot AI.
GetStrategies Returns a table with the names of all strategies active in the given state.
GetUnit Returns the Unit with the given GUID as seen by the bot, or nil.
GetWorldObject Returns the WorldObject with the given GUID as seen by the bot, or nil.
HandleCommand Sends a chat command to this bot as if another Player had said it.
HandleRemoteCommand Runs a remote playerbot command on this bot and returns its textual answer.
HasAggro Returns true if the bot currently holds aggro on the given Unit.
HasAura Returns true if the given Unit has the named aura.
HasAuraToDispel Returns true if the given Unit has an aura the bot can dispel.
HasCheat Returns true if the bot has the given cheat enabled.
HasGameClientMaster Returns true if the bot currently has a master using a real game client.
HasItemInInventory Returns true if the bot carries the given item in its inventory.
HasPlayerNearby Returns true if a real player is within the given range of the bot.
HasStrategy Returns true if the given strategy is active in the given state.
HasTargetExclusions Returns true if the bot has target exclusions configured.
ImbueItem Makes the bot use the given item, on itself or on a target.
InterruptSpell Interrupts every spell the bot is currently casting and notifies its client.
IsActive Returns the cached "is active" flag of the bot without re-evaluating it.
IsActivityAllowed Returns true if the given activity type is currently allowed for the bot.
IsAllowedCommand Returns true if the given command is allowed for this bot.
IsAssistHealOfIndex Returns true if the given Player is the assist healer of the given index.
IsAssistRangedDpsOfIndex Returns true if the given Player is the assist ranged dps of the given index.
IsAssistTankOfIndex Returns true if the given Player is the assist tank of the given index.
IsBotMainTank Returns true if the given Player is a bot acting as main tank of its group.
IsHealingSpell Returns true if the given spell family flags describe a healing spell.
IsInNonRaidDungeon Returns true if the bot is inside a non raid dungeon.
IsInRealGuild Returns true if the bot is in a guild that contains real players.
IsInVehicle Returns true if the bot is on a vehicle matching every requested capability.
IsInterruptableSpellCasting Returns true if the given Unit is casting a spell the bot could interrupt.
IsMovementImpaired Returns true if the given Unit is movement impaired, snared or rooted.
IsOpposing Returns true if the given Player belongs to the opposing faction.
IsSafe Returns true if the given WorldObject is safe for the bot to interact with.
LeaveOrDisbandGroup Makes the bot leave its group, or disband it when it is the leader.
PetFollow Makes the pet of the bot follow it again.
Ping Makes the bot ping the given world coordinates for its group.
PlayEmote Makes the bot perform an emote.
PlaySound Plays a sound for the bot.
ReInitCurrentEngine Reinitializes the currently active engine of the bot.
RemoveShapeshift Removes the current shapeshift form of the bot.
RequestSpellInterrupt Asks the bot AI to interrupt its current cast on the next update.
Reset Resets the bot AI.
ResetJumpDestination Clears the jump destination of the bot.
ResetStrategies Restores the default strategies of the bot.
Say Makes the bot say the given text, going through the playerbot chat filters.
SayToChannel Makes the bot talk in the given global channel.
SayToGuild Makes the bot talk in its guild chat, checking its guild rank rights first.
SayToParty Makes the bot talk in its party chat.
SayToRaid Makes the bot talk in its raid chat.
SayToWorld Makes the bot talk in the world channel.
SelectiveResetStrategies Resets the strategies of the given state, keeping the ones set by the master.
SetCheat Sets the cheat mask of the bot.
SetJumpDestination Sets the jump destination of the bot.
SetMaster Sets the master of this bot.
SpellInterrupted Tells the bot AI that the given spell was interrupted.
StarterLevelDistanceCheck Returns true if the given location is far enough for a starting level bot.
TellError Reports an error to the master of the bot.
TellMaster Makes the bot whisper the given text to its master.
TellMasterNoFacing Same as [PlayerbotAI]:TellMaster but the bot does not turn towards its master.
Whisper Makes the bot whisper the given text to a player by name.
Yell Makes the bot yell the given text.