Functions:
| CreateParty( leader, firstmember) | |
|---|---|
| Parameters: | |
| Name | Type |
| leader | Character Reference |
| firstmember | Character Reference |
| 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 | |
| Party | |
| Related Configs | |
| party.cfg | |
| DisbandParty( PartyRef ) | |
|---|---|
| Parameters: | |
| Name | Type |
| PartyRef | Party Reference |
| Explanation | |
| Disbands the given Party | |
| Return values | |
| 1 on success | |
| Errors | |
| "Party has no leader" | |
| "Invalid parameter type" | |
| Related | |
| Party | |
| Related Configs | |
| party.cfg | |
| SendPartyMsg( partyref, character, uctext ) | |
|---|---|
| Parameters: | |
| Name | Type |
| partyref | Party Reference |
| character | Character Reference |
| uc_text | 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 | |
| Party | |
| Array | |
| Related Configs | |
| party.cfg | |
| SendPrivatePartyMsg( partyref, character, tocharacter, uctext ) | |
|---|---|
| Parameters: | |
| Name | Type |
| partyref | Party Reference |
| character | Character Reference |
| tocharacter | Character Reference |
| uc_text | 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 | |
| Party | |
| Array | |
| Related Configs | |
| party.cfg | |