Usecode C

Download Markdown | Natural Docs source

General Definitions

For Usecode C purposes, the avatar is an NPC just like any other. Constants referred to below (usually in ALL CAPS) are defined in 'src/headers/constants.uc' unless otherwise stated.

Unlike Usecode C-defined functions, intrinsics do not have a 'prototype'; you can pass as many (or as few) parameters to an intrinsic as you like. The only 'hard' limits are that Exult will not like if you (1) call an intrinsic with more than 12 parameters or (2) the intrinsic expects parameters which you haven't supplied. The parameter lists in the list below is the minimum safe number of parameters.

To the right of many intrinsic 'prototypes', you can see an indicator between square brackets. This indicator is a quick way to see if that intrinsic is available for the specific game you are interested in. The possible values of these indicators are:

Indicator	Meaning
	BG-specific intrinsic
	SI-specific intrinsic
	Exult-specific intrinsic, available to both BG and SI
	Originally BG-only, Exult allows it in SI too
	Originally SI-only, Exult allows it in BG too
	Exult-specific intrinsic, available only to BG
	Exult-specific intrinsic, available only to SI
(not present)	Intrinsic available for BG and SI

The '', '' and '' indicators are essentially equivalent to no indicator at all; they are used in this document only for completeness.

The intrinsic prototypes below are in Usecode C-esque form. It is actually more like C than Usecode C. Specifically, all parameters have a type instead of the Usecode C-'var'. The parameter type indicates what Exult will be expecting; the Usecode C compiler won't care in the slightest what you pass as a parameter. The parameter types I use are as follows:

If the parameter name is followed by a '[]', it indicates an array with elements of the specified type. Example: 'actor npc[]' means an array of NPCs. If there is a number between the brackets, it means an array of that length; for example, 'int num[3]' means an array with 3 'int' elements. In some cases, an array can be of type 'mixed' to indicate that not all of the array's elements are of the same type.

Some intrinsics are 'overloaded'; i.e., they accept more than one parameter type. In those cases, all of the possibilities are listed as prototypes.

If the parameter list is simply '[special]', see the description for details.

If the intrinsic is preceded by a parameter type, it means that the intrinsic returns something of that type; the description explains the return value. In some cases, the return value can be 'mixed[]' to indicate that the intrinsic returns an array, not all of which are of the same type.

All intrinsics can be called as presented in the list. If an intrinsic has at least one parameter, it can be called in 'calle' form, with the first parameter as its 'object'. Example:

int UI_execute_usecode_array(object obj, int script[]);
int obj->execute_usecode_array(int script[]);

The first parameter and the '->' can both be omitted if 'obj' is 'item', and if you omit either of them you must omit both or the Usecode will fail to compile. For stylistic purposes, the 'calle' form should be used only when the first parameter is an object or NPC (or 'item'). For all intrinsics with 'appropriate' parameter types, I have listed both forms in the list below.

Also, you may have noticed that I did not include the parameter type of 'obj' when I gave the 'calle' form of execute_usecode_array; since I will only give the 'calle' form when the parameter type is 'object' or 'actor', I feel that it is unneeded.

Random Number Intrinsics

These intrinsics are all related to random numbers and their generation.

UI_get_random

int UI_get_random(int max)

Generates a random number, similar to rolling a dice of the given side.

Parameters

Return

Zero if max is zero; otherwise, a random number ranging from 1 to max.

UI_die_roll

int UI_die_roll(int min, int max)

Generates a random number in the specified range.

Parameters

Return

A random number ranging from min to max. If min > max, the two parameters are reversed by Exult.

UI_roll_to_win

bool UI_roll_to_win(int att, int def)

Performs a contest between two supplied values.

Parameters

Return

The contest is a roll of a 30-sided die: if the die comes up 30, the return is true; if it comes up 1, the return is false. For all other values, the attack value is added to the die roll and the defense value is subtracted from the same roll. If the result is 15 or more, the attacker wins and the return is true; otherwise, the attacker loses and the return is false.

Scripting Intrinsics

These intrinsics are used to animate characters from usecode. Some of these are deprecated by script blocks, but all others are still useful at times.

UI_execute_usecode_array

int UI_execute_usecode_array(object obj, int script[])
int obj->execute_usecode_array(int script[])

Deprecated; use Usecode C script blocks instead. Animates an object according to the supplied script.

Parameters

Return

Always returns '1'.

UI_delayed_execute_usecode_array

int UI_delayed_execute_usecode_array(object obj, int script[], int delay)
int obj->delayed_execute_usecode_array(int script[], int delay)

Deprecated; use Usecode C script blocks instead. Animates an object according to the supplied script after a delay. Works exactly like execute_usecode_array, but starts only after the specified delay.

Parameters

Return

Always returns '1'.

UI_in_usecode

bool UI_in_usecode(object obj)
bool obj->in_usecode()

Checks if an object is currently executing any usecode scripts.

Parameters

Return

true if there are any scripts for the specified object, false otherwise.

UI_halt_scheduled

UI_halt_scheduled(object obj)
obj->halt_scheduled()

Terminates usecode scripts that animate the supplied object. Scripts that include the 'nohalt' command are not affected by this intrinsic.

Parameters

UI_begin_casting_mode

UI_begin_casting_mode(actor npc, int val)
npc->begin_casting_mode(int val)

Makes an NPC display casting frames until the end of its next script.

Parameters

UI_set_to_attack

int UI_set_to_attack(actor attacker, object target, int weapon)
int attacker->set_to_attack(object target, int weapon)
int UI_set_to_attack(actor attacker, mixed[4] target, int weapon)
int attacker->set_to_attack(mixed[4] target, int weapon)

Schedules a NPC to attack the object with a given weapon. This intrinsic does not animate the NPC in any way; the scheduled attack only emulates the actual hit with the selected weapon. The actual attack is triggered by a script; in an Usecode C script, use the 'attack' command to actually perform the attack.

Parameters

If the NPC is targeting a tile, the attack will only be meaningful if the weapon causes an explosion.

Return

true if attacking a valid target with a valid weapon, false otherwise.

UI_path_run_usecode

bool UI_path_run_usecode(int pos[], function fun, object obj, int event, int simode)

Causes the avatar to walk to a location and execute the specified usecode function when he/she arrives at the destination. If a path cannot be found for the destination, no usecode will be executed unless a call to set_path_failure intrinsic is made before returning from usecode.

The avatar can be prevented from reaching his/her destination simply by moving away from the path; this will cancel the effects of the intrinsic, and will cause the usecode function set by set_path_failure to be called. If you want the path to be uninterruptible, the avatar's DONT_MOVE flag must be set (this is flag 22 in BG and 16 in SI).

