Seven Towers: UCC Reference

USECODE INTRINSICS

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

npcThe NPC whose equipment is to be inspected.
spotThe spot we are checking.
shapeThe shape we are looking for.
frameThe frame we are looking for. Can be FRAME_ANY = -359 to match any frame.
BG SPECIFIC
In BG, the 'spot' parameter is limited to the 0-12 range. It can take any of the following values:
BG_BACKPACK = 0Containers worn on the back, such as backpacks
BG_WEAPON_HAND = 1Item wielded in weapon hand
BG_SHIELD_HAND = 2Off-hand is also called the shield hand
BG_OFF_HAND = 2Item wielded in off-hand
BG_BELT = 3Items worn around the waist such as belts, and girdles
BG_NECK = 4Items worn around the neck such as amulets, and necklaces
BG_TORSO = 5Worn on the torso, such as armor
BG_LEFT_RING = 6Item worn on left finger (ring)
BG_RIGHT_RING = 7Item worn on right finger (ring)
BG_QUIVER = 8Arrows held in quiver
BG_HEAD = 9Items worn on the head such as headbands, helms, etc
BG_LEGS = 10Worn on legs, such as greaves
BG_FEET = 11Worn on feet, such as boots
BG_USECODE = 12Exult-only. Usecode container, used for containing eggs 'carried' by player
BG_CLOAK = 13Exult-only. Items worn around the neck and back such as cloaks and capes
BG_GLOVES = 14Exult-only. Items worn on both hands, such as gloves
BG_TRIPLE_BOLTS = 15Special slot used by triple crossbow bolts
BG_EARS = 16Exult-only. Earrings, such as the serpent earrings
BG_BACK_SHIELD = 17Exult-only. Shield slung across the back
BG_BACK_2H = 19Exult-only. Weapon slung across the back
BG_BOTH_HANDS = 20Special slot for item wielded with both hands
BG_LRGLOVES = 21Special slot for item wielded with both ring slots
BG_AMULET = 22Exult-only. Items worn on the neck such as a collar
SI SPECIFIC
In SI, the 'spot' parameter is limited to the 0-17 range. It can take any of the following values:
SI_OFF_HAND = 0Items wielded in the off-hand
SI_SHIELD_HAND = 0Off-hand is also called shield hand
SI_WEAPON_HAND = 1Items wielded in the weapon hand
SI_CLOAK = 2Items worn around the neck and back such as cloaks and capes
SI_AMULET = 3Items worn on the neck such as a collar
SI_HEAD = 4Items worn on the head such as a helm
SI_GLOVES = 5Items worn on both hands, such as gloves
SI_USECODE = 6Usecode container, used for containing eggs 'carried' by player
SI_RIGHT_RING = 7Ring or item worn on right hand
SI_LEFT_RING = 8Ring or item worn on left hand
SI_EARS = 9Earrings, such as the serpent earrings
SI_QUIVER = 10Arrows held in quiver
SI_BELT = 11Worn across the waist, such as belts and girdles
SI_TORSO = 12Worn on the torso, such as armor
SI_FEET = 13Worn on feet, such as boots
SI_LEGS = 14Worn on legs, such as greaves
SI_BACKPACK = 15Containers worn on the back, such as backpacks
SI_BACK_SHIELD = 16Shield slung across the back
SI_BACK_2H = 17Weapon slung across the back
SI_TRIPLE_BOLTS = 18Exult-only. Special slot used by triple crossbow bolts
SI_BOTH_HANDS = 20Special slot for item wielded with both hands
SI_LRGLOVES = 21Exult-only. Special slot for item wielded with both ring slots

Return

Returns true if the NPC is wearing an object of the specified shape and frame on the inspected slot, false if not.

Related intrinsics

See also