Handles objects being applied, and their effect. More...

#include <global.h>
#include <living.h>
#include <spells.h>
#include <skills.h>
#include <tod.h>
#include <sproto.h>
#include <sounds.h>
#include <math.h>

Include dependency graph for apply.c:

Go to the source code of this file.

Functions
void	apply_changes_to_player (object pl, object change)
	Applies (race) changes to a player.
int	apply_container (object op, object sack)
	Handle apply on containers.
int	apply_special (object who, object op, int aflags)
	Apply an object.
int	auto_apply (object *op)
	Map was just loaded, handle op's initialisation.
int	can_apply_object (object who, object op)
	Checks to see if 'who' can apply object 'op'.
static int	check_race_restrictions (object who, object item)
	Checks if an item is restricted to a race.
int	check_weapon_power (const object *who, int improvs)
	This checks to see of the player (who) is sufficient level to use a weapon with improvs improvements (typically last_eat).
void	do_forget_spell (object op, const char spell)
	Erases spell from player's inventory.
void	do_learn_spell (object op, object spell, int special_prayer)
	Actually makes op learn spell.
void	fix_auto_apply (mapstruct *m)
	Go through the entire map (only the first time when an original map is loaded) and performs special actions for certain objects (most initialization of chests and creation of treasures and stuff).
static object *	get_item_from_body_location (object *start, int loc)
	Returns the object that is using body location 'loc'.
void	handle_apply_yield (object *tmp)
	This checks whether the object has a "on_use_yield" field, and if so generated and drops matching item.
void	legacy_apply_container (object op, object sack)
int	manual_apply (object op, object tmp, int aflag)
	Main apply handler.
int	player_apply (object pl, object op, int aflag, int quiet)
	Living thing is applying an object.
void	player_apply_below (object *pl)
	Attempt to apply the object 'below' the player.
void	scroll_failure (object *op, int failure, int power)
	op made some mistake with a scroll, this takes care of punishment.
int	set_object_face_main (object *op)
	Makes an object's face the main face, which is supposed to be the "closed" one.
static int	set_object_face_other (object *op)
	Makes an object's face the other_arch face, supposed to be the "opened" one.
int	should_director_abort (object op, object victim)
	Check if op should abort moving victim because of it's race or slaying.
int	transport_can_hold (const object transport, const object op, int nrof)
	Can transport hold object op? This is a pretty trivial function, but in the future, possible transport may have more restrictions or weight reduction like containers.
static int	unapply_for_ob (object who, object op, int aflags)
	Remove equipment so an object can be applied.
static int	unapply_special (object who, object op, int aflags)
	Unapplies specified item.

Detailed Description

Handles objects being applied, and their effect.

Definition in file apply.c.

Function Documentation

void apply_changes_to_player	(	object *	pl,
		object *	change
	)

Applies (race) changes to a player.

Parameters:

pl	object to change.
change	what kind of changes to apply. Should be of type CLASS.

Definition at line 1776 of file apply.c.

References animate_object(), animations, CHA, change_attr_value(), CLASS, CLEAR_FLAG, FLAG_ANIMATE, FLAG_USE_WEAPON, GET_ANIM_ID, get_attr_value(), give_initial_items(), MAX_BUF, animations_struct::name, NUM_STATS, QUERY_FLAG, rndm(), set_attr_value(), SET_FLAG, snprintf(), and try_find_animation().

Referenced by player_changer_type_process().

Here is the call graph for this function:

Here is the caller graph for this function:

int apply_container	(	object *	op,
		object *	sack
	)

Handle apply on containers.

This is for containers that are applied by a player, whether in inventory or on the ground: eg, sacks, luggages, etc.

Moved to own function and added many features [Tero.Haatanen(at)lut.fi] This version is for client/server mode.

Reminder - there are three states for any container - closed (non applied), applied (not open, but objects that match get tossed into it), and open (applied flag set, and op->container points to the open container)

Parameters:

op	player.
sack	container the player is opening or closing.

Returns:: 1 if an object is apllied somehow or another, 0 if error/no apply