The other party members will follow the avatar towards the destination.

SI SPECIFIC

In SI, path_run_usecode finds a free spot within 3 tiles of the position specified by 'pos'; it also allows a rise/drop of 3 in the z direction.

Parameters

Return

If no path can be found to the destination, returns false; otherwise, returns true.

UI_si_path_run_usecode

UI_si_path_run_usecode(actor npc, int pos[], int event, object obj, function fun, bool flag)
npc->si_path_run_usecode(int pos[], int event, object obj, function fun, bool flag)

Causes an NPC to walk to a location and execute the specified usecode function when he/she arrives at the destination. If a path cannot be found for the destination, no usecode will be executed unless a call to set_path_failure intrinsic is made before returning from usecode.

The avatar can be prevented from reaching his/her destination simply by moving away from the path; similarly, a scheduled event or scripted event may prevent an NPC from reaching his/her destination. In these cases, the effects of the intrinsic will be cancelled, and the usecode function set by set_path_failure will be called. If you want the path to be uninterruptible, the NPC's DONT_MOVE flag must be set (this is flag 22 in BG and 16 in SI).

Parameters

UI_set_path_failure

UI_set_path_failure(function fun, object obj, int event)

Sets usecode to be called if an NPC fails to reach its destination. This intrinsic must be used after a call to either, path_run_usecode or si_path_run_usecode intrinsics, and will affect only the NPC affected by that call. If, for any reason, the NPC in question cannot reach the destination, the usecode function assigned by this intrinsic will be run.

Parameters

SI SPECIFIC

In the original SI, this could never affect the failure event for si_path_run_usecode, which would always be 14. Exult does not suffer from this limitation.

UI_in_usecode_path

bool UI_in_usecode_path(actor npc)
bool npc->in_usecode_path()

Checks whether or not the actor is traversing a path due to path_run_usecode or si_path_run_usecode intrinsics.

Parameters

Return

true if the NPC is still walking a usecode path, false otherwise.

UI_telekenesis

UI_telekenesis(function fun)

Deprecated; stores a usecode function for special script behavior. The next script call to the stored function (e.g., 'script item call fun;') will have an event ID of 'DOUBLECLICK' instead of the standard 'SCRIPTED' event ID used for scripts. Since Usecode C scripts allow calling a function with an event ID of your choice (e.g., 'script item call fun, DOUBLECLICK;') it is best to simply ignore this intrinsic.

Parameters

Conversation Intrinsics

These intrinsics are used to display faces for conversations, storing and recalling answers, etc.

UI_show_npc_face

UI_show_npc_face(int face, int frnum)
UI_show_npc_face(actor face, int frnum)
face->show_npc_face(int frnum)

Displays a face onscreen for conversations. The face is a shape from 'FACES.VGA'. This intrinsic finds a free slot to display the face in or uses the second slot if there are no free slots.

Parameters

If 'face' is an integer, the shape to be displayed is the absolute value of this number. If this value is 0 or 356, the avatar's face will be displayed, using the correct face for the avatar's skin and PETRA status flag.

If 'face' is an NPC, the Exult Studio-set face for that NPC is displayed; the "default" face is equal to the NPC's number.

For the cases when 'frnum is zero, you should use Usecode C's 'npc.say()' to display the NPC's face and display any text within the parenthesis (or set with 'message') too.

UI_show_npc_face0

UI_show_npc_face0(int face, int frnum)
UI_show_npc_face0(actor face, int frnum)
face->show_npc_face0(int frnum)

Displays a face onscreen for conversations. The face is a shape from 'FACES.VGA'. This intrinsic always uses slot 0 for the new face.

Parameters

If 'face' is an integer, the shape to be displayed is the absolute value of this number. If this value is 0 or 356, the avatar's face will be displayed, using the correct face for the avatar's skin and PETRA status flag.

If 'face' is an NPC, the Exult Studio-set face for that NPC is displayed; the "default" face is equal to the NPC's number.

For the cases when 'frnum is zero, you should use Usecode C's 'npc.say()' to display the NPC's face and display any text within the parenthesis (or set with 'message') too.

UI_show_npc_face1

UI_show_npc_face1(int face, int face)
UI_show_npc_face1(actor face, int face)
npc->show_npc_face1(int face)

Displays a face onscreen for conversations. The face is a shape from 'FACES.VGA'. This intrinsic always uses slot 1 for the new face.

Parameters

If 'face' is an integer, the shape to be displayed is the absolute value of this number. If this value is 0 or 356, the avatar's face will be displayed, using the correct face for the avatar's skin and PETRA status flag.

If 'face' is an NPC, the Exult Studio-set face for that NPC is displayed; the "default" face is equal to the NPC's number.

For the cases when 'frnum is zero, you should use Usecode C's 'npc.say()' to display the NPC's face and display any text within the parenthesis (or set with 'message') too.

UI_remove_npc_face

UI_remove_npc_face(int face)
UI_remove_npc_face(actor face)
face->remove_npc_face()

Deprecated; use Usecode C's 'npc.hide()' statement instead. Hides the specified face if it is being shown.

Parameters

If 'face' is an integer, the shape to be hidden is the absolute value of this number. If this value is 0 or 356, the avatar's face will be hidden.

If 'face' is an NPC, the Exult Studio-set face for that NPC is hidden; the "default" face is equal to the NPC's number.

UI_remove_npc_face0

UI_remove_npc_face0()

Removes whatever face is being shown in slot 0.

UI_remove_npc_face1

UI_remove_npc_face1()

Removes whatever face is being shown in slot 1.

UI_reset_conv_face

UI_init_reset_conv_face()

Changes the active conversation slot to the top slot and sets its current frame to 0.

UI_set_conversation_slot

UI_set_conversation_slot(int slot)
npc->set_conversation_slot()

Changes the active conversation slot.

Parameters

UI_change_npc_face0

UI_change_npc_face0(int frame)

Changes the frame of the face being displayed in slot 0.

Parameters

UI_change_npc_face1

UI_change_npc_face1(int frame)

Changes the frame of the face being displayed in slot 1.

Parameters

UI_init_conversation

UI_init_conversation()

Initializes the face information for a conversation. In Exult, it is usually safe to skip it.

UI_end_conversation

UI_end_conversation()

Shows any pending text and removes all faces from the screen. Usually safe to skip this in Exult.

UI_add_answer

UI_add_answer(string answer)
UI_add_answer(string answer[])

