hu.scelightapi.sc2.rep.model.gameevents.selectiondelta

Interface IDelta

All Superinterfaces:

IStructView

public interface IDelta
extends IStructView

Interface describing the selection delta.

Author:

Andras Belicza

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	F_ADD_SUBGROUPS Add subgroups field name.
static java.lang.String	F_ADD_UNIT_TAGS Add unit tags field name.
static java.lang.String	F_REMOVE_MASK Remove mask field name.
static java.lang.String	F_SUBGROUP_INDEX Subgroup index field name.

Method Summary

Methods

Modifier and Type	Method and Description
ISubgroup[]	getAddSubgroups() Returns the add subgroups.
java.lang.Integer[]	getAddUnitTags() Returns the add unit tags.
IPair<java.lang.String,java.lang.Object>	getRemoveMask() Returns the remove mask.
java.lang.Integer	getSubgroupIndex() Returns the subgroup index.

Methods inherited from interface hu.scelightapi.util.IStructView

get, get, getStruct

Field Detail

F_SUBGROUP_INDEX

static final java.lang.String F_SUBGROUP_INDEX

Subgroup index field name.

See Also:

Constant Field Values

F_REMOVE_MASK

static final java.lang.String F_REMOVE_MASK

Remove mask field name.

See Also:

Constant Field Values

F_ADD_SUBGROUPS

static final java.lang.String F_ADD_SUBGROUPS

Add subgroups field name.

See Also:

Constant Field Values

F_ADD_UNIT_TAGS

static final java.lang.String F_ADD_UNIT_TAGS

Add unit tags field name.

See Also:

Constant Field Values

Method Detail

getSubgroupIndex

java.lang.Integer getSubgroupIndex()

Returns the subgroup index.

Returns:

the subgroup index

getRemoveMask

IPair<java.lang.String,java.lang.Object> getRemoveMask()

Returns the remove mask.

If the second value of the returned pair (IPair.getValue2()) is not the string "None", then the first value of the returned pair ( IPair.getValue1()) may have the following values:

• "ZeroIndices" - in this case the second value is an Integer array (Integer[]) listing the retained indices from the current selection, units of unlisted index values are removed
• "OneIndices" - second value is an Integer array (Integer[]) listing the indices that are removed
• "Mask" - second value will be a IBitArray specifying a deselection map: units at indices where bit is set are removed, deselection count is the number of 1s (IBitArray.getOnesCount())

Returns:

the remove mask

getAddSubgroups

ISubgroup[] getAddSubgroups()

Returns the add subgroups.

Returns:

the add subgroups

getAddUnitTags

java.lang.Integer[] getAddUnitTags()

Returns the add unit tags.

Returns:

the add unit tags