Functions
static void	change_treasure (treasure t, object op)

static void	check_treasurelist (const treasure t, const treasurelist tl)

static void	create_all_treasures (treasure t, object op, int flag, int difficulty, int tries)

static void	create_one_treasure (treasurelist tl, object op, int flag, int difficulty, int tries)

void	create_treasure (treasurelist t, object op, int flag, int difficulty, int tries)

treasurelist *	find_treasurelist (const char *name)

object *	generate_treasure (treasurelist *t, int difficulty)

static treasure *	get_empty_treasure (void)

static treasurelist *	get_empty_treasurelist (void)

static treasure *	load_treasure (FILE fp, int line)

void	load_treasures (void)

static void	put_treasure (object op, object creator, int flags)

Detailed Description

Introduction

Treasure lists specify what items an object can have when it is first created during a map initialisation.

Treasure lists contain items with a certain probability of apparition. When the list is instancied, so that for instance a monster can receive its items, the items are randomly chosen based on this probability, and inserted at the desired location.

Lists can reference other lists to group commony-used definitions.

The list format enables a yes-no structure, so that the presence of an item implies the presence of another (so arrows are given with a bow) or the absence of an item enables another item to be present (so a bow or a crossbow can be given, but not both).

Each item in the list has a chance factor, that determines its probability to be generated.

Treasure lists exist in two variations:

a treasure list will try to insert all its items in the object. Each item has a probability chance % to be generated.
a treasureone list will only select a random item to be inserted. An item has a probability of chance on (sum of all chance for the items in the list) to be generated

Treasure files

Treasures are defined in two places:

in the lib/treasures file
in individual .trs files in the archetypes tree

During the collect process, all .trs files will be aggregated to the lib/treasures files to produce the final treasures files.

Treasure generation

When a treasure must be generated, a magic level is used to determine what items are eligible for generation. An item on a treasure list can only be generated if its magic field is less then the magic level specified.

Some flags can alter the generating behaviour. In particular, GT_ONLY_GOOD will forbid the generation of cursed or damned items.

A maximum of 100 tries will be done to generate an item, after which the generation is considered to have failed.

Treasure file format

The format is a line by line description of the treasure, and its options. The text before the first space is the field, remaining of the line is the value.

A treasure list definition starts by a treasure, treasureone, yes, no or more parameter. If treasure or treasureone is used, the part on the right of the first space is the treasure list name. The definition must end by a end line.

The line can start by spaces that will be ignored. A line starting by # is a comment and will be totally ignored.

The following fields are available:

treasure: starts a new treasure list, from which all items may be generated
treasureone: starts a new treasure list, from which only one item may be generated
arch: archetype name of the item to generate
list: treasure list name to reference
change_name: what name to give to the generated item
change_title: what title to give to the generated item
change_slaying: what slaying to give to the generated item
chance: probability of the item appearing, in % for a treasure list or relative to the sum of all chance for treasureone. Defaults to 100
nrof: maximum number of items to generate. Omitted means archetype default
magic: minimum magic required for this item to be generated
yes: starts a new treasure that will be generated if the current item is generated
no: starts a new treasure that will be generated if the current item is not generated
end: ends the current treasure definition
more: starts a new treasure that will be in the same list as the current one

Either arch or list must be set.

Simple example

treasure rod
 arch rod_light
 chance 2
 no
  arch rod_heavy
  chance 1
  end
end

This treasure means:

there's a probability of 2% to give a rod_light
if no rod_light is given, then there is a probability of 1% to give a rod_heavy

Complex example

 treasure poor_old
   arch bow
   chance 5
   yes
    arch arrow
     nrof 6
     end
   more
   arch b_ssword_2
   magic 1
   chance 5
   no
     arch b_ssword_1
     chance 10
     no
       arch b_dagger
       chance 15
       no
         arch stoneaxe
        chance 20
        no
          arch club
          chance 25
          end
        end
      end
    end
  more
  arch b_small_shield
  chance 4
  more
  arch silvercoin
  nrof 8
  chance 10
  end

Given the magic of 1 or more, this list has:

a 5% chance of generating a bow and up to 6 arrows
a 5% chance of generating a b_ssword_2
a 95% * 10% chance of generating a b_ssword_1
a 95% * 90% * 15% chance of generating a b_dagger
(and so on)
a 4% chance of generating a b_small_shield
a 10% chance of generating silver coins, from 1 to 8

Function Documentation

static void change_treasure	(	treasure *	t,
		object *	op
	)

static

if there are change_xxx commands in the treasure, we include the changes in the generated object

Parameters

t	treasure.
op	actual generated treasure.

Definition at line 354 of file treasure.c.

References add_string(), treasurestruct::change_arch, FREE_AND_COPY, free_string(), _change_arch::name, obj::name, obj::name_pl, _change_arch::slaying, obj::slaying, _change_arch::title, and obj::title.