Deprecated; use Usecode C's 'add(string answer)' or 'add(string answer[])' statements instead. Adds the specified strings as dialog options that the player can select.

Parameters

UI_remove_answer

UI_remove_answer(string answer)
UI_remove_answer(string answer[])

Deprecated; use Usecode C's '(remove)' construct instead. Removes the supplied strings from the dialog options available to the player.

Parameters

UI_push_answers

UI_push_answers()

Stores the current conversation options and clears all choices. The dialog options are stored in a LIFO stack that persists until the dialog ends; before that point, the stored options can be retrieved with a call to UI_pop_answers intrinsic.

UI_pop_answers

UI_pop_answers()

Clears all current conversation options and restores the stored conversation options, if any. The restored dialog options are those stored by the last call to UI_push_answers intrinsic.

UI_clear_answers

UI_clear_answers()

Clears all current dialog options.

UI_select_from_menu

string UI_select_from_menu()

Makes the player choose one answer from all dialog options currently being displayed.

Return

The chosen dialog option.

UI_select_from_menu2

int UI_select_from_menu2()

Makes the player choose one answer from all dialog options currently being displayed.

Return

The index (ranging from 1 to n) of the chosen dialog option.

Sound Intrinsics

All intrinsics in this section relate to playing sound effects, music or speech.

UI_play_sound_effect

UI_play_sound_effect(int sfx)

Plays a sound effect.

Parameters

UI_play_sound_effect2

UI_play_sound_effect2(int sfx, object obj)

Causes an object to generate a sound effect.

Parameters

UI_play_music

UI_play_music(int track, object obj)

Plays the specified song.

Parameters

If supplied with a valid object or NPC that is on the game world, this intrinsic will also display the sprite effect # 24 (musical notes).

UI_get_music_track

int UI_get_music_track()

Gets the music being played.

Return

If music is enabled and a song is playing, returns the track number of the current song. Otherwise, return is -1.

NOTES ABOUT ORIGINAL BG

The return value in the original Black Gate was more complicated; the current song was the return value divided by 256, while the next song (the one that would be resumed after the current one ends) was the remainder of that same division. None of this behavior is true for Exult, which works as described above.

UI_start_speech

bool UI_start_speech(int track)

Plays the specified speech track.

SI SPECIFIC

In SI, speech also displays a full-screen face from 'FACES.VGA'.

Parameters

Return

Returns false if failed to play the requested speech track (for example, if speech is disabled), true otherwise.

UI_start_blocking_speech

bool UI_start_blocking_speech(int track)

Plays the specified speech track. Blocks until the speech finishes.

SI SPECIFIC

In SI, speech also displays a full-screen face from 'FACES.VGA'.

Parameters

Return

Returns false if failed to play the requested speech track (for example, if speech is disabled), true otherwise.

UI_get_speech_track

int UI_get_speech_track()

Determines the currently playing speech track.

Return

A number indicating what voice track is being played.

Searching and Counting Intrinsics

These intrinsics allow you to find and count objects, whether they are in a container or in the game world.

UI_find_nearest

object UI_find_nearest(object obj, int shape, int dist)
object obj->find_nearest(int shape, int dist)

Searches the area around a given object looking for other objects of a specified type.

Parameters

Return

An object reference to the nearest object found given the search criteria. You cannot find eggs, barges, invisible or transparent objects with this intrinsic.

UI_find_object

object UI_find_object(object cont, int shape, int qual, int frame)
object cont->find_object(int shape, int qual, int frame)
object UI_find_object(int cont, int shape, int qual, int frame)
object UI_find_object(int cont[3], int shape, int qual, int frame)

Finds the first object matching the search criteria.

Parameters

IMPORTANT NOTES

When 'cont' is a position, the search is made in a 1-tile-wide region centered on the given position.

Also, if the search is not being done in a container or NPC, 'shape' can be SHAPE_ANY = -359 to match any shape.

Return

An object reference to the first found object, or zero if no objects match the given criteria.

UI_find_nearby

object[] UI_find_nearby(object loc, int shape, int dist, int mask)
object[] loc->find_nearby(int shape, int dist, int mask)
object[] UI_find_nearby(int loc[3], int shape, int dist, int mask)
object[] UI_find_nearby(int loc[5], int shape, int dist, int mask)
object[] UI_find_nearby(mixed loc[4], int shape, int dist, int mask)

Searches a specified area looking for objects matching a given criteria.

Parameters

The mask value controls what can be found; using the proper mask, you can find eggs, barges, invisible or transparent objects with this intrinsic. The mask can be the combination (sum) of one or more of the following values:

Return

Array containing all objects of matching the given criteria that are located in the specified area. This array is sorted from right to left, closest first.

UI_find_nearby_avatar

object[] UI_find_nearby_avatar(int shape)

Searches the area around the avatar looking for other objects of the specified shape.

Parameters

Return

Array containing all objects of the given shape that are located within 192 tiles of the avatar. This array is sorted from right to left, closest first. You cannot find eggs, barges, invisible or transparent objects with this intrinsic.

UI_npc_nearby

bool UI_npc_nearby(object obj)
bool obj->npc_nearby()

Finds out if the desired object is on screen and can act. An NPC is considered able to act if it is not asleep, paralyzed or dead; other objects are always considered able to act. Note that, despite the name, this intrinsic can also be used for objects.

Parameters

Return

true if the object is in the screen and can act, false otherwise or if the supplied parameter is not an object or NPC.

UI_npc_nearby2

bool UI_npc_nearby2(object obj)
bool obj->npc_nearby2()

Finds out if the desired object is nearby. In this context, 'nearby' means within 40 tiles of the avatar. Note that, despite the name, this intrinsic is valid for all objects, not just NPCs.

Parameters

Return

true if the object is within 40 tiles of the avatar, false otherwise.

UI_count_objects

int UI_count_objects(object obj, int shape, int qual, int frame)
int obj->count_objects(int shape, int qual, int frame)

Counts all objects matching a given search criteria that are contained in the supplied object.

Parameters

Return

The number of objects that match the given criteria.

UI_get_cont_items

object[] UI_get_cont_items(object obj, int shape, int qual, int frame)
object[] obj->get_cont_items(int shape, int qual, int frame)

Looks for all objects matching a given search criteria that are contained in the supplied object.

Parameters

Return

Array containing object references to all objects that match the given criteria.

Placement Intrinsics

With these intrinsics, you can create, move or delete objects or NPCs, whether they are in the game world or in a container.

UI_is_not_blocked

bool UI_is_not_blocked(int pos[3], int shape, int frame)

Checks if there is enough room for a given shape in the specified location.

