#include <SPGameAPIClass.h>
Inheritance diagram for SecurePlayLibrary::SPGameAPIClass:

Public Member Functions | |
| SPGameAPIClass (SPGameClass *game) | |
| SPGameAPIClass () | |
| ~SPGameAPIClass () | |
| bool | APIbeginGame (string playerID) |
| bool | APIendGame (string playerID) |
| string | GetNextGameSegmentID (string currentsegment) |
| bool | isPlayerInternal (string pid) |
| bool | isPlayerIncluded (string pid) |
| SPAbstractTransactionInterface * | buildTransaction (string transtype, SPGameClass *gameobj, string master, vector< string > playerIDList, bool privateflag, string transactionID) |
| bool | APIcloseTransaction (string transID) |
| SPAbstractTransactionInterface * | APIcreateTransaction (string transtype, string transmaster, vector< string > playerIDList, bool privateflag) |
| bool | APIBcreateTransaction (string transtype, string transmaster, vector< string > playerIDList, bool privateflag) |
| SPAbstractTransactionAPIInterface * | APITAOcreateTransaction (string transtype, string transmaster, vector< string > playerIDList, bool privateflag) |
| bool | onnewTransaction (SPMessageClass *incoming) |
| bool | APIPlayerJoin (string sender, string pid, string cid) |
| bool | APIPlayerJoin (string sender, string pid, string cid, bool rflag) |
| bool | onPlayerJoin (SPMessageClass *messObj) |
| bool | joinPlayer (string pid, string cid, bool rflag) |
| bool | rulesnewplayerconfig (string pid, string cid, bool rflag) |
| bool | APIrequestbeginGame (string playerID) |
| bool | APIrequestendGame (string playerID) |
| bool | APIrequestcreateTransaction (string pid, string transmaster, string transtype, vector< string > playerIDList, bool privateflagIN) |
| bool | APIrequestPlayerJoin (string sender, string pid, string cid, bool rflagIN) |
| bool | onrequestcreateTransaction (SPMessageClass *incoming) |
| bool | onrequestPlayerJoin (SPMessageClass *messObj) |
| bool | rulesbeginGame (string requesterID) |
| bool | rulesendGame (string requesterID) |
| bool | rulesPlayerJoin (string sender, vector< string > messbody) |
| bool | rulescreateTransaction (string sender, string transtype, string master, vector< string > players, bool pflag) |
| string | APIgetLicenseSummary () |
| SPLogInterface * | APIgetGameLog () |
| void * | APIgetGameLogCurrentEntry () |
| int | APIgetGameLogLength () |
| void * | APIgetGameLogNextEntry () |
| void * | APIgetGameLogPreviousEntry () |
| vector< string > | APIgetOpenTransactionIDs () |
| SPAbstractTransactionAPIInterface * | APIgetTransactionAPI (string tid) |
| void | logError () |
| bool | sendMessage (string sender, vector< string > receivers, bool encryptflag, bool privateflag, string messagetype, vector< string > messagebody, vector< string > altmessage) |
| SPAbstractTransactionInterface * | APIgetTransaction (string tid) |
| bool | APIAddListener (SPEventInterface *gameobj) |
| bool | APIRemoveListener (SPEventInterface *gameobj) |
| vector< SPEventInterface * > | APIGetListeners () |
| bool | APIClearListeners () |
| int | APIGetListenerCount () |
| SPTBlastClass * | APIcreateBlastTransaction (string pid, vector< string > transcontent) |
| void | onBlast (SPMessageClass *messObj) |
| SPPlayerInterface * | APIgetPlayer (string pid) |
| SPGameClass * | getGameinstance () |
| bool | isLibrarytestmode () |
| vector< string > | APIgetPlayerIDList () |
| bool | APInewGameBlock (string pid, vector< string > receivers, string gameblocktype, string gameblockID, vector< string > gameblockparameters) |
| void | onnewGameBlock (SPMessageClass *messObj) |
Public Attributes | |
| const string | extendedversion |
| const string | releaseversion |
Private Member Functions | |
| SPGameAPIClass (const SPGameAPIClass &p) | |
| operator= (const SPGameAPIClass &p) | |
| SPTBlastClass * | buildBlastTransaction (string pid, vector< string > transcontent) |
Private Attributes | |
| SPGameClass * | gameinstance |
| const bool | librarytestmode |
|
|
Private Copy Constructor that protects this class from being copied. |
|
|
Overloaded Constructor
|
|
|
Default Constructor. |
|
|
Default Destructor. |
|
|
This method adds a listener object for Game API events
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||
|
This method allows the creation of a new, internally controlled transaction. It also sends a message to the other transaction and game participants about this new transaction. NOTE: Thims method may not be supported
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method safely begins the game
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method clears the listener objects for Game API events
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method removes a transaction from the game instance's open transaction list.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||
|
This method creates a default Blast Transaction for this library.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||
|
This method allows the creation of a new, internally controlled transaction. It also sends a message to the other transaction and game participants about this new transaction. NOTE: Thims method may not be supported
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method safely ends a game.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Gets the messagelog object from the gameinstance
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Returns current entry from the messagelog object of comms
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
returns the number entries in messagelog
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Returns the next entry from the messagelog object of comms
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Returns the previous entry from the messagelog object of the comms
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method returns a summary of the licensee information for the current game instance. This information needs to be publicly available from any game instance, see SecurePlay license for details.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method returns the number of listener objects for Game API events
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method returns a list of listener objects for Game API events
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Returns a vector that contains a list of open transaction IDs
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method gets the player from the game instance using the player ID
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method gets the player id list list associated with this game.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method gets the transaction from the game instance using the transaction ID
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method returns the transaction API of the game transaction using sid.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||||||
|
This method notifies other players of a new GameBlock. GameBlocks are sets of rules or modules of code that can be associated with transactions.
|
|
||||||||||||||||||||
|
This method carries out the local process of adding a new Player to the local game instance.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||
|
This method allows the Game instance Master to safely add a new player during the course of a game and to notify the remote players of this information.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method removes a listener object for Game API events
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method sends a request to the game instance master to begin the game.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||||||
|
This method safely allows a player to request the creation of a new transaction of a given type and parameters.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method sends a message from the specified player to the game instance master to end the game.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||
|
This method sends a request to a remote game instance to add a player during a game. Note, only the game master can add a player.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||
|
This method allows the creation of a new, internally controlled transaction. It also sends a message to the other transaction and game participants about this new transaction. NOTE: Thims method may not be supported
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||
|
This method actually constructs the Blast Transaction
|
|
||||||||||||||||||||||||||||
|
This method builds a local transaction associated with a game instance.
|
|
|
Getter function that returns the property: gameinstance
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method gets automatically called by the Game any time the conditions for a new Game Segment are met according to the SecurePlay Library license. THIS FUNCTION IS A STUB - A global system for unique game segment generation needs to be created in compliance with the SecurePlay license. NOTE - An initial Game Segment needs to be set for each individual game played online this is highly variable - it could be set by a server, a client, a peer, or other system on a case-by-case basis. The base Game Segment ID is provided by SecurePlay.com. One party to the game or supporting the game is responsible for setting the Game Segment ID - the master for the game transaction in this reference implementation. REMOVAL, CIRCUMVENTION, OR DELETION OF THIS FUNCTION IS A VIOLATION OF THE SECUREPLAY LICENSE. ANY CHANGES MUST BE COORDINATED - SEE THE SECUREPLAY LICENSE FOR DETAILS.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Getter function that returns the property: librarytestmode
|
|
|
This method tests to determine if a specified player is a transaction participant.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method checks to see whether a specified playerID is internal to the local SecurePlay library process
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||
|
This method carries out the local process of adding a new Player to the local game instance.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Shell Function. |
|
|
This method handles incoming new Blast Transactions
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method handles incoming new Game Blocks
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method handles messages for new incoming transactions. It ensures that the new transactions are safely instantiated and loaed into the game.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method safely handles remote messages for the addition of a player to the local game instance.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This method handles incoming requests for the creation of new transactions. Only the proposed transaction master can create a new transaction.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Safely handles requests to add a player. Only the Game Master can add a player.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Private = operator that protects this class from being copied. |
|
|
This is a shell function to allow the insertion of rules code for the decision to begin a game.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||||||
|
This method safely allows a player to request the creation of a new transaction of a given type and parameters.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
This is a shell method to allow the evaluation of the game rules to determine if the game should be allowed to end.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||
|
This shell method takes an incoming proposed configuration for a new player and maps it against the local preference for that player, if different.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||
|
This is a shell method to determine if a player will be allowed to join in midgame. Only the Game Master can implement this request.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
||||||||||||||||||||||||||||||||
|
This method is a wrapper for the game instance sendMessage() method.
Implements SecurePlayLibrary::SPGameAPIInterface. |
|
|
Developer extended version. |
|
|
This is the handler for the associated game instance object |
|
|
This should be set to FALSE for production systems or all "rulesXXXX methods should be edited |
|
|
IT GlobalSecure release version. |