mirror of
https://github.com/polserver/polserver
synced 2026-08-13 08:23:08 -04:00
68 lines
2.7 KiB
XML
68 lines
2.7 KiB
XML
<?xml version='1.0' encoding="iso-8859-1"?>
|
|
<?xml-stylesheet type="text/xsl" href="escript.xslt" ?>
|
|
<!DOCTYPE ESCRIPT SYSTEM "escript.dtd">
|
|
<ESCRIPT>
|
|
<fileheader fname="Party.em">
|
|
<filedesc>Functions for working with parties in eScript.</filedesc>
|
|
<datemodified>08/31/2015</datemodified>
|
|
</fileheader>
|
|
|
|
<function name="CreateParty">
|
|
<prototype>CreateParty( leader, firstmember)</prototype>
|
|
<parameter name="leader" value="Character Reference" />
|
|
<parameter name="firstmember" value="Character Reference" />
|
|
<explain>Creates a Party with given leader and firstmember.</explain>
|
|
<return>1 on success</return>
|
|
<error>"Leader is already in a party"</error>
|
|
<error>"Leader is already candidate of a party"</error>
|
|
<error>"Leader and Firstmember are the same"</error>
|
|
<error>"First Member is already in a party"</error>
|
|
<error>"First Member is already candidate of a party"</error>
|
|
<error>"Invalid parameter type"</error>
|
|
<related>Party</related>
|
|
<relatedcfg>party.cfg</relatedcfg>
|
|
</function>
|
|
|
|
<function name="DisbandParty">
|
|
<prototype>DisbandParty( PartyRef )</prototype>
|
|
<parameter name="PartyRef" value="Party Reference" />
|
|
<explain>Disbands the given Party</explain>
|
|
<return>1 on success</return>
|
|
<error>"Party has no leader"</error>
|
|
<error>"Invalid parameter type"</error>
|
|
<related>Party</related>
|
|
<relatedcfg>party.cfg</relatedcfg>
|
|
</function>
|
|
|
|
<function name="SendPartyMsg">
|
|
<prototype>SendPartyMsg( party, character, uctext )</prototype>
|
|
<parameter name="party" value="Party Reference" />
|
|
<parameter name="character" value="Character Reference" />
|
|
<parameter name="uctext" value="Array of 2-byte integers, where each integer is a Unicode character" />
|
|
<explain>Sends a Party Message with character=Sender</explain>
|
|
<return>1 on success</return>
|
|
<error>"Unicode array exceeds maximum size."</error>
|
|
<error>"Invalid value in Unicode array."</error>
|
|
<error>"Invalid parameter type"</error>
|
|
<related>Party</related>
|
|
<related>Array</related>
|
|
<relatedcfg>party.cfg</relatedcfg>
|
|
</function>
|
|
|
|
<function name="SendPrivatePartyMsg">
|
|
<prototype>SendPrivatePartyMsg( party, character, tocharacter, uctext )</prototype>
|
|
<parameter name="party" value="Party Reference" />
|
|
<parameter name="character" value="Character Reference" />
|
|
<parameter name="tocharacter" value="Character Reference" />
|
|
<parameter name="uctext" value="Array of 2-byte integers, where each integer is a Unicode character" />
|
|
<explain>Sends a Private Party Message with character=Sender</explain>
|
|
<return>1 on success</return>
|
|
<error>"Unicode array exceeds maximum size."</error>
|
|
<error>"Invalid value in Unicode array."</error>
|
|
<error>"Invalid parameter type"</error>
|
|
<related>Party</related>
|
|
<related>Array</related>
|
|
<relatedcfg>party.cfg</relatedcfg>
|
|
</function>
|
|
|
|
</ESCRIPT>
|