Parameters

Return

If there is enough room in the given location for an object of the given shape and frame, returns true; otherwise, returns false.

UI_add_party_items

actor[] UI_add_party_items(int count, int shape, int qual, int frame, bool temp)

Creates a specified amount of objects matching the given parameters and gives them all to the party. Not all objects requested may be created; in particular, this intrinsic is guaranteed to create only as many of the requested objects as the party can hold.

SI SPECIFIC

If the party cannot hold all requested objects, the remaining objects are created and then placed in the ground nearby.

Parameters

Return

Returns an array of object references for all party members that received any of the created objects.

BG SPECIFIC

The 'temp' flag applies to all objects created by this function.

SI SPECIFIC

If any objects were added to the ground, the number of objects on the ground is appended to the end of the return array. The 'temp' flag applies only to those objects that were added to the floor.

UI_remove_party_items

bool UI_remove_party_items(int count, int shape, int qual, int frame)
bool UI_remove_party_items(int count, int shape, int qual, int frame, bool unk)

Looks through the party's possessions and deletes a specified amount of objects matching a given search criteria. This function is an all-or-nothing function: it will delete all requested objects or none at all if it found less objects than the amount that was requested for deletion.

Parameters

Return

true if 'count' objects were found and deleted, false if no objects were deleted.

UI_summon

object UI_summon(int shape)
object UI_summon(int shape, bool unk)

Creates a monster with shape 'shape'. The created monster has equipment as defined in its equipment record, and has a 'GOOD' alignment. If the creation is successful, the return value is a reference to the monster; otherwise, the return is '0'. In the originals, there was an additional 'bool' parameter, but it is unimplemented in Exult.

Creates a monster of the supplied shape. This monster has equipment as defined in its equipment record, starts with an IN_COMBAT schedule, and will have the same alignment as item; for the cases in which item is not an NPC, the summoned monster's alignment will be GOOD instead. The monster will be placed within five tiles of the avatar.

Parameters

Return

Zero if there is no free tile near the avatar or the specified shape is not a valid monster shape; an object reference to the summoned monster otherwise.

UI_clone

actor UI_clone(actor npc)
actor npc->clone()

Creates a duplicate of the supplied NPC. This duplicate is always of GOOD alignment and starts with an IN_COMBAT schedule. The clone is placed in a spot near to the original NPC.

Parameters

Return

An object reference to the clone, or zero if the intrinsic did not receive a valid NPC to clone or if a suitable spot for the clone could not be found.

UI_create_new_object

object UI_create_new_object(int shape)

Creates a new object with the specified shape.

Parameters

Return

An object reference to the newly created object. This object is pushed into the 'last created' LIFO stack, and starts out in 'limbo'; it will remain there until placed either, in the game world through the 'UI_update_last_created' intrinsic or inside a container through the 'UI_give_last_created' intrinsic.

UI_create_new_object2

object UI_create_new_object2(int shape, int pos[], [int frame])

Creates a new object with the specified shape and places it in the game world at the supplied location.

Parameters

The location can be specified by arrays ranging from 1 to 4 components. The meaning of these components is as follows:

• 1 element: the object will be deleted (equivalent to 'remove_item' intrinsic);
• 2 elements: mean a (x, y) location. The object is placed at z = 0 in the current game map;
• 3 elements: mean a (x, y, z) location. The object is placed in the current game map;
• 4 elements: mean a (x, y, z, map) location. The object is placed in the specified map unless it is -1, in which case it will be placed in the current game map.

Return

An object reference to the newly created object. This object is placed in the game world exactly as if UI_update_last_created(pos) had been called, and hence will not be in the 'last created' stack.

UI_create_barge_object

UI_create_barge_object(int width, int height, int dir)

Creates a barge object with the specified width, height and direction.

Parameters

Return

An object reference to the newly created barge object. This object is pushed into the 'last created' LIFO stack, and starts out in 'limbo'; it will remain there until placed either, in the game world through the 'UI_update_last_created' intrinsic or inside a container through the 'UI_give_last_created' intrinsic.

UI_set_last_created

object UI_set_last_created(object obj)
object obj->set_last_created()

Moves the object from the game map or container where it was and places it in the 'last created' stack. This intrinsic does nothing if the specified object is already in the aforementioned stack.

Parameters

Return

Returns zero if the object was already in the 'last created' stack, an object reference to the object otherwise.

UI_update_last_created

bool UI_update_last_created(int pos[])

Pops the last object pushed in the 'last created' stack and places it in the game map at the supplied position.

Parameters

The location can be specified by arrays ranging from 1 to 4 components. The meaning of these components is as follows:

• 1 element: the object will be deleted (equivalent to 'remove_item' intrinsic). The original usecode generally passed '-358' for this parameter, but this is likely just by convention as any value works.
• 2 elements: mean a (x, y) location. In Exult, the object is placed at z = 0 in the current game map; in the original games, nothing is done and the update fails.
• 3 elements: mean a (x, y, z) location. The object is placed in the current game map. In Exult, this always succeeds; it could fail in the original games.
• 4 elements: mean a (x, y, z, map) location. Exult-only. The object is placed in the specified map unless it is -1, in which case it will be placed in the current game map.

Return

For the 1-element version, false if the 'last created' stack is empty or true if the object was deleted. Otherwise, returns true if object was successfully placed on the map, false otherwise.

NOTES ABOUT ORIGINAL GAMES

In the original games, the function could fail to place the item in the map. In this case, it would try to delete an unrelated on-screen object flagged with the TEMPORARY flag to make room for the updated object and retry. The retry could fail again, in which case the update fails; otherwise, it would succeed. This means that, on occasion, using this function could cause objects to be deleted in the original.

UI_give_last_created

bool UI_give_last_created(object obj)
bool obj->give_last_created()

Gives the last item in the 'last created' stack to the specified container or NPC. This intrinsic ignores volume, and is quite likely to succeed; the given object is popped from the 'last created' stack only if the intrinsic succeeds.

Parameters

Return

true if successful, false otherwise.

UI_get_object_position

int[3] UI_get_object_position(object obj)
int[3] obj->get_object_position()

Gets the current location the desired object.

Parameters

Return

An array containing the (x, y, z) position of the object.

UI_move_object

UI_move_object(object obj, int pos[], bool flag)
obj->move_object(int pos[], bool flag)

Moves the specified object to a new location in the game world. This move is instantaneous, and is often used for teleportation in the original usecode.

Parameters

If the avatar (or the party) is being teleported, the view will center in the new location and nearby eggs will be activated normally.

UI_get_distance

int UI_get_distance(object obj1, object obj2)
int obj1->get_distance(obj2)

Gets the distance between two objects.

Parameters

Return

The distance between the two objects, or zero if one or both of the parameters is not a valid object.

UI_find_direction

int UI_find_direction(object param1, object param2)
int param1->find_direction(object param2)
int UI_find_direction(object param1, int param2[3])
int param1->find_direction(int param2[3])
int UI_find_direction(object param1, mixed param2[4])
int param1->find_direction(mixed param2[4])
int UI_find_direction(int param1[3], object param2)
int UI_find_direction(int param1[3], int param2[3])
int UI_find_direction(int param1[3], mixed param2[4])
int UI_find_direction(mixed param1[4], object param2)
int UI_find_direction(mixed param1[4], int param2[3])
int UI_find_direction(mixed param1[4], mixed param2[4])

Get the direction from one location or object to another.

This intrinsic is aliased under the name 'direction_from'; they are both equivalent in Exult.

Parameters

Both parameters can be objects, arrays with 3 components or arrays with 4 components. Depending on what they are, Exult will treat them differently and expect them to conform to a certain format; specifically:

Return

The 8-cardinal-point direction of an arrow starting in the first parameter and pointing to the second parameter. It can be one of the following values:

UI_add_cont_items

int UI_add_cont_items(object obj, int count, int shape, int qual, int frame, bool temp)
int obj->add_cont_items(int count, int shape, int qual, int frame, bool temp)

Create a number of objects inside a container.

Parameters

Return

How many objects were actually added to the container.

UI_remove_cont_items

int UI_remove_cont_items(object obj, int count, int shape, int qual, int frame, bool unk)
int obj->remove_cont_items(int count, int shape, int qual, int frame, bool unk)

Removes 'count' objects with shape 'shape', quality 'qual' and frame 'frame' that are contained by 'obj'. 'unk' is an unknown flag which is ignored by Exult; I think it is safe to omit it from the parameter list, but I am not sure. 'qual' and 'frame' can be wildcards:

Return value is the number of objects actually removed.

Looks through the contents of a container and deletes a specified amount of objects matching a given search criteria.

Parameters

Return

The number of objects actually removed.

UI_remove_from_area

UI_remove_from_area(int shape, int frame, int ul[2], int lr[2])

Scans a rectangular area for objects matching the given criteria and deletes all found objects.

Parameters

UI_create_new_egg

object UI_create_new_egg(int type, int pos[], int criteria, int probability, int distance, int flags, int data[])

Creates an egg object at the specified location. Eggs are invisible trigger objects that activate under certain conditions.

Parameters

Return

An object reference to the newly created egg. The egg is placed in the game world at the specified location.

Notes

The data array elements are user-friendly and encoded internally. Their meaning depends on the egg type:

Object Intrinsics

These intrinsics are used to get or set properties of an object, such as quantity, quality or current frame.

UI_get_item_shape

int UI_get_item_shape(object obj)
int obj->get_item_shape()

Gets the current shape of the desired object.

Parameters

Return

The shape in 'SHAPES.VGA' of the object in question.

UI_get_shape_flag

int UI_get_shape_flag(object target, int flag)
int target->get_shape_flag(int flag)
int UI_get_shape_flag(int shape, int flag)
int UI_get_shape_flag(int target[2], int flag)
int UI_get_shape_flag(int target[3], int flag)
int UI_get_shape_flag(mixed target[4], int flag)

Tests one of Exult's shape information flags for an object, shape number, or map tile.

Parameters

Return

true if the target's shape has the requested flag, or false if it does not, the target is invalid, or the flag ID is out of range.

Flag IDs

Notes

When target is a tile position, Exult checks the flat at that tile and also checks object shapes occupying the tile. For [x, y, z] targets, the z value is used when matching object footprints; flat tile checks use the x and y coordinates.

A four-element array first tries the object in element 0. If that is not a valid item, Exult falls back to elements 1, 2, and 3 as x, y, and z and performs the same flat-tile and object-footprint checks.

This lets scripts test semantic shape flags such as on fire, water, solid, or contact effect at a map coordinate without maintaining hard-coded shape number lists.

UI_set_item_shape

UI_set_item_shape(object obj, int shape)
obj->set_item_shape(int shape)

Changes the shape of an object.

Parameters

UI_get_item_frame

int UI_get_item_frame(object obj)
int obj->get_item_frame()

Gets the current frame of the desired object, without the rotation bit.

Parameters

Return

The frame from 'SHAPES.VGA' of the object in question. Only the base frame is returned, without any rotation information.

UI_set_item_frame

UI_set_item_frame(object obj, int frame)
obj->set_item_frame(int frame)

Sets the current frame of the desired object, preserving the rotation bit.

Parameters

UI_get_item_frame_rot

int UI_get_item_frame_rot(object obj)
int obj->get_item_frame_rot()

Gets the current frame of the desired object, with the rotation bit.

Parameters

Return

The frame from 'SHAPES.VGA' of the object in question; including the rotation bit.

UI_set_item_frame_rot

UI_set_item_frame_rot(object obj, int frame)
obj->set_item_frame_rot(int frame)

Sets the current frame of the desired object; does not preserve the rotation bit.

Parameters

UI_get_item_gump_position

int UI_get_item_gump_position(object item)

Returns the coordinates of an item within its currently open container gump. This allows usecode to inspect where items are positioned in the container's display area.

Parameters

Return

An array [x, y] containing the item's coordinates within the container gump if the item is valid, currently in a container, and the container gump is open. Returns an empty array otherwise.

Notes

The returned coordinates are relative to the container's display area, not the screen. This intrinsic is useful for checking item placement in custom container systems or ritual-based gameplay mechanics.

UI_set_item_gump_position

int UI_set_item_gump_position(object item, int x, int y)

Programmatically repositions an item within its container gump to specific coordinates. This allows usecode to arrange items in precise positions for rituals, puzzles, or custom container layouts.

Parameters

Return

Returns 1 on success, 0 on failure. Failure occurs if the item is invalid, not in a container, the container gump is not open, or if negative coordinates are provided.

Notes

Coordinates must be non-negative. The positioning is relative to the container's display area. After setting a position, the display is automatically refreshed to show the new arrangement.

UI_get_item_quality

int UI_get_item_quality(object obj)
int obj->get_item_quality()

Gets the quality of the desired object.

Parameters

Return

The quality of the object if it has it, zero otherwise.

UI_set_item_quality

bool UI_set_item_quality(object obj, int qual)
bool obj->set_item_quality(int qual)