Author:: Eneq(at)(csd.uu.se)

Definition at line 230 of file apply.c.

References CLEAR_FLAG, CONTAINER, draw_ext_info_format(), esrv_send_inventory(), esrv_send_item(), esrv_update_item(), EVENT_CLOSE, execute_event(), find_key(), FLAG_APPLIED, get_split_ob(), insert_ob_in_map_at(), insert_ob_in_ob(), llevError, LOG(), MAX_BUF, MOVE_ALL, MSG_TYPE_APPLY, MSG_TYPE_APPLY_ERROR, MSG_TYPE_APPLY_SUCCESS, MSG_TYPE_APPLY_UNAPPLY, NDI_UNIQUE, PLAYER, QUERY_FLAG, query_name(), SCRIPT_FIX_ALL, SET_FLAG, set_object_face_main(), set_object_face_other(), UPD_FACE, and UPD_FLAGS.

Referenced by legacy_apply_container(), and loot_object().

Here is the call graph for this function:

Here is the caller graph for this function:

int apply_special	(	object *	who,
		object *	op,
		int	aflags
	)

Apply an object.

This function doesn't check for unpaid items, but check other restrictions.

Usage example: apply_special (who, op, AP_UNAPPLY | AP_IGNORE_CURSE)

Parameters:

who	object using op. It can be a monster.
op	object being used. Should be an equipment type item, eg, one which you put on and keep on for a while, and not something like a potion or scroll.
aflags	combination of AP_xxx flags.

Returns:: 1 if the action could not be completed, 0 on success. However, success is a matter of meaning - if the user passes the 'apply' flag to an object already applied, nothing is done, and 0 is returned.

Definition at line 1139 of file apply.c.

References AMULET, AP_APPLY, AP_BASIC_FLAGS, AP_IGNORE_CURSE, AP_NOPRINT, AP_PRINT, AP_UNAPPLY, ARMOUR, BOOTS, BOW, BRACERS, BUILDER, CAN_APPLY_NEVER, can_apply_object(), CAN_APPLY_RESTRICTION, CAN_APPLY_UNAPPLY_CHOICE, change_abil(), change_skill(), check_weapon_power(), CLOAK, draw_ext_info(), draw_ext_info_format(), esrv_update_item(), find_skill_by_name(), fix_object(), FLAG_APPLIED, FLAG_BEEN_APPLIED, FLAG_CURSED, FLAG_DAMNED, FLAG_KNOWN_CURSED, FLAG_READY_BOW, FLAG_READY_RANGE, FLAG_READY_SKILL, FLAG_READY_WEAPON, get_ob_key_value(), get_split_ob(), GIRDLE, GLOVES, HELMET, HORN, insert_ob_in_ob(), Settings::item_power_factor, llevError, LOG(), MAX_BUF, MSG_TYPE_APPLY, MSG_TYPE_APPLY_BADBODY, MSG_TYPE_APPLY_CURSED, MSG_TYPE_APPLY_ERROR, MSG_TYPE_APPLY_PROHIBITION, MSG_TYPE_APPLY_SUCCESS, MSG_TYPE_APPLY_UNAPPLY, MSG_TYPE_VICTIM, MSG_TYPE_VICTIM_WAS_HIT, NDI_UNIQUE, Settings::personalized_blessings, PLAYER, QUERY_FLAG, query_name(), random_roll(), range_bow, range_builder, range_misc, range_skill, RING, ROD, SET_FLAG, settings, SHIELD, SKILL, SKILL_TOOL, unapply_always, unapply_for_ob(), unapply_never, unapply_nochoice, unapply_special(), UPD_FLAGS, UPD_NROF, UPD_WEIGHT, WAND, and WEAPON.

Referenced by adjust_skill_tool(), attack_hth(), change_skill(), drop_object(), find_throw_ob(), improve_armour(), improve_weapon(), legacy_ob_apply(), put_object_in_sack(), and stop_using_item().

Here is the call graph for this function:

Here is the caller graph for this function:

