Documentation › Modules › Party.em

File: Party.em

Functions for working with parties in eScript.

Last modified: 08/31/2015

CreateParty( leader, firstmember )#

Parameters

Explanation

Creates a Party with given leader and firstmember.

Return values

1 on success

Errors

  • "Leader is already in a party"
  • "Leader is already candidate of a party"
  • "Leader and Firstmember are the same"
  • "First Member is already in a party"
  • "First Member is already candidate of a party"
  • "Invalid parameter type"

Related

Related config

DisbandParty( PartyRef )#

Parameters

PartyRef Party Reference

Explanation

Disbands the given Party

Return values

1 on success

Errors

  • "Party has no leader"
  • "Invalid parameter type"

Related

Related config

ListParties()#

Explanation

Gets a list of all parties.

Return values

Array of Party References

Related

Related config

SendPartyMsg( party, character, uctext )#

Parameters

party Party Reference
character Character Reference
uctext Array of 2-byte integers, where each integer is a Unicode character

Explanation

Sends a Party Message with character=Sender

Return values

1 on success

Errors

  • "Unicode array exceeds maximum size."
  • "Invalid value in Unicode array."
  • "Invalid parameter type"

Related

Related config

SendPrivatePartyMsg( party, character, tocharacter, uctext )#

Parameters

party Party Reference
character Character Reference
tocharacter Character Reference
uctext Array of 2-byte integers, where each integer is a Unicode character

Explanation

Sends a Private Party Message with character=Sender

Return values

1 on success

Errors

  • "Unicode array exceeds maximum size."
  • "Invalid value in Unicode array."
  • "Invalid parameter type"

Related

Related config