Sets the quality of the desired object.

Parameters

Return

Returns true if the object has a quality or if qual == QUALITY_ANY, false otherwise.

UI_get_item_quantity

int UI_get_item_quantity(object obj)
int obj->get_item_quantity()
int UI_get_item_quantity(object obj, int unk)
int obj->get_item_quantity(int unk)

Gets the quantity of the desired object.

Parameters

Return

The quantity of the object if it has it, '1' otherwise.

UI_set_item_quantity

bool UI_set_item_quantity(object obj, int quant)
bool obj->set_item_quantity(int quant)

Sets the quantity of the desired object. The object's quantity is changed only if the object has it.

Parameters

Return

Returns true if the object has a quantity, false otherwise.

UI_get_lift

int UI_get_lift(object obj)
int obj->get_lift()

Gets how far above the ground the object is.

Parameters

Return

The object's z coordinate.

UI_set_lift

UI_set_lift(object obj, int lift)
obj->set_lift(int lift)

Moves the object on the vertical direction to a desired height off the ground.

Parameters

UI_get_item_flag

int UI_get_item_flag(object obj, int flag)
int obj->get_item_flag(int flag)

Inspects the chosen flag of the given object.

Parameters

The flag parameter is a numeric value describing a (usually boolean) bit of information about the object in question. Valid pre-defined values for the flag are:

Return

For most flags, true if the flag is set (that is, in effect), false otherwise. There is one exception, however: The 'ACTIVE_SAILOR' and 'ACTIVE_BARGE' flags have a peculiar behavior in that they actually returns an object reference to the last object to have that flag set, or zero if no object has been set, or if the flag has been cleared with 'clear_item_flag' intrinsic for the given flag.

With the exception of the OKAY_TO_TAKE, TEMPORARY and INVISIBLE flags, these flags are valid for NPCs only. You can get, set or clear any of those values and Exult will not complain; however, it will also not save the values of the flags except for the three mentioned before. Moreover, the INVISIBLE flag will not be saved for objects unless they are of 'quality flags' class.

UI_set_item_flag

UI_set_item_flag(object obj, int flag)
obj->set_item_flag(int flag)

Sets the desired flag for the given object. Many flags have immediate effects when set; most do not. See the get_item_flag intrinsic for flag values.

Parameters

In the special case of the 'ACTIVE_SAILOR' and 'ACTIVE_BARGE' flags, stores the supplied object, instead of a flag value. This stored object will be returned by future calls of the 'get_item_flag' intrinsic for the given flag.

With the exception of the OKAY_TO_TAKE, TEMPORARY and INVISIBLE flags, these flags are valid for NPCs only. You can get, set or clear any of those values and Exult will not complain; however, it will also not save the values of the flags except for the three mentioned before. Moreover, the INVISIBLE flag will not be saved for objects unless they are of 'quality flags' class.

UI_clear_item_flag

UI_clear_item_flag(object obj, int flag)
obj->clear_item_flag(int flag)

Clears the desired flag for the given object. Many flags have immediate effects when cleared; most do not. See the get_item_flag intrinsic for flag values.

Parameters

In the special case of the 'ACTIVE_SAILOR' and 'ACTIVE_BARGE' flags, the object that they stores is set to zero. This will be the return of any future calls to the 'get_item_flag' intrinsic for the given flag.

With the exception of the OKAY_TO_TAKE, TEMPORARY and INVISIBLE flags, these flags are valid for NPCs only. You can get, set or clear any of those values and Exult will not complain; however, it will also not save the values of the flags except for the three mentioned before. Moreover, the INVISIBLE flag will not be saved for objects unless they are of 'quality flags' class.

UI_get_barge

object UI_get_barge(object obj)
object obj->get_barge()

Checks the barge upon which the supplied object is on.

Parameters

Return

Returns zero if no valid object is passed, or if the object is not lying on a barge. Otherwise, returns the object reference of the barge (shape 961) object upon which the supplied object lies.

UI_set_barge_dir

UI_set_barge_dir(object obj, int dir)
obj->set_barge_dir(int dir)

If 'obj' is a barge object, sets its direction (along with all objects laying on 'obj') to 'dir'. 'dir' can be one of the constants defined for 'find_direction' intrinsic.

Parameters

UI_on_barge

bool UI_on_barge()

Determines if the entire party is inside the same barge as the avatar.

SI SPECIFIC

In SI, this intrinsic also forces the barge to refresh the list of all objects lying on it.

Return

If the avatar is on a barge and all party members are on that same barge, returns true; in all other cases, returns false.

UI_get_container

object UI_get_container(object obj)
object obj->get_container()

Gets the container of the supplied object.

Parameters

Return

Return is zero if the object is directly in the game world, or an object reference to its immediate container otherwise.

UI_remove_item

UI_remove_item(object obj)
obj->remove_item()

Removes the object from the game world and from the 'last created' stack. If the object is not an NPC, it will de deleted; NPCs will still exist.

Parameters

UI_get_usecode_fun

int UI_get_usecode_fun(object obj)
int obj->get_usecode_fun()

Gets the usecode function number of an object. This takes into consideration a NPC's assigned function (if any) and the correct shape <> function mapping for shapes > 1024.

Parameters

Return

The usecode function number that is assigned to the object.

UI_set_usecode_fun

UI_set_usecode_fun(actor npc, function fun)
npc->set_usecode_fun(function fun)

Assigns a new usecode function to an NPC.

Parameters

UI_get_map_num

int UI_get_map_num(object obj)
int obj->get_map_num()

Checks which map an object is in.

Parameters

Return

The map in which the object is located, or -1 if the object is nowhere.

UI_get_item_weight

int UI_get_item_weight(object obj)
int obj->get_item_weight()

Checks an object's weight.

Parameters

Return

The object's weight.

UI_is_on_keyring

bool UI_is_on_keyring(int qual)

Checks if a key is in the keyring. Note that the keyring is a global object; multiple keyrings will share the same list of keys.

Parameters

Return

true if the key is on the keyring, false otherwise.

UI_add_to_keyring

UI_add_to_keyring(int qual)

Adds a key to the keyring. Note that the keyring is a global object; multiple keyrings will share the same list of keys.

Parameters

UI_remove_from_keyring

bool UI_remove_from_keyring(int qual)

Removes a key from the keyring. Note that the keyring is a global object; multiple keyrings will share the same list of keys.

Parameters

Return

If the key was on the keyring, returns true; otherwise, returns false.

UI_apply_damage

int UI_apply_damage(int base, int hits, int type, object obj)

Causes random damage of a given type to the desired object, subject to armor.