int auto_apply ( object * op )

Map was just loaded, handle op's initialisation.

Generates shop floor's item, and treasures.

Parameters:

op	object to initialize.

Returns:: 1 if object was initialized, 0 else.

Definition at line 1526 of file apply.c.

References CLEAR_FLAG, create_treasure(), FLAG_AUTO_APPLY, FLAG_CURSED, FLAG_DAMNED, FLAG_IS_A_TEMPLATE, FLAG_UNPAID, free_object(), generate_treasure(), GT_ENVIRONMENT, HAS_RANDOM_ITEMS, identify(), insert_ob_in_map(), insert_ob_in_ob(), MAX, QUERY_FLAG, remove_ob(), SET_FLAG, SHOP_FLOOR, and TREASURE.

Here is the call graph for this function:

int can_apply_object	(	object *	who,
		object *	op
	)

Checks to see if 'who' can apply object 'op'.

Parameters:

who	living thing trying to apply op.
op	object applied.

Returns:: 0 if apply can be done without anything special. Otherwise returns a bitmask of CAN_APPLY_xxx - potentially several of these may be set, but largely depends on circumstance - in the future, processing may be pruned once we know some status (eg, once CAN_APPLY_NEVER is set, do we really are what the other flags may be?) See include/define.h for detailed description of the meaning of these return values.

Definition at line 955 of file apply.c.

References BOW, CAN_APPLY_NEVER, CAN_APPLY_RESTRICTION, CAN_APPLY_UNAPPLY, CAN_APPLY_UNAPPLY_CHOICE, CAN_APPLY_UNAPPLY_MULT, FABS, FLAG_APPLIED, FLAG_USE_ARMOUR, FLAG_USE_BOW, FLAG_USE_RANGE, FLAG_USE_RING, FLAG_USE_SHIELD, FLAG_USE_WEAPON, get_item_from_body_location(), HORN, IS_ARMOR, IS_SHIELD, IS_WEAPON, PLAYER, QUERY_FLAG, RING, ROD, SHIELD, WAND, and WEAPON.

Referenced by apply_special(), and monster_check_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

static int check_race_restrictions	(	object *	who,
		object *	item
	)		`[static]`

Checks if an item is restricted to a race.

Non players and DMs can always apply.

Parameters:

who	living thing trying to apply an item.
item	item being applied.

Returns:: 0 if item can't be applied, 1 else.

Definition at line 472 of file apply.c.

References draw_ext_info_format(), FLAG_WIZ, get_ob_key_value(), MAX_BUF, MSG_TYPE_APPLY, MSG_TYPE_APPLY_PROHIBITION, NDI_UNIQUE, PLAYER, QUERY_FLAG, query_name(), and snprintf().

Referenced by manual_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

int check_weapon_power	(	const object *	who,
		int	improvs
	)

This checks to see of the player (who) is sufficient level to use a weapon with improvs improvements (typically last_eat).

We take an int here instead of the object so that the improvement code can pass along the increased value to see if the object is usuable. we return 1 (true) if the player can use the weapon. See ../types/weapon_improver/weapon_improver.c

Parameters:

who	living to check
improvs	improvement level.

Returns:: 1 if who can use the item, 0 else.

Todo:: remove obsolete code.

Definition at line 1076 of file apply.c.

References IS_COMBAT_SKILL, llevError, LOG(), PLAYER, and SKILL.

Referenced by apply_special(), and improve_weapon().

Here is the call graph for this function:

Here is the caller graph for this function:

void do_forget_spell	(	object *	op,
		const char *	spell
	)

Erases spell from player's inventory.

Will inform player of loss.

Parameters:

op	player.
spell	spell name to forget.

Definition at line 440 of file apply.c.

References check_spell_known(), draw_ext_info_format(), esrv_remove_spell(), free_object(), llevError, LOG(), MSG_TYPE_APPLY, MSG_TYPE_APPLY_CURSED, NDI_NAVY, NDI_UNIQUE, PLAYER, player_unready_range_ob(), and remove_ob().

