public interface IUser
There is a user to all players and observers, including computers.
IRepProcessor
Modifier and Type | Method and Description |
---|---|
int |
getApm()
Returns the APM of the user.
|
int |
getApmActions()
Returns the number of actions to be included in the APM calculation.
|
ICameraUpdateEvent |
getFirstCamUpdateEvent()
Returns the first camera update event which has a target point.
|
java.lang.String |
getFullName()
Returns the full name of the user including clan tag.
|
int |
getLastCmdLoop()
Returns the last loop when the user issued a command game event.
|
int |
getLeaveLoop()
Returns the loop at which the user left the game.
|
java.lang.String |
getName()
Returns the name of the user excluding clan tag.
|
IPlayer |
getPlayer()
Returns the
IPlayer object from the IDetails.getPlayerList() , if any. |
IPlayerColor |
getPlayerColor()
Returns the player color of the user.
|
int |
getPlayerIdx()
Returns the player index of the user.
In ladder games playerId = playerIdx + 1 but it can deviate in custom games. |
int |
getPlayerUserIdx()
Returns the player user index after optional reordering (e.g.
|
IRepProcessor |
getRepProcessor()
Returns the reference to the
IRepProcessor . |
ISlot |
getSlot()
Returns the slot of the user.
|
int |
getSlotIdx()
Returns the slot index of the user.
|
double |
getSpm()
Returns the SPM of the user.
|
int |
getSpmActions()
Returns the number of actions to be included in the SPM calculation.
|
int |
getSq()
Returns the SQ (Spending Quotient) of the user.
|
int |
getStartDirection()
Returns the direction of the start location of the player from the center of the map in the range of 1..12 as an hour value.
|
java.awt.geom.Point2D.Float |
getStartLocation()
Returns the start location on the map, matched by the first camera update event (which has a target point).
|
double |
getSupplyCappedPercent()
Returns the supply-capped percent (ratio of supply-capped time up until the last cmd game event and the time of the last cmd game event of the user).
|
IToon |
getToon()
Returns the toon of the user.
|
IUserInitData |
getUid()
Returns the user init data of the user.
|
int |
getUserIdx()
Returns the user index (index in the
IRepProcessor.getUsers() array. |
IToon getToon()
IRepProcessor getRepProcessor()
IRepProcessor
.IRepProcessor
int getSlotIdx()
int getPlayerIdx()
playerId = playerIdx + 1
but it can deviate in custom games.ISlot getSlot()
IUserInitData getUid()
IPlayer getPlayer()
IPlayer
object from the IDetails.getPlayerList()
, if any.IPlayer
object from the IDetails.getPlayerList()
, if anyint getPlayerUserIdx()
IRepProcessor.getPlayerUsers()
.java.lang.String getName()
java.lang.String getFullName()
int getUserIdx()
IRepProcessor.getUsers()
array.ICameraUpdateEvent getFirstCamUpdateEvent()
int getLeaveLoop()
int getLastCmdLoop()
int getApmActions()
int getApm()
Algorithm: See IRepProcessor.calculatePerMinute(long, int)
.
Additionally: time range: initial time is excluded based on setting, and last loop is the loop of the last cmd game event of the user; and actions are
all game events within this time range except camera update game events.
int getSpmActions()
double getSpm()
Algorithm: See IRepProcessor.calculatePerMinute(double, int)
.
Additionally: time range: initial time is excluded based on setting, and last loop is the loop of the last cmd game event of the user; and actions are
all camera update events which move the screen by a distance larger than 15.
int getSq()
Algorithm: See IRepProcessor.calculateSQ(int, int)
.
Additionally: samples are taken up to the loop of the last cmd game event of the user.
int getStartDirection()
double getSupplyCappedPercent()
java.awt.geom.Point2D.Float getStartLocation()
IPlayerColor getPlayerColor()
The returned color originates from ISlot.getPlayerColor()
in non-archon games, and in case of IFormat.ARCHON
it returns the tandem
leader's color.
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.