Referenced by create_all_treasures(), and create_one_treasure().

Here is the call graph for this function:

Here is the caller graph for this function:

static void check_treasurelist	(	const treasure *	t,
		const treasurelist *	tl
	)

static

Checks if a treasure if valid. Will also check its yes and no options.

Will LOG() to error.

Parameters

t	treasure to check.
tl	needed only so that the treasure name can be printed out.

Definition at line 200 of file treasure.c.

References treasurestruct::chance, find_treasurelist(), treasurestruct::item, llevError, LOG(), treasurestruct::name, treasureliststruct::name, treasurestruct::next, treasurestruct::next_no, and treasurestruct::next_yes.

Referenced by load_treasures().

Here is the call graph for this function:

Here is the caller graph for this function:

static void create_all_treasures	(	treasure *	t,
		object *	op,
		int	flag,
		int	difficulty,
		int	tries
	)

static

Creates all the treasures.

Parameters

t	what to generate.
op	for who to generate the treasure.
flag	combination of GT_xxx values.
difficulty	map difficulty.
tries	to avoid infinite recursion.

Definition at line 390 of file treasure.c.

References arch_to_object(), treasurestruct::chance, change_treasure(), archt::clone, create_treasure(), find_treasurelist(), fix_generated_item(), GT_INVISIBLE, obj::invisible, treasurestruct::item, treasurestruct::magic, treasurestruct::name, treasurestruct::next, treasurestruct::next_no, treasurestruct::next_yes, treasurestruct::nrof, obj::nrof, and put_treasure().

Referenced by create_treasure().

Here is the call graph for this function:

Here is the caller graph for this function:

static void create_one_treasure	(	treasurelist *	tl,
		object *	op,
		int	flag,
		int	difficulty,
		int	tries
	)

static

Creates one treasure from the list.

Parameters

tl	what to generate.
op	for who to generate the treasure.
flag	combination of GT_xxx values.
difficulty	map difficulty.
tries	to avoid infinite recursion.

Note: can abort() if treasure has errors.

Definition at line 435 of file treasure.c.

References arch_to_object(), treasurestruct::chance, change_treasure(), archt::clone, create_treasure(), find_treasurelist(), fix_generated_item(), FLAG_CURSED, FLAG_DAMNED, GT_INVISIBLE, GT_ONLY_GOOD, obj::invisible, treasurestruct::item, treasureliststruct::items, llevDebug, llevError, LOG(), treasurestruct::magic, treasurestruct::name, treasurestruct::next, treasurestruct::nrof, obj::nrof, put_treasure(), QUERY_FLAG, and treasureliststruct::total_chance.

Referenced by create_treasure().

Here is the call graph for this function:

Here is the caller graph for this function:

void create_treasure	(	treasurelist *	t,
		object *	op,
		int	flag,
		int	difficulty,
		int	tries
	)

This calls the appropriate treasure creation function.

Parameters

t	what to generate.
op	for who to generate the treasure.
flag	combination of GT_xxx values.
difficulty	map difficulty.
tries	to avoid infinite recursion.

Definition at line 499 of file treasure.c.

References create_all_treasures(), create_one_treasure(), treasureliststruct::items, llevDebug, LOG(), and treasureliststruct::total_chance.

Referenced by auto_apply(), command_create(), create_all_treasures(), create_one_treasure(), do_auto_apply(), fix_auto_apply(), fix_generated_item(), fix_summon_pet(), generate_monster_arch(), generate_monster_inv(), generate_treasure(), give_initial_items(), god_intervention(), key_change_class(), polymorph_living(), put_a_monster(), rune_attack(), and summon_object().

Here is the call graph for this function:

Here is the caller graph for this function:

treasurelist* find_treasurelist ( const char * name )

Searches for the given treasurelist in the globally linked list of treasurelists which has been built by load_treasures().

Will LOG() to error if not found.

Parameters

name	treasure list to search.

Returns: match, or NULL if treasurelist doesn't exist or is 'none'.

Definition at line 295 of file treasure.c.

References find_string(), first_treasurelist, llevError, LOG(), treasureliststruct::name, and treasureliststruct::next.

Referenced by check_treasurelist(), create_all_treasures(), create_one_treasure(), dragon_ability_gain(), dump_monster_treasure_rec(), find_treasure_by_name(), god_intervention(), key_change_class(), place_chest(), resurrect_player(), second_arch_pass(), START_TEST(), and CREUtils::treasureNode().

Here is the call graph for this function:

Here is the caller graph for this function:

object* generate_treasure	(	treasurelist *	t,
		int	difficulty
	)

This is similar to the old generate treasure function. However, it instead takes a treasurelist. It is really just a wrapper around create_treasure(). We create a dummy object that the treasure gets inserted into, and then return that treasure.

Parameters