Referenced by cfapi_object_forget_spell(), check_special_prayers(), command_forget_spell(), and spellbook_type_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

void do_learn_spell	(	object *	op,
		object *	spell,
		int	special_prayer
	)

Actually makes op learn spell.

Informs player of new spell and binding.

Parameters:

op	player who'll learn the spell.
spell	spell to learn.
special_prayer	1 for god-given prayer, 0 else.

Definition at line 398 of file apply.c.

References check_spell_known(), copy_object(), draw_ext_info_format(), esrv_add_spells(), FLAG_STARTEQUIP, get_object(), insert_ob_in_ob(), llevError, LOG(), MSG_TYPE_APPLY, MSG_TYPE_APPLY_SUCCESS, NDI_UNIQUE, play_sound_player_only(), PLAYER, QUERY_FLAG, SET_FLAG, and SOUND_TYPE_SPELL.

Referenced by cfapi_object_learn_spell(), command_learn_spell_or_prayer(), dragon_ability_gain(), god_intervention(), and spellbook_type_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

void fix_auto_apply ( mapstruct * m )

Go through the entire map (only the first time when an original map is loaded) and performs special actions for certain objects (most initialization of chests and creation of treasures and stuff).

Calls auto_apply() if appropriate.

Parameters:

m	map to fix.

Definition at line 1590 of file apply.c.

References ALTAR, auto_apply(), check_trigger(), CLASS, CONTAINER, create_treasure(), mapdef::difficulty, FIREWALL, FLAG_AUTO_APPLY, FLAG_IS_LINKED, GET_MAP_OB, GT_APPLY, HAS_RANDOM_ITEMS, HORN, MAP_HEIGHT, MAP_WIDTH, PLAYER, PLAYER_CHANGER, POTION, QUERY_FLAG, ROD, SCROLL, SPELL, SPELLBOOK, TIMED_GATE, TREASURE, TRIGGER_BUTTON, TRIGGER_PEDESTAL, update_ob_speed(), and WAND.

Here is the call graph for this function:

static object* get_item_from_body_location	(	object *	start,
		int	loc
	)		`[static]`

Returns the object that is using body location 'loc'.

Note that 'start' is the first object to start examing - we then go through the below of this. In this way, you can do something like: tmp = get_item_from_body_location(who->inv, 1); if (tmp) tmp1 = get_item_from_body_location(tmp->below, 1); to find the second object that may use this location, etc.

Don't return invisible objects unless they are skill objects. Invisible other objects that use up body locations can be used as restrictions.

Parameters:

start	object to start from.
loc	body position to search. Must be between 0 and NUM_BODY_LOCATIONS-1.

Returns:: object at position, NULL if none.

Definition at line 814 of file apply.c.

References FLAG_APPLIED, QUERY_FLAG, and SKILL.

Referenced by can_apply_object(), and unapply_for_ob().

Here is the caller graph for this function:

void handle_apply_yield ( object * tmp )

This checks whether the object has a "on_use_yield" field, and if so generated and drops matching item.

Parameters:

tmp	item that was applied.

Definition at line 131 of file apply.c.

References create_archetype(), drop(), get_ob_key_value(), insert_ob_in_map(), and insert_ob_in_ob().

Referenced by food_type_apply(), poison_type_apply(), and potion_type_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

void legacy_apply_container	(	object *	op,
		object *	sack
	)

Definition at line 1872 of file apply.c.

References apply_container().

Referenced by container_type_move_on(), and legacy_ob_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

int manual_apply	(	object *	op,
		object *	tmp,
		int	aflag
	)

Main apply handler.

Checks for unpaid items before applying.

Parameters:

op	::object causing tmp to be applied.
tmp	::object being applied.
aflag	special (always apply/unapply) flags. Nothing is done with them in this function - they are passed to apply_special().

Returns:

0: player or monster can't apply objects of that type
1: has been applied, or there was an error applying the object
2: objects of that type can't be applied if not in inventory

Definition at line 512 of file apply.c.