Parameters

The type of the damage is a numerical value that describes what kind of damage should be caused. It can be one of the following values:

The damage is calculated from a series of generated random numbers. It proceeds along the following steps:

• If the target is wearing any armor that makes him/her immune to the specified damage type, he takes no damage from this intrinsic.
• If hits is 127 or more, 127 points of damage are caused to the target. This case ignores all armor.
• If base/3 (rounded down) is zero, it does not affect damage; likewise, if hits is zero, it does not affect damage. A random number will be generated for each of them that are nonzero, ranging from 1 to base/3 or from 1 to hits, as appropriate. These two random numbers are added together.
• If the damage type does not ignore armor, the armor value of everything worn by the target is computed. Monster-specified armor values are also added to this value. If the total armor is at least zero, a random number in the range 1 to (total armor) is generated and subtracted from the damage total above.
• If the target has immunities granted by his monster data, he will take no damage; if he has any vulnerabilities, the remaining damage, if positive, will be doubled.

Return

Returns true if any damage is caused on a valid target, false otherwise.

UI_reduce_health

UI_reduce_health(object obj, int hits, int type)
obj->reduce_health(int hits, int type)

Causes a fixed amount of damage of the specified type to a target. This intrinsic ignores armor and armor-granted immunities.

Parameters

The type of the damage is a numerical value that describes what kind of damage should be caused. It can be one of the following values:

UI_attack_object

int UI_attack_object(object attacker, object target, int weapon)
int attacker->attack_object(object target, int weapon)

Causes a NPC to attack the object with a given weapon. This intrinsic does not animate the NPC in any way; it only emulates a hit with the selected weapon.

Parameters

If the NPC is targeting a tile, the attack will only be meaningful if the weapon causes an explosion.

Return

true if a melee attack hits or if a ranged attack fires its projectile; returns false if the melee attack missed or if the attack could not be realized for any reason (including an invalid attacker, an invalid target, being out of range, lack of adequate ammunition for the given weapon) if attacking a valid target with a valid weapon, false otherwise.

UI_fire_projectile

UI_fire_projectile(object obj, int dir, int proj, int attpts, int weapon, int ammo)
obj->fire_projectile(int dir, int proj, int attpts, int weapon, int ammo)

Causes the given object to fire a high-speed missile in the supplied direction.

Parameters

The direction into which the projectile is filed is the 8-cardinal-point direction in which the projectile will travel. It can be one of the following values:

NPC Intrinsics

These intrinsics allow you to get or set NPC-specific properties of a NPC, such as schedules, alignment or stats.

UI_get_npc_object

int UI_get_npc_object(int npc)
int npc->get_npc_object()
int[] UI_get_npc_object(int npc[])

Gets the NPC object references of one or more NPC numbers.

Parameters

Return

If the input is an array of NPC numbers, the return is an array of NPC object references. The output array places the NPC references in the same order they are in the input array.

Otherwise, the return is the object reference of the given NPC number.

UI_get_schedule_type

int UI_get_schedule_type(actor npc)
int npc->get_schedule_type()

Gets the current schedule of an NPC.

Parameters

Return

Zero if 'npc' is not a valid NPC; otherwise, an integer associated to the NPC's current schedule. This is the same value that is reported in the cheat screen, and can be one of the following values:

SI SPECIFIC

If the NPC is traversing a path created by a call to either, UI_path_run_usecode or UI_si_path_run_usecode intrinsics, this intrinsic will return the value WALK_TO_SCHEDULE = 32 instead of the values above.

UI_set_schedule_type

UI_set_schedule_type(actor npc, int sched)
npc->set_schedule_type(int sched)

Gets the current schedule of an NPC.

Parameters

SI SPECIFIC

The SI-specific value WALK_TO_SCHEDULE = 32 cannot be set with this intrinsic; only a call to either, UI_path_run_usecode or UI_si_path_run_usecode intrinsics can do that.

UI_modify_schedule

UI_modify_schedule(actor npc, int time, int sched, int pos[2])
npc->modify_schedule(int time, int sched, int pos[2])

Changes the schedule table of an NPC for the desired time period. This new schedule is persistent across save games. The NPC will execute his/her new schedule in the map he/she currently resides when the time comes.

Parameters

UI_set_new_schedules

UI_set_new_schedules(actor npc, int time, int sched, int loc[2])
UI_set_new_schedules(actor npc, int time[n], int sched[n], int loc[2n])
npc->set_new_schedules(int time, int sched, int loc[2])
npc->set_new_schedules(int time[n], int sched[n], int loc[2n])

Changes the schedule table of an NPC. This new schedule table is persistent across save games. The NPC will execute his/her new schedules in the map he/she currently resides.

Parameters

UI_run_schedule

UI_run_schedule(actor npc)
npc->run_schedule()

Forces an NPC to return to his/her regularly scheduled activities.

Parameters

UI_revert_schedule

UI_revert_schedule(actor npc)
npc->revert_schedule()

Reverts the schedules of a NPC to those stored in 'STATIC/schedule.dat'. Can be risky for NPCs not in the original games.

Parameters

UI_get_npc_prop

int UI_get_npc_prop(object obj, int prop)
int UI_get_npc_prop(object obj, string prop)
int obj->get_npc_prop(int prop)
int obj->get_npc_prop(string prop)

Gets the current value of an object's or NPC's property. Despite the name, this intrinsic can also be called for any object, although most properties will be unavailable for anything but NPCs.

Parameters

If the desired property has been specified as an integer, it must be in the range from 0 to 11. It can be one of the following values:

Return

Returns the current value of the specified property. The following properties are special cases:

This intrinsic returns zero for any property which is not meaningful for the supplied object; this includes string properties that have not been previously set with a UI_set_npc_prop intrinsic call.

BG SPECIFIC

Standard BG does not have sex data for anyone but the avatar, so the return is almost always 'false'. This is not a limitation of the engine or of Exult, just a statement about the game data.

UI_set_npc_prop

UI_set_npc_prop(object obj, int prop, int delta)
UI_set_npc_prop(object obj, string prop, int delta)
obj->set_npc_prop(int prop, int delta)
obj->set_npc_prop(string prop, int delta)

Changes an object's or NPC's property by the specified value. Despite the name, this intrinsic can also be called for any object, although most properties will be unavailable for anything but NPCs.

Parameters

If the desired property has been specified as an integer, it must be one of the values listed in the UI_get_npc_prop intrinsic description. The following values are special cases:

BG SPECIFIC

In the original BG, you could not set the sex flag except by hex-editing the game data. Exult does not suffer from this limitation.

