public interface IEvent extends IStructView, HasRIcon
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
F_ID
Id field name.
|
static java.lang.String |
F_LOOP
Loop field name.
|
static java.lang.String |
F_NAME
Name field name.
|
static java.lang.String |
F_PLAYER_ID
Player id field name (in game events present below base build 24764).
|
static java.lang.String |
F_USER_ID
User id field name (in game events present from base build 24764).
|
Modifier and Type | Method and Description |
---|---|
int |
getId()
Returns the event id.
|
int |
getLoop()
Returns the game loop when the event occurred.
|
java.lang.String |
getName()
Returns the event name.
|
java.lang.String |
getParameters(IRepProcessor repProc)
Returns the parameters of the event.
|
java.lang.Integer |
getPlayerId()
Returns the player id.
|
java.lang.String |
getRawParameters()
Returns the raw parameters of the event.
Includes all non-default fields from the underlying struct which has a non-null value, recursively. |
IRIcon |
getRicon()
Returns the
IRIcon of the event. |
int |
getUserId()
Returns the user id causing the event.
|
get, get, getStruct
static final java.lang.String F_ID
static final java.lang.String F_NAME
static final java.lang.String F_LOOP
static final java.lang.String F_PLAYER_ID
static final java.lang.String F_USER_ID
int getId()
java.lang.String getName()
int getLoop()
java.lang.Integer getPlayerId()
int getUserId()
java.lang.String getParameters(IRepProcessor repProc)
repProc
- reference to the rep processor in case additional info is required to decode / translate field valuesjava.lang.String getRawParameters()
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.