sc2-gamedata
Public Attributes | List of all members
CAlert Class Reference

Generic. More...

#include <Alert.h>

Collaboration diagram for CAlert:
Collaboration graph
[legend]

Public Attributes

CFlags PrimaryActions
 Primary Actions. More...
 
CFlags SecondaryActions
 Secondary Actions. More...
 
CFlags Display
 Display. More...
 
CFlags Flags
 Flags. More...
 
real32 Fade
 Fade Time. More...
 
CImagePath Icon
 Icon. More...
 
real32 Life
 Duration. More...
 
real32 OverlapDuration
 Overlap Duration. More...
 
uint32 OverlapGlobalCount
 Overlap Global Count. More...
 
uint32 OverlapLocalCount
 Overlap Local Count. More...
 
CFixed OverlapLocalRadius
 Overlap Local Radius. More...
 
CColor PingColor
 Ping Color. More...
 
CModelLink PingModel
 Ping Model. More...
 
real32 PingTime
 Ping Time. More...
 
real32 QueueTime
 Queue Time. More...
 
CSoundLink Sound
 Sound. More...
 
CStringLink Text
 Text. More...
 
CStringLink Tooltip
 Tooltip. More...
 
EUnitSound Voice
 Voice. More...
 
EAlertPeripheral Peripheral
 Peripheral. More...
 
real32 SupersededVolume
 Superseded Volume. More...
 

Detailed Description

Generic.

Remarks
Unknown

Member Data Documentation

◆ Display

CFlags CAlert::Display

Display.

Who (relative to the player that triggered the alert) sees the alert

Remarks
indexEnum: EAlertDisplay

◆ Fade

real32 CAlert::Fade

Fade Time.

Fade out time (in seconds) for the alert

Remarks
minValue: 0

◆ Flags

CFlags CAlert::Flags

Flags.

Flags for the alert

Remarks
indexEnum: EAlertFlag

◆ Icon

CImagePath CAlert::Icon

Icon.

Icon that appears with the alert

◆ Life

real32 CAlert::Life

Duration.

Duration of the alert in seconds before it begins to fade

◆ OverlapDuration

real32 CAlert::OverlapDuration

Overlap Duration.

The amount of time that an alert persists for calculating overlap restrictions.

Remarks
minValue: 0

◆ OverlapGlobalCount

uint32 CAlert::OverlapGlobalCount

Overlap Global Count.

The maximum number of alert sounds that will play back to back.

◆ OverlapLocalCount

uint32 CAlert::OverlapLocalCount

Overlap Local Count.

The maximum number of alerts that can be triggered within the Overlap Local Radius.

◆ OverlapLocalRadius

CFixed CAlert::OverlapLocalRadius

Overlap Local Radius.

The radius that the alert system will search for overlapping alerts.

Remarks
minValue: 0

◆ Peripheral

EAlertPeripheral CAlert::Peripheral

Peripheral.

Remarks
minValue: Unknown

◆ PingColor

CColor CAlert::PingColor

Ping Color.

The color of the alert's minimap ping

◆ PingModel

CModelLink CAlert::PingModel

Ping Model.

The model of the alert's minimap ping

◆ PingTime

real32 CAlert::PingTime

Ping Time.

Duration of the minimap ping

◆ PrimaryActions

CFlags CAlert::PrimaryActions

Primary Actions.

Actions that occur when the alert is left clicked, or the spacebar is pressed.

Remarks
indexEnum: EAlertAction

◆ QueueTime

real32 CAlert::QueueTime

Queue Time.

◆ SecondaryActions

CFlags CAlert::SecondaryActions

Secondary Actions.

Actions that occur when the alert is right clicked.

Remarks
indexEnum: EAlertAction

◆ Sound

CSoundLink CAlert::Sound

Sound.

Sound that plays for the alert

◆ SupersededVolume

real32 CAlert::SupersededVolume

Superseded Volume.

Remarks
minValue: 0
maxValue: 0

◆ Text

CStringLink CAlert::Text

Text.

Text that appears for the alert

◆ Tooltip

CStringLink CAlert::Tooltip

Tooltip.

◆ Voice

EUnitSound CAlert::Voice

Voice.

Voice sound played on the triggering unit of the alert (if applicable)

Remarks
minValue: Unknown

The documentation for this class was generated from the following file: