The QBDMap Class

The QBDMap class is the main object found in QB Damage Points. It hosts everything from the configuration to the execution engine.

-------- Properties --------
Select a property.
ActiveUnits As Team
A collection of active units.
CellHeight, CellWidth As Long
Cell size in pixels.
Configuration As Configuration
Holds configuration data.
Data(ByVal Index As Long) As Long
Contains all custom attributes.
Index: number of the custom attribute (starts at zero).
Title, Description As String
Map Title and description.
GaugeTimerEvents As Boolean
Tells whether to fire the UnitGaugeChanged event if the gauge increases spontaneously.
GaugeTimerInterval(ByVal Index As Integer) As Long
Interval needed before determining again whether to increase the gauge.
Index: number of the gauge to look at (starts at zero).
hWnd As Long
Windows handle.
IsDirty As Boolean
True if the map has been modified and not saved.
KeepUnits As Boolean
If true, units are not reset after map execution ends.
MapColor As Long
Map default background color.
MapWidth, MapHeight As Long
Size of the map in cells.
MapTime As Long
How many turns or (milli)seconds have ellapsed since the beginning of the execution.
ReadOnly As Boolean
Disables map editing by the user.
RunMode As qbdRunModes
Map run mode, one of these values: qbdRunRealTime = 1, qbdRunInSequencer = 2, qbdRunFromScript = 4.
SelectedUnits As Team
Selected units collection. Not all team actions supported.
SleepLimit As Long
If no action occurs, tells how long to wait before displaying a warning message.
Sprites As Sprites
Sprites collection.
StartupFile As String
The name of a map file stored locally on the disk. If empty, a new map will be created. If corresponding to a file on the disk, will open the file and prevent the user from switching to another file.
Teams As Teams
Teams collection.
Templates As Templates
Templates collection.
Textures As Sprite
The graphics used to paint the map background.
TimerInterval As Long
General map execution speed.
TurnCount As Long
The number of turns since the beginning of the execution.
Units As Units
Units collection.
UnitTimerInterval As Long
Sensitivity for scheduling unit actions.
ViewX, ViewY As Integer
Map view position.
Weapons As Weapons
Weapons collection.
-------- Methods --------
Select a method.
Abort()
Stops the current execution.
AboutBox
Displays a window with version information etc.
Alert(Message As String)
Displays a message to the user in the message bubble.
CancelEvent()
Not used.
CreateRandomMap()
Creates a new map using the built-in random generator.
DamageUnit(Unit As _Unit, ByVal gIndex As Long, ByVal Amount As Long)
Causes damage to a unit.

Show Help For:

.