hu.scelightapi.sc2.rep.model.gameevents

Interface IControlGroupUpdateEvent

All Superinterfaces:

HasRIcon, IEvent, IStructView

public interface IControlGroupUpdateEvent
extends IEvent

Control group update game event.

Author:

Andras Belicza

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	F_GROUP_INDEX Control group index field name.
static java.lang.String	F_GROUP_UPDATE Control group update field name.
static java.lang.String	F_MASK Mask field name.

Fields inherited from interface hu.scelightapi.sc2.rep.model.IEvent

F_ID, F_LOOP, F_NAME, F_PLAYER_ID, F_USER_ID

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	getGroupIndex() Returns the control group index.
java.lang.Integer	getGroupUpdate() Returns the control group update. Possible values: 0x00: Assign 0x01: Add selection (assign) 0x02: Select
java.lang.Object	getMask() Returns the mask (result of a choice, either a Mask or OneIndices).
boolean	isAssign() Tells if this control group event is a control group assign.
boolean	isSelect() Tells if this control group event is a control group select.

Methods inherited from interface hu.scelightapi.sc2.rep.model.IEvent

getId, getLoop, getName, getParameters, getPlayerId, getRawParameters, getRicon, getUserId

Methods inherited from interface hu.scelightapi.util.IStructView

get, get, getStruct

Field Detail

F_GROUP_INDEX

static final java.lang.String F_GROUP_INDEX

Control group index field name.

See Also:

Constant Field Values

F_GROUP_UPDATE

static final java.lang.String F_GROUP_UPDATE

Control group update field name.

See Also:

Constant Field Values

F_MASK

static final java.lang.String F_MASK

Mask field name.

See Also:

Constant Field Values

Method Detail

getGroupIndex

java.lang.Integer getGroupIndex()

Returns the control group index.

Returns:

the control group index

getGroupUpdate

java.lang.Integer getGroupUpdate()

Returns the control group update.
Possible values:

• 0x00: Assign
• 0x01: Add selection (assign)
• 0x02: Select

Returns:

the control group update

getMask

java.lang.Object getMask()

Returns the mask (result of a choice, either a Mask or OneIndices).

Returns:

the mask (result of a choice, either a Mask or OneIndices)

isAssign

boolean isAssign()

Tells if this control group event is a control group assign.

Returns:

true if this control group event is a control group assign; false otherwise

isSelect

boolean isSelect()

Tells if this control group event is a control group select.

Returns:

true if this control group event is a control group select; false otherwise