Base
[ class tree: Base ] [ index: Base ] [ all elements ]

Class: libGameMessage

Source Location: /lib/gamemessage.php

Class Overview


Send a message to a member of a country in a game, from another member. Used by GameMaster in processGame, and libChatbox


Variables

Methods



Class Details

[line 28]
Send a message to a member of a country in a game, from another member. Used by GameMaster in processGame, and libChatbox



[ Top ]


Class Variables

static $validFromCountries = array('GameMaster', 'England', 'France', 'Italy', 'Germany', 'Austria', 'Turkey', 'Russia')

[line 39]

Valid countries/tabs to receive from



Tags:

access:  public

Type:   mixed


[ Top ]

static $validToCountries = array('Global', 'England', 'France', 'Italy', 'Germany', 'Austria', 'Turkey', 'Russia')

[line 34]

Valid countries/tabs to send to



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


static method notify [line 85]

static void notify( string $toCountry, string $fromCountry, Game $Game)

Notify a country that you sent them a message, uses the global Game



Tags:

access:  private


Parameters:

string   $toCountry   The country sent to, can be 'Global'
string   $fromCountry   The country sent from
Game   $Game   The game being referred to

[ Top ]

static method send [line 49]

static void send( string $toCountry, string $fromCountry, string|array $message, [int[optional] $gameID = -1])

Send a game message. Messages are sanitized



Tags:

access:  public


Parameters:

string   $toCountry   The country being sent to. 'Global' sends to all.
string   $fromCountry   The county being sent from. 'GameMaster' can also be used.
string|array   $message   The message(s) to be sent (Can be an array of messages for)
int[optional]   $gameID   The game ID to use. If not given the current global Game is sent to.

[ Top ]


Documentation generated on Thu, 13 Nov 2008 18:15:55 +0900 by phpDocumentor 1.4.1