Python party functions

Functions
static PyObject *	Atrinik_Party_AddMember (Atrinik_Party *party, PyObject *args)
static PyObject *	Atrinik_Party_RemoveMember (Atrinik_Party *party, PyObject *args)
static PyObject *	Atrinik_Party_GetMembers (Atrinik_Party *party, PyObject *args)
static PyObject *	Atrinik_Party_SendMessage (Atrinik_Party *party, PyObject *args)

---

Detailed Description

Party related functions used in Atrinik Python plugin.

---

Function Documentation

static PyObject* Atrinik_Party_AddMember	(	Atrinik_Party *	party,
		PyObject *	args
	)		[static]

party.AddMember(object player)

Add a player to the specified party.

Parameters:

player

Player object to add to the party.

Exceptions:

ValueError	if 'player' is not a player object.
AtrinikError	if the player is already in the same or another party.

Definition at line 57 of file atrinik_party.c.

static PyObject* Atrinik_Party_GetMembers	(	Atrinik_Party *	party,
		PyObject *	args
	)		[static]

party.GetMembers()

Get members of a specified party.

Returns:

List containing player objects of the party members.

Definition at line 128 of file atrinik_party.c.

static PyObject* Atrinik_Party_RemoveMember	(	Atrinik_Party *	party,
		PyObject *	args
	)		[static]

party.RemoveMember(object player)

Remove a player from the specified party.

Parameters:

player

Player object to remove from the party.

Exceptions:

ValueError	if 'player' is not a player object.
AtrinikError	if the player is not in a party.

Definition at line 97 of file atrinik_party.c.

static PyObject* Atrinik_Party_SendMessage	(	Atrinik_Party *	party,
		PyObject *	args
	)		[static]

party.SendMessage(string message, int flags, object [player = None])

Send a message to members of a party.

Parameters:

message	Message to send.
flags	Flags. See Party message types.
player	Player object to exclude from sending the message.

Definition at line 149 of file atrinik_party.c.