POL Scripting Reference

File: Cliloc.em

Description: Functions for sending Cliloc (Client Localized) messages to the Client.
Last Modified: 10/27/2007

File Constants:

const _DEFAULT_CLFONT := 3;
const _DEFAULT_CLCOLOR := 0x3B2;

PrintTextAboveCL(character, cliloc_num, uc_text:={}, font:=_DEFAULT_CLFONT, color:=_DEFAULT_CLCOLOR)
Parameters:
Name	Type
`character`	Character reference to receive the text
`cliloc_num`	Cliloc Number you wish to be displayed.
`uc_text`	Array of 2-byte integers, where each integer is a Unicode character. Only used when the cliloc accepts arguments for replacement.
`font`	Integer (optional) font code. Not the same as non-unicode font codes
`color`	Integer (optional) color code. Not the same color as the same value for non-unicode prints
Explanation
Displays a Cliloc (Client Localized) message above 'character'. Arguments for the cliloc itself are seperated with a tab (\t) character.
uc_text MUST be an array of integers representing unicode characters.
Integers must be "Big Endian" (0x1234) and not "Little Endian" (0x3412).
Integers will be clipped internally to 2-bytes (value masked with 0xFFFF)
The Array must be terminated with zero. (0x0000)

Argument example: Cliloc Number: 1042762: Cliloc ENU String: "Only ~1_AMOUNT~ gold could be deposited. A check for ~2_CHECK_AMOUNT~ gold was returned to you." The uc_text string may have "100 thousand\t25 hundred", which in turn would modify the string: "Only 100 thousand gold could be deposited. A check for 25 hundred gold was returned to you."
Return values
1 on success
Errors
"Unicode array exceeds maximum size." (200 characters)
"Invalid value in Unicode array."
"A parameter was invalid"
Related
Array

PrintTextAbovePrivateCL(character, object, cliloc_num, uc_text:={}, font:=_DEFAULT_CLFONT, color:=_DEFAULT_CLCOLOR)
Parameters:
Name	Type
`character`	Character reference to receive the text
`object`	UObject reference to print the text above
`cliloc_num`	Cliloc Number you wish to be displayed.
`uc_text`	Array of 2-byte integers, where each integer is a Unicode character. Only used when the cliloc accepts arguments for replacement.
`font`	Integer (optional) font code. Not the same as non-unicode font codes
`color`	Integer (optional) color code. Not the same color as the same value for non-unicode prints
Explanation
Displays a Cliloc (Client Localized) message above 'character'. Arguments for the cliloc itself are seperated with a tab (\t) character.
uc_text MUST be an array of integers representing unicode characters.
Integers must be "Big Endian" (0x1234) and not "Little Endian" (0x3412).
Integers will be clipped internally to 2-bytes (value masked with 0xFFFF)
The Array must be terminated with zero. (0x0000)

Argument example: Cliloc Number: 1042762: Cliloc ENU String: "Only ~1_AMOUNT~ gold could be deposited. A check for ~2_CHECK_AMOUNT~ gold was returned to you." The uc_text string may have "100 thousand\t25 hundred", which in turn would modify the string: "Only 100 thousand gold could be deposited. A check for 25 hundred gold was returned to you."
Return values
1 on success
Errors
"Unicode array exceeds maximum size." (200 characters)
"Invalid value in Unicode array."
"A parameter was invalid"
Related
Array

SendSysMessageCL(character, cliloc_num, uc_text:={}, font:=_DEFAULT_CLFONT, color:=_DEFAULT_CLCOLOR)
Parameters:
Name	Type
`character`	Character reference to receive the text
`cliloc_num`	Cliloc Number you wish to be displayed.
`uc_text`	Array of 2-byte integers, where each integer is a Unicode character. Only used when the cliloc accepts arguments for replacement.
`font`	Integer (optional) font code. Not the same as non-unicode font codes
`color`	Integer (optional) color code. Not the same color as the same value for non-unicode prints
Explanation
Displays a Cliloc (Client Localized) system message to 'character'. Arguments for the cliloc itself are seperated with a tab (\t) character.
uc_text MUST be an array of integers representing unicode characters.
Integers must be "Big Endian" (0x1234) and not "Little Endian" (0x3412).
Integers will be clipped internally to 2-bytes (value masked with 0xFFFF)
The Array must be terminated with zero. (0x0000)

Argument example: Cliloc Number: 1042762: Cliloc ENU String: "Only ~1_AMOUNT~ gold could be deposited. A check for ~2_CHECK_AMOUNT~ gold was returned to you." The uc_text string may have "100 thousand\t25 hundred", which in turn would modify the string: "Only 100 thousand gold could be deposited. A check for 25 hundred gold was returned to you."
Return values
1 on success
Errors
"Unicode array exceeds maximum size." (200 characters)
"Invalid value in Unicode array."
"A parameter was invalid"
Related
Array

If you know if any information is incorrect on these pages, mail your corrections to polteam@polserver.com