If the desired property has been specified as a string, it will be created if it does not exist; its initial value is assumed to be zero in this case. Only NPCs can have such properties, and they will be displayed in the NPC's stats window.

Return

Always returns '0'.

UI_get_npc_name

string UI_get_npc_name(object obj)
string obj->get_npc_name()
string[] UI_get_npc_name(object obj[])

Gets the name of one or more objects. Despite the name, this intrinsic can be called for any object, not just NPCs; for non-NPCs, the return is the text displayed when you click the object.

Parameters

Return

If the input is an array of objects, the return is an array with the names of these objects. The output array places the object names in the same order as the objects are in the input array.

Otherwise, the return is the name of the given object.

UI_set_npc_name

UI_set_npc_name(actor npc, string name)
npc->set_npc_name(string name)

Changes the name of an NPC.

Parameters

UI_is_npc

UI_is_npc(mixed obj)
obj->is_npc()

Determines if a given object is an NPC.

Parameters

Return

true if the object is an NPC, false otherwise.

UI_is_dead

bool UI_is_dead(actor npc)
bool npc->is_dead()

Checks if the NPC is dead or alive. This is equivalent to checking if the 'DEAD' flag is set.

Parameters

Return

Returns true if the NPC is dead, false otherwise.

UI_get_npc_number

int UI_get_npc_number(actor npc)
int npc->get_npc_number()

Parameters

Return

The NPC's number. This is a negative number for all 'true' NPCs, -356 for the avatar, 1 for monsters or zero for anything that is not a valid NPC.

UI_get_alignment

int UI_get_alignment(actor npc)
int npc->get_alignment()

Gets the NPC's attitude towards the avatar.

Parameters

Return

Returns a number describing the NPC's attitude towards the avatar. Can be one of the following values:

UI_set_alignment

UI_set_alignment(actor npc, int align)
npc->set_alignment(int align)

Sets an NPC's attitude towards the avatar. This change forces the NPC to reevaluate his targets, and may stop the NPC from fleeing.

Parameters

UI_remove_npc

UI_remove_npc(actor npc)
npc->remove_npc()

Removes the NPC from the game world. The NPC is effectively placed in 'limbo', and has its schedule set to 'WAIT'.

Parameters

UI_kill_npc

UI_kill_npc(actor npc)
npc->kill_npc()

Kills the specified victim.

Parameters

UI_get_attack_mode

int UI_get_attack_mode(actor npc)
int npc->get_attack_mode()

Gets the NPC's attack mode.

Parameters

Return

A numeric value specifying how the NPC behaves in combat. Possible values are:

UI_set_attack_mode

UI_set_attack_mode(actor npc, int mode)
npc->set_attack_mode(int mode)

Changes the NPC's attack mode to the desired value.

Parameters

UI_get_npc_id

int UI_get_npc_id(actor npc)
int npc->get_npc_id()

Retrieves a NPC's identity. This identity has no real effect other than that given to it by usecode.

Parameters

Return

If given a valid NPC, this intrinsic returns that NPC's identity; otherwise it returns zero.

UI_set_npc_id

UI_set_npc_id(actor npc, int id)
npc->set_npc_id(int id)

Changes an NPC's identity. This identity has no real effect other than that given to it by usecode.

Parameters

UI_get_oppressor

actor UI_get_oppressor(actor npc)
actor npc->get_oppressor()

Gets whoever is attacking the supplied NPC. This oppressor can be set through usecode, but it is also automatically set to whomever has last attacked (caused damage to) the supplied NPC. It is also set whenever an NPC acquires a new target -- this NPC will be set as its target's oppressor.

Parameters

Return

Returns the NPC number of the supplied NPC's oppressor, or zero if no valid NPC was supplied. The return value has the opposite sign from what you get from a get_npc_number intrinsic call.

UI_set_oppressor

UI_set_oppressor(actor npc, actor opp)
npc->set_oppressor(opp)

Sets the supplied NPCs oppressor to another NPC.

Parameters

UI_get_readied

object UI_get_readied(actor npc, int spot)
object npc->get_readied(int spot)

Inspects the given equipment slot in an NPC.

Parameters

Return

Returns zero for an invalid spot or if the spot is empty, otherwise returns an object reference to the object that resides in the desired spot.

UI_is_readied

bool UI_is_readied(actor npc, int spot, int shape, int frame)
npc->is_readied(int spot, int shape, int frame)

Returns 'true' if an object with shape 'shape' and frame 'frame' is readied in ready spot 'spot' of 'npc', 'false' otherwise. 'frame' can be the wildcard 'FRAME_ANY'. Valid values for 'spot' are:

For SI, it is better to use 'get_readied' intrinsic instead.

Checks to see if the given NPC is wearing a piece of equipment on a specified location.

Parameters

BG SPECIFIC

In BG, the 'spot' parameter is limited to the 0-12 range. It can take any of the following values:

Parameter / value	Description
BG_BACKPACK = 0	Containers worn on the back, such as backpacks
BG_WEAPON_HAND = 1	Item wielded in weapon hand
BG_SHIELD_HAND = 2	Off-hand is also called the shield hand
BG_OFF_HAND = 2	Item wielded in off-hand
BG_BELT = 3	Items worn around the waist such as belts, and girdles
BG_NECK = 4	Items worn around the neck such as amulets, and necklaces
BG_TORSO = 5	Worn on the torso, such as armor
BG_LEFT_RING = 6	Item worn on left finger (ring)
BG_RIGHT_RING = 7	Item worn on right finger (ring)
BG_QUIVER = 8	Arrows held in quiver
BG_HEAD = 9	Items worn on the head such as headbands, helms, etc
BG_LEGS = 10	Worn on legs, such as greaves
BG_FEET = 11	Worn on feet, such as boots
BG_USECODE = 12	Exult-only. Usecode container, used for containing eggs 'carried' by player
BG_CLOAK = 13	Exult-only. Items worn around the neck and back such as cloaks and capes
BG_GLOVES = 14	Exult-only. Items worn on both hands, such as gloves
BG_TRIPLE_BOLTS = 15	Special slot used by triple crossbow bolts
BG_EARS = 16	Exult-only. Earrings, such as the serpent earrings
BG_BACK_SHIELD = 17	Exult-only. Shield slung across the back
BG_BACK_2H = 19	Exult-only. Weapon slung across the back
BG_BOTH_HANDS = 20	Special slot for item wielded with both hands
BG_LRGLOVES = 21	Special slot for item wielded with both ring slots
BG_AMULET = 22	Exult-only. Items worn on the neck such as a collar