hu.scelightapi.sc2.rep.model.details

Interface IPlayer

All Superinterfaces:

IStructView

public interface IPlayer
extends IStructView

Player.

Author:

Andras Belicza

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	F_COLOR Color field name.
static java.lang.String	F_CONTROL Control field name.
static java.lang.String	F_HANDICAP Handicap field name.
static java.lang.String	F_NAME Name field name.
static java.lang.String	F_OBSERVE Observe field name.
static java.lang.String	F_RACE Race field name.
static java.lang.String	F_RESULT Result field name.
static java.lang.String	F_TEAM_ID Team id field name.
static java.lang.String	F_TOON Toon field name.
static java.lang.String	F_WORKING_SET_SLOT_ID Working set slot id field name.
static java.lang.String[]	P_COLOR_A Alpha color component field path .
static java.lang.String[]	P_COLOR_B Blue color component field path .
static java.lang.String[]	P_COLOR_G Green color component field path .
static java.lang.String[]	P_COLOR_R Red color component field path .

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getArgb() Returns the ARGB color.
java.lang.Integer	getControl()
IResult	getDeducedResult() Returns the deduced result.
java.lang.Integer	getHandicap()
java.lang.String	getName() Returns the player name.
java.lang.Integer	getObserve()
IRace	getRace() Returns the race.
java.lang.String	getRaceString() Returns the localized race.
IResult	getRecordedResult() Returns the recorded result.
IResult	getResult() Returns the match result of the player, either the one recorded in the replay (getRecordedResult(), or the deduced result ( getDeducedResult().
java.lang.Integer	getTeamId() Deprecated.
IToon	getToon() Returns the toon of the player.
java.lang.Integer	getWorkingSetSlotId() Returns the working set slot id.
boolean	isResultDeduced() Tells if the match result returned by getResult() is originating from the replay or is a deduced result determined by an algorithm.

Methods inherited from interface hu.scelightapi.util.IStructView

get, get, getStruct

Field Detail

F_COLOR

static final java.lang.String F_COLOR

Color field name.

See Also:

Constant Field Values

P_COLOR_A

static final java.lang.String[] P_COLOR_A

Alpha color component field path .

P_COLOR_R

static final java.lang.String[] P_COLOR_R

Red color component field path .

P_COLOR_G

static final java.lang.String[] P_COLOR_G

Green color component field path .

P_COLOR_B

static final java.lang.String[] P_COLOR_B

Blue color component field path .

F_CONTROL

static final java.lang.String F_CONTROL

Control field name.

See Also:

Constant Field Values

F_HANDICAP

static final java.lang.String F_HANDICAP

Handicap field name.

See Also:

Constant Field Values

F_NAME

static final java.lang.String F_NAME

Name field name.

See Also:

Constant Field Values

F_OBSERVE

static final java.lang.String F_OBSERVE

Observe field name.

See Also:

Constant Field Values

F_RACE

static final java.lang.String F_RACE

Race field name.

See Also:

Constant Field Values

F_RESULT

static final java.lang.String F_RESULT

Result field name.

See Also:

Constant Field Values

F_TEAM_ID

static final java.lang.String F_TEAM_ID

Team id field name.

See Also:

Constant Field Values

F_TOON

static final java.lang.String F_TOON

Toon field name.

See Also:

Constant Field Values

F_WORKING_SET_SLOT_ID

static final java.lang.String F_WORKING_SET_SLOT_ID

Working set slot id field name.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the player name.

Returns:

the player name

getRaceString

java.lang.String getRaceString()

Returns the localized race.

Returns:

the localized race

getRace

IRace getRace()

Returns the race.

Returns:

the race

getWorkingSetSlotId

java.lang.Integer getWorkingSetSlotId()

Returns the working set slot id.

Returns:

the working set slot id

getArgb

int[] getArgb()

Returns the ARGB color.

Returns:

the ARGB color

getControl

java.lang.Integer getControl()

Returns:

the control

getHandicap

java.lang.Integer getHandicap()

Returns:

the handicap

getObserve

java.lang.Integer getObserve()

Returns:

the observe

getRecordedResult

IResult getRecordedResult()

Returns the recorded result.

Returns:

the recorded result

See Also:

getDeducedResult(), getResult()

getDeducedResult

IResult getDeducedResult()

Returns the deduced result.

Returns:

the deduced result

See Also:

getRecordedResult(), getResult()

getResult

IResult getResult()

Returns the match result of the player, either the one recorded in the replay (getRecordedResult(), or the deduced result ( getDeducedResult().

Returns:

the match result

See Also:

getRecordedResult(), getDeducedResult()

isResultDeduced

boolean isResultDeduced()

Tells if the match result returned by getResult() is originating from the replay or is a deduced result determined by an algorithm.

Returns:

true if the match result originates from the replay; false if it is a deduced result determined by an algorithm

getTeamId

@Deprecated
java.lang.Integer getTeamId()

Deprecated.

Returns the team id, not always accurate! Use ISlot.getTeamId() instead!

Returns:

the team id, not always accurate! Use ISlot.getTeamId() instead!

See Also:

ISlot.getTeamId()

getToon

IToon getToon()

Returns the toon of the player.

Returns:

the toon of the player