References check_race_restrictions(), draw_ext_info(), EVENT_APPLY, execute_event(), FLAG_APPLIED, FLAG_UNPAID, METHOD_OK, METHOD_SILENT_ERROR, MSG_TYPE_APPLY, MSG_TYPE_APPLY_ERROR, NDI_UNIQUE, ob_apply(), play_sound_player_only(), PLAYER, QUERY_FLAG, SCRIPT_FIX_ALL, and SOUND_TYPE_ITEM.

Referenced by cfapi_object_apply(), give_initial_items(), monster_apply_below(), monster_check_apply(), player_apply(), polymorph_living(), transmute_item_to_flower(), and write_scroll().

Here is the call graph for this function:

Here is the caller graph for this function:

int player_apply	(	object *	pl,
		object *	op,
		int	aflag,
		int	quiet
	)

Living thing is applying an object.

Parameters:

pl	::object causing op to be applied.
op	::object being applied.
aflag	special (always apply/unapply) flags. Nothing is done with them in this function - they are passed to apply_special().
quiet	if 1, suppresses the "don't know how to apply" and "you must get it first" messages as needed by player_apply_below(). There can still be "but you are floating high above the ground" messages.

Returns:

0: player or monster can't apply objects of that type
1: has been applied, or there was an error applying the object
2: objects of that type can't be applied if not in inventory

Definition at line 557 of file apply.c.

References apply_anim_suffix(), draw_ext_info(), draw_ext_info_format(), FLAG_WAS_WIZ, FLAG_WIZ, free_object(), manual_apply(), MAX_BUF, METHOD_ERROR, METHOD_OK, METHOD_SILENT_ERROR, METHOD_UNHANDLED, MOVE_FLYING, MSG_TYPE_APPLY, MSG_TYPE_APPLY_ERROR, NDI_UNIQUE, play_sound_map(), PLAYER, QUERY_FLAG, query_name(), remove_ob(), and SOUND_TYPE_ITEM.

Referenced by apply_cmd(), command_apply(), and player_apply_below().

Here is the call graph for this function:

Here is the caller graph for this function:

void player_apply_below ( object * pl )

Attempt to apply the object 'below' the player.

If the player has an open container, we use that for below, otherwise we use the ground.

Parameters:

pl player.

Definition at line 619 of file apply.c.

References FLAG_IS_FLOOR, METHOD_OK, ob_apply(), player_apply(), QUERY_FLAG, and TRANSPORT.

Referenced by cfapi_object_apply_below(), and command_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

void scroll_failure	(	object *	op,
		int	failure,
		int	power
	)

op made some mistake with a scroll, this takes care of punishment.

scroll_failure()- hacked directly from spell_failure

If settings.spell_failure_effects is FALSE, the only nasty things that can happen are weird spell cast, or mana drain.

Parameters:

op	who failed.
failure	what kind of nasty things happen.
power	the higher the value, the worse the thing that happens.

Definition at line 1708 of file apply.c.

References blind_living(), cast_magic_storm(), cast_wonder(), confuse_living(), create_archetype(), draw_ext_info(), free_object(), LOOSE_MANA, MSG_TYPE_APPLY, MSG_TYPE_APPLY_FAILURE, NDI_UNIQUE, paralyze_living(), PREFER_LOW, random_roll(), settings, Settings::spell_failure_effects, SPELL_WONDER, and TRUE.

Referenced by scroll_type_apply(), and spellbook_type_apply().

Here is the call graph for this function:

Here is the caller graph for this function:

int set_object_face_main ( object * op )

Makes an object's face the main face, which is supposed to be the "closed" one.

Sets an object's face to the 'face' in the archetype. Meant for showing containers opening and closing.

Parameters:

op	Object to set face on

Returns:: TRUE if face changed

Definition at line 160 of file apply.c.

References FALSE, find_face(), get_ob_key_value(), new_faces, and TRUE.

Referenced by apply_container(), and put_object_in_sack().

Here is the call graph for this function:

Here is the caller graph for this function:

static int set_object_face_other ( object * op ) [static]

Makes an object's face the other_arch face, supposed to be the "opened" one.

Sets an object's face to the other_arch 'face'. Meant for showing containers opening and closing.

Parameters:

op	Object to set face on

Returns:: TRUE if face changed

Definition at line 185 of file apply.c.

References FALSE, find_face(), get_ob_key_value(), new_faces, set_ob_key_value(), and TRUE.

Referenced by apply_container().

Here is the call graph for this function:

Here is the caller graph for this function:

int should_director_abort	(	object *	op,
		object *	victim
	)

Check if op should abort moving victim because of it's race or slaying.

Parameters:

op	detector or equivalent we're testing. Note that its type is not checked.
victim	object trying to move on op.

Returns:: 1 if it should abort, 0 if it should continue.

Definition at line 81 of file apply.c.

Referenced by director_type_move_on(), move_player_mover(), and player_mover_type_move_on().

Here is the caller graph for this function:

int transport_can_hold	(	const object *	transport,
		const object *	op,
		int	nrof
	)

Can transport hold object op? This is a pretty trivial function, but in the future, possible transport may have more restrictions or weight reduction like containers.

Parameters:

transport	transport to check.
op	object we're trying to insert.
nrof	number of op.

Returns:: 1 if can hold, 0 else.

Definition at line 64 of file apply.c.

Referenced by esrv_move_object(), put_object_in_sack(), and transport_type_apply().

Here is the caller graph for this function:

static int unapply_for_ob	(	object *	who,
		object *	op,
		int	aflags
	)		`[static]`

Remove equipment so an object can be applied.

This should only be called when it is known that there are objects to unapply. This makes pretty heavy use of get_item_from_body_location(). It makes no intelligent choice on objects - rather, the first that matched is used.

if aflags has AP_PRINT set, we instead print out waht to unapply instead of doing it. This is a lot less code than having another function that does just that.

Parameters:

who	living trying to apply op.
op	::object being applied.
aflags	combination of AP_xxx flags.

Returns:: 0 on success, 1 if there is some problem.

Definition at line 850 of file apply.c.

References AP_IGNORE_CURSE, AP_NOPRINT, AP_PRINT, draw_ext_info(), draw_ext_info_format(), FLAG_APPLIED, FLAG_CURSED, FLAG_DAMNED, get_item_from_body_location(), MAX_BUF, MSG_TYPE_APPLY, MSG_TYPE_APPLY_UNAPPLY, NDI_UNIQUE, QUERY_FLAG, query_name(), SHIELD, unapply_special(), and WEAPON.

Referenced by apply_special().

Here is the call graph for this function:

Here is the caller graph for this function:

static int unapply_special	(	object *	who,
		object *	op,
		int	aflags
	)		`[static]`

Unapplies specified item.

No check done on cursed/damned. Break this out of apply_special() - this is just done to keep the size of apply_special() to a more managable size.

Parameters:

who	living that has op removed.
op	::object.
aflags	combination of AP_xxx flags.

Returns:: 0.

Definition at line 675 of file apply.c.

References AMULET, AP_NO_MERGE, AP_NOPRINT, ARMOUR, BOOTS, BOW, BRACERS, BUILDER, change_abil(), CLEAR_FLAG, clear_skill(), CLOAK, draw_ext_info_format(), esrv_update_item(), fix_object(), FLAG_APPLIED, FLAG_READY_BOW, FLAG_READY_RANGE, FLAG_READY_SKILL, FLAG_READY_WEAPON, GIRDLE, GLOVES, HELMET, HORN, LAMP, llevError, LOG(), MAX_BUF, merge_ob(), MSG_TYPE_APPLY, MSG_TYPE_APPLY_UNAPPLY, NDI_UNIQUE, PLAYER, QUERY_FLAG, query_name(), range_builder, range_none, range_skill, RING, ROD, SHIELD, SKILL, SKILL_TOOL, UPD_FLAGS, WAND, and WEAPON.

Referenced by apply_special(), and unapply_for_ob().

Here is the call graph for this function:

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation