File /obj/handlers/item_tracker.c

Written by Shaggy

Inherits

Includes

Method index

• delete_item(mixed, mixed)
  This method deletes the state/location information of a specific quest item owned by a player.
• query_all_item_states(mixed)
  This method returns all the information about quest items owned by a player.
• query_item_copies(mixed, mixed)
  This method returns the total number of known copies of a specific quest item owned by a player.
• query_item_state(mixed, mixed)
  This method returns the state/location of a specific quest item owned by a player.
• save_all_item_states(mixed)
  This method saves the mapping of state/location information for items owned by a player to disk.
• save_all_item_states_delete_cache(mixed)
  This method saves the mapping of state/location information for items owned by a player to disk and deletes the entry in the cache.
• set_item_state(mixed, mixed, mixed)
  This method sets the state/location of a specific quest item owned by a player.

Public Functions

delete_item

int delete_item(mixed pl_name,
                mixed item)

This method deletes the state/location information of a specific quest item owned by a player.

If the item isn't actually owned by the player it returns 0

Parameters:
pl_name - player object or name
item - item object or identifier

See also:
set_item_state()

query_all_item_states

mixed query_all_item_states(mixed pl_name)

This method returns all the information about quest items owned by a player.

Parameters:
pl_name - player object or name

See also:
set_item_state() and delete_item()

query_item_copies

int query_item_copies(mixed pl_name,
                      mixed item)

This method returns the total number of known copies of a specific quest item owned by a player.

If the item isn't actually owned by the player it doesn't matter.

Parameters:
pl_name - player object or name
item - item object or identifier

See also:
set_item_state() and delete_item()

query_item_state

mixed query_item_state(mixed pl_name,
                       mixed item)

This method returns the state/location of a specific quest item owned by a player.

If the item isn't actually owned by the player it returns 0

Parameters:
pl_name - player object or name
item - item object or identifier

See also:
set_item_state() and delete_item()

save_all_item_states

int save_all_item_states(mixed pl_name)

This method saves the mapping of state/location information for items owned by a player to disk.

Parameters:
pl_name - player object or name
item - item object or identifier

Returns:
1 if successful

See also:
set_item_state(), query_item_state(), delete_item() and save_all_item_states_and_delete_from_cache()

save_all_item_states_delete_cache

int save_all_item_states_delete_cache(mixed pl_name)

This method saves the mapping of state/location information for items owned by a player to disk and deletes the entry in the cache.

Parameters:
pl_name - player object or name
item - item object or identifier

Returns:
1 if successful

See also:
set_item_state(), query_item_state(), delete_item() and save_all_item_states()

set_item_state

int set_item_state(mixed pl_name,
                   mixed item,
                   mixed state)

This method sets the state/location of a specific quest item owned by a player.

If the item isn't actually owned by the player it returns 0

Parameters:
pl_name - player object or name
item - item object or identifier

See also:
query_item_state(), delete_item() and save_all_item_states()