Package marauroa.server.game.python
Class PythonRP
java.lang.Object
marauroa.server.game.python.PythonRP
Barebone implementation of RPRuleProcessor that you can extends at Python.
You must extend this class.
- Author:
- miguel
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Notify it when a begin of actual turn happens.boolean
checkGameVersion(String game, String version)
Returns true if the version of the game is compatiblecreateAccount(String username, String password, String email)
Creates an account for the gamecreateAccountWithToken(String username, String tokenType, String token)
Create an account for a player in game.createCharacter(String username, String character, RPObject template)
Creates an new character for an account already logged into the gamevoid
endTurn()
Notify it when a end of actual turn happens.void
Execute an action in the name of a player.boolean
onActionAdd(RPObject object, RPAction action, List<RPAction> actionList)
This method is called *before* adding an action by RPScheduler so you can choose not to allow the action to be added by returning falseboolean
Callback method called when a player exits the gameboolean
Callback method called when a new player enters in the gamevoid
Callback method called when a new player time out.void
transferContent(RPObject target, List<TransferContent> content)
Transfer content to client.
-
Constructor Details
-
PythonRP
public PythonRP()
-
-
Method Details
-
transferContent
Transfer content to client.- Parameters:
target
- client to transfer content to.content
- the contents to transfer.
-
beginTurn
public void beginTurn()Notify it when a begin of actual turn happens. -
checkGameVersion
Returns true if the version of the game is compatible- Parameters:
game
- the game nameversion
- the game version- Returns:
- true if game,version is compatible
-
createAccount
Creates an account for the game- Parameters:
username
- the username who is going to be added.password
- the password for our username.email
- the email of the player for notifications or password reminders.- Returns:
- the Result of creating the account.
-
createAccountWithToken
Create an account for a player in game. Uses token instead of password for cases like 3rd party authentication (e.g. google sign-in).- Parameters:
username
- username for a new accounttokenType
- token type for useful data about tokentoken
- auth token to verify, usually obtained from 3rd party- Returns:
- the Result of creating a new account
-
createCharacter
Creates an new character for an account already logged into the game- Parameters:
username
- the username who owns the account of the character to be added.character
- the character to createtemplate
- the desired values of the avatar representing the character.- Returns:
- the Result of creating the character.
-
endTurn
public void endTurn()Notify it when a end of actual turn happens. -
execute
Execute an action in the name of a player.- Parameters:
object
- the object that executesaction
- the action to execute
-
onActionAdd
This method is called *before* adding an action by RPScheduler so you can choose not to allow the action to be added by returning false- Parameters:
object
- the object that casted the actionaction
- the action that is going to be added.actionList
- the actions that this player already owns.- Returns:
- true if we approve the action to be added.
-
onTimeout
Callback method called when a new player time out. This method MUST logout the player- Parameters:
object
- the new player that timeouts.
-
onExit
Callback method called when a player exits the game- Parameters:
object
- the new player that exits the game.- Returns:
- true to allow player to exit
-
onInit
Callback method called when a new player enters in the game- Parameters:
object
- the new player that enters in the game.- Returns:
- true if object has been added.
-