Click or drag to resize
Battlegrounds Class
The battlegrounds manager.
Inheritance Hierarchy
SystemObject
  Styx.WoWInternalsBattlegrounds

Namespace: Styx.WoWInternals
Assembly: Styx (in Styx.dll) Version: 3.0.1160.0 (3.0.1160)
Syntax
C#
public static class Battlegrounds

The Battlegrounds type exposes the following members.

Properties
  NameDescription
Public propertyStatic memberBattlefieldInstanceRunTime
Returns the time since the battleground started.
Public propertyStatic memberBattlefieldStartTime
Gets the battlefield start time.
Public propertyStatic memberBattlegroundStatuses
Returns a list of battleground statuses.
Public propertyStatic memberCurrent
Returns the current battleground the local player is inside.
Public propertyStatic memberFinished
Returns true if the battlefield has ended.
Public propertyStatic memberIsInsideBattleground
Returns true if you are inside a battleground.
Public propertyStatic memberLandMarks
Returns a list of all visible landmarks.
Public propertyStatic memberNumVehicles
Gets the number of vehicles currently in this bg.
Public propertyStatic memberVehicleGuids
Gets the guids of all the vehicles in this bg.
Public propertyStatic memberVehicles
Gets the vehicles of this battleground.
Public propertyStatic memberWaitingForConfirmation
Gets a value indicating whether a BG queue has popped, and the game is waiting for confirmation to enter.
Public propertyStatic memberWinner
Returns the battlefield winner.
Top
Methods
  NameDescription
Public methodStatic memberAcceptBattlefieldPort
Accepts or declines a battlefield port.
Public methodStatic memberAcceptBattlegroundConfirmation
Accept battleground confirmation.
Public methodStatic memberGetBattlefieldWinner
Get the battlefields winner. Integer - Faction/team that has won the battlefield. Results are: nil if nobody has won, 0 for Horde and 1 for Alliance in a battleground, 0 for Green Team and 1 for Yellow in an arena.
Public methodStatic memberGetBGIndexWithStatus
Returns the first found index of the battlegournd with x status.
Public methodStatic memberGetCurrentBattleground
Returns the current battleground you are in.
Public methodStatic memberGetProfileName
Returns the profile name for

type

Public methodStatic memberGetQueuedBattlegroundInfo
Returns detailed information on the battlegrounds in the que.
Public methodStatic memberGetQueuedBattlegroundWaitTime
Gets a queued battleground wait time in miliseconds, or 0 if the battleground is not queued.
Public methodStatic memberGetStatus
Get's the current battleground status.
Public methodStatic memberIsQueuedForBattleground
Query if 'type' is queued for battleground.
Public methodStatic memberJoinBattlefield
Join's the que for a battlefield.
Public methodStatic memberLeaveBattlefield
Leaves the current battlefield the player is inside, pre-2.0.1 this would only leave the battlefield if it had been won or lost this was changed in 2.0.1 to exit you from the battlefield regardless if it was finished or not and will give you deserter.
Top
See Also