Crossfire Server, Trunk
plugin_common.h File Reference
#include <plugin.h>
+ Include dependency graph for plugin_common.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define CF_PLUGIN
 
#define PLUGIN_ERROR_INT   0x0FFFFF
 

Functions

sstring cf_add_string (const char *str)
 
objectcf_archetype_get_clone (archetype *arch)
 
archetypecf_archetype_get_first (void)
 
archetypecf_archetype_get_head (archetype *arch)
 
archetypecf_archetype_get_more (archetype *arch)
 
sstring cf_archetype_get_name (archetype *arch)
 
archetypecf_archetype_get_next (archetype *arch)
 
void cf_cost_string_from_value (uint64_t cost, int largest_coin, char *buffer, int length)
 
objectcf_create_object (void)
 
objectcf_create_object_by_name (const char *name)
 
int cf_find_animation (const char *txt)
 
int cf_find_face (const char *name, int error)
 
sstring cf_find_string (const char *str)
 
void cf_fix_object (object *op)
 
void cf_free_string (sstring str)
 
objectcf_friendlylist_get_first (void)
 
objectcf_friendlylist_get_next (object *ob)
 
const char * cf_get_directory (int id)
 
mapstructcf_get_empty_map (int sizex, int sizey)
 
char * cf_get_maps_directory (const char *name, char *buf, int size)
 
const char * cf_get_month_name (int index)
 
const char * cf_get_periodofday_name (int index)
 
const char * cf_get_season_name (int index)
 
void cf_get_time (timeofday_t *tod)
 
const char * cf_get_weekday_name (int index)
 
objectcf_identify (object *op)
 
int cf_init_plugin (f_plug_api getHooks)
 
void cf_log (LogLevel logLevel, const char *format,...)
 
void cf_log_plain (LogLevel logLevel, const char *message)
 
int cf_map_change_light (mapstruct *m, int change)
 
objectcf_map_find_by_archetype_name (const char *str, mapstruct *map, int nx, int ny)
 
int cf_map_get_darkness (mapstruct *map)
 
int cf_map_get_difficulty (mapstruct *map)
 
int cf_map_get_enter_x (mapstruct *map)
 
int cf_map_get_enter_y (mapstruct *map)
 
mapstructcf_map_get_first (void)
 
int cf_map_get_flags (mapstruct *oldmap, mapstruct **newmap, int16_t x, int16_t y, int16_t *nx, int16_t *ny)
 
int cf_map_get_height (mapstruct *map)
 
int cf_map_get_int_property (mapstruct *map, int property)
 
int cf_map_get_light (mapstruct *map)
 
mapstructcf_map_get_map (const char *name, int flags)
 
mapstructcf_map_get_map_property (mapstruct *map, int propcode)
 
objectcf_map_get_object_at (mapstruct *m, int x, int y)
 
int cf_map_get_players (mapstruct *map)
 
regioncf_map_get_region_property (mapstruct *map, int propcode)
 
int cf_map_get_reset_time (mapstruct *map)
 
int cf_map_get_reset_timeout (mapstruct *map)
 
sstring cf_map_get_sstring_property (mapstruct *map, int propcode)
 
int cf_map_get_width (mapstruct *map)
 
mapstructcf_map_has_been_loaded (const char *name)
 
objectcf_map_insert_object (mapstruct *where, object *op, int x, int y)
 
objectcf_map_insert_object_around (mapstruct *where, object *op, int x, int y)
 
objectcf_map_insert_object_there (object *op, mapstruct *m, object *originator, int flag)
 
void cf_map_message (mapstruct *m, const char *msg, int color)
 
void cf_map_set_int_property (mapstruct *map, int propcode, int value)
 
void cf_map_set_string_property (mapstruct *map, int propcode, const char *value)
 
void cf_map_trigger_connected (objectlink *ol, object *cause, int state)
 
int cf_object_apply (object *op, object *author, int flags)
 
void cf_object_apply_below (object *pl)
 
int cf_object_cast_spell (object *op, object *caster, int dir, object *spell_ob, char *stringarg)
 
int cf_object_change_abil (object *op, object *tmp)
 
void cf_object_change_exp (object *op, int64_t exp, const char *skill_name, int flag)
 
objectcf_object_change_map (object *op, mapstruct *m, object *originator, int flag, int x, int y)
 
objectcf_object_check_for_spell (object *op, const char *name)
 
int cf_object_check_trigger (object *op, object *cause)
 
objectcf_object_clone (object *op, int clonetype)
 
void cf_object_drop (object *op, object *author)
 
objectcf_object_find_by_arch_name (const object *who, const char *name)
 
objectcf_object_find_by_name (const object *who, const char *name)
 
void cf_object_forget_spell (object *op, object *sp)
 
void cf_object_free_drop_inventory (object *ob)
 
archetypecf_object_get_archetype_property (object *op, int propcode)
 
double cf_object_get_double_property (object *op, int propcode)
 
int cf_object_get_flag (object *ob, int flag)
 
float cf_object_get_float_property (object *op, int propcode)
 
int64_t cf_object_get_int64_property (object *op, int propcode)
 
int cf_object_get_int_property (object *op, int propcode)
 
const char * cf_object_get_key (object *op, const char *keyname)
 
long cf_object_get_long_property (object *op, long propcode)
 
mapstructcf_object_get_map_property (object *op, int propcode)
 
MoveType cf_object_get_movetype_property (object *op, int propcode)
 
const char * cf_object_get_msg (object *)
 
int cf_object_get_nrof (object *)
 
objectcf_object_get_object_property (object *op, int propcode)
 
partylistcf_object_get_partylist_property (object *op, int propcode)
 
int16_t cf_object_get_resistance (object *op, int rtype)
 
sstring cf_object_get_sstring_property (object *op, int propcode)
 
char * cf_object_get_string_property (object *op, int propcode, char *buf, int size)
 
int cf_object_get_weight (object *ob)
 
int cf_object_get_weight_limit (object *ob)
 
objectcf_object_insert_in_ob (object *op, object *where)
 
objectcf_object_insert_object (object *op, object *container)
 
void cf_object_learn_spell (object *op, object *spell, int special_prayer)
 
int cf_object_move (object *op, int dir, object *originator)
 
int cf_object_move_to (object *op, int x, int y)
 
int cf_object_out_of_map (object *op, int x, int y)
 
int cf_object_pay_amount (object *pl, uint64_t to_pay)
 
int cf_object_pay_item (object *op, object *pl)
 
int64_t cf_object_perm_exp (object *op)
 
void cf_object_pickup (object *op, object *what)
 
objectcf_object_present_archname_inside (object *op, char *whatstr)
 
int cf_object_query_cost (const object *tmp, object *who, int flag)
 
void cf_object_query_cost_string (const object *tmp, object *who, int flag, char *buffer, int length)
 
int cf_object_query_money (const object *op)
 
void cf_object_remove (object *op)
 
int cf_object_remove_depletion (object *op, int level)
 
void cf_object_say (object *op, const char *msg)
 
int cf_object_set_animation (object *op, const char *animation)
 
int cf_object_set_face (object *op, const char *face)
 
void cf_object_set_flag (object *ob, int flag, int value)
 
void cf_object_set_float_property (object *op, int propcode, float value)
 
void cf_object_set_int64_property (object *op, int propcode, int64_t value)
 
void cf_object_set_int_property (object *op, int propcode, int value)
 
int cf_object_set_key (object *op, const char *keyname, const char *value, int add_key)
 
void cf_object_set_long_property (object *op, int propcode, long value)
 
void cf_object_set_movetype_property (object *op, int propcode, MoveType value)
 
int cf_object_set_nrof (object *, int nrof)
 
void cf_object_set_object_property (object *op, int propcode, object *value)
 
void cf_object_set_resistance (object *op, int rtype, int16_t value)
 
void cf_object_set_string_property (object *op, int propcode, const char *value)
 
void cf_object_set_weight (object *ob, int weight)
 
void cf_object_set_weight_limit (object *ob, int weight)
 
objectcf_object_split (object *orig_ob, uint32_t nr, char *err, size_t size)
 
int cf_object_teleport (object *ob, mapstruct *map, int x, int y)
 
int cf_object_transfer (object *op, int x, int y, int randomly, object *originator)
 
void cf_object_update (object *op, int flags)
 
int cf_object_user_event (object *op, object *activator, object *third, const char *message, int fix)
 
partylistcf_party_get_first (void)
 
playercf_party_get_first_player (partylist *party)
 
const char * cf_party_get_name (partylist *party)
 
partylistcf_party_get_next (partylist *party)
 
playercf_party_get_next_player (partylist *party, player *op)
 
const char * cf_party_get_password (partylist *party)
 
int cf_player_arrest (object *who)
 
int cf_player_can_pay (object *op)
 
playercf_player_find (const char *plname)
 
sstring cf_player_get_ip (object *op)
 
objectcf_player_get_marked_item (object *op)
 
partylistcf_player_get_party (object *op)
 
char * cf_player_get_title (object *op, char *title, int size)
 
void cf_player_knowledge_give (object *op, const char *knowledge)
 
int cf_player_knowledge_has (object *op, const char *knowledge)
 
void cf_player_message (object *op, const char *txt, int flags)
 
int cf_player_move (player *pl, int dir)
 
void cf_player_set_marked_item (object *op, object *ob)
 
void cf_player_set_party (object *op, partylist *party)
 
void cf_player_set_title (object *op, const char *title)
 
char * cf_query_name (object *ob, char *name, int size)
 
sstring cf_query_name_pl (object *ob)
 
int cf_quest_get_player_state (object *pl, sstring quest_code)
 
void cf_quest_set_player_state (object *pl, sstring quest_code, int state)
 
void cf_quest_start (object *pl, sstring quest_code, int state)
 
int cf_quest_was_completed (object *pl, sstring quest_code)
 
mapstructcf_random_map_generate (const char *OutFileName, RMParms *RP, char **use_layout, sstring reset_group)
 
int cf_random_map_set_variable (RMParms *rp, const char *buf)
 
const char * cf_re_cmp (const char *str, const char *regexp)
 
regioncf_region_get_first (void)
 
const char * cf_region_get_jail_path (region *reg)
 
int cf_region_get_jail_x (region *reg)
 
int cf_region_get_jail_y (region *reg)
 
const char * cf_region_get_longname (region *reg)
 
const char * cf_region_get_message (region *reg)
 
const char * cf_region_get_name (region *reg)
 
regioncf_region_get_next (region *reg)
 
regioncf_region_get_parent (region *reg)
 
void cf_spring_trap (object *trap, object *victim)
 
char * cf_strdup_local (const char *str)
 
void cf_system_get_archetype_vector (int property, std::vector< archetype * > *list)
 
void cf_system_get_map_vector (int property, std::vector< mapstruct * > *list)
 
void cf_system_get_object_vector (int property, std::vector< object * > *list)
 
void cf_system_get_party_vector (int property, std::vector< partylist * > *list)
 
void cf_system_get_region_vector (int property, std::vector< region * > *list)
 
command_registration cf_system_register_command (const char *name, command_function func, uint8_t command_type, float time)
 
command_registration cf_system_register_command_extra (const char *name, const char *extra, command_function_extra func, uint8_t command_type, float time)
 
void cf_system_register_global_event (int event, const char *name, f_plug_event hook)
 
void cf_system_unregister_command (command_registration command)
 
void cf_system_unregister_global_event (int event, const char *name)
 
int cf_timer_create (object *ob, long delay, int mode)
 
int cf_timer_destroy (int id)
 

Macro Definition Documentation

◆ CF_PLUGIN

#define CF_PLUGIN

Definition at line 38 of file plugin_common.h.

◆ PLUGIN_ERROR_INT

#define PLUGIN_ERROR_INT   0x0FFFFF

Definition at line 44 of file plugin_common.h.

Function Documentation

◆ cf_add_string()

sstring cf_add_string ( const char *  str)

Wrapper for add_string(). This will add 'str' to the hash table. If there's no entry for this string, a copy will be allocated, and a pointer to that is returned.

Parameters
strstring to share.
Returns
pointer to string identical to str, but shared.

Definition at line 1167 of file plugin_common.cpp.

References CFAPI_SSTRING, cfapiSystem_add_string, sstring, make_face_from_files::str, and is_valid_types_gen::type.

Referenced by addReply(), compilePython(), Crossfire_Object_Say(), initapplyobject(), initdropobject(), initpickupobject(), npcSay(), Player_QuestGetState(), Player_QuestSetState(), Player_QuestStart(), Player_QuestWasCompleted(), setPlayerMessage(), and start_animation().

+ Here is the caller graph for this function:

◆ cf_archetype_get_clone()

object* cf_archetype_get_clone ( archetype arch)

Get clone of archetype.

Parameters
archarchetype, mustn't be NULL.
Returns
archetype's clone. Will never be NULL.

Definition at line 1767 of file plugin_common.cpp.

References archininventory::arch, CFAPI_ARCH_PROP_CLONE, CFAPI_POBJECT, cfapiArchetype_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Archetype_GetClone().

+ Here is the caller graph for this function:

◆ cf_archetype_get_first()

archetype* cf_archetype_get_first ( void  )

Get first archetype.

Returns
first archetype in the archetype list.

Definition at line 1686 of file plugin_common.cpp.

References CFAPI_ARCH_PROP_NEXT, CFAPI_PARCH, cfapiArchetype_get_property, is_valid_types_gen::type, and autojail::value.

◆ cf_archetype_get_head()

archetype* cf_archetype_get_head ( archetype arch)

Get head of archetype.

Parameters
archarchetype, mustn't be NULL.
Returns
archetype's head field.

Definition at line 1751 of file plugin_common.cpp.

References archininventory::arch, CFAPI_ARCH_PROP_HEAD, CFAPI_PARCH, cfapiArchetype_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Archetype_GetHead().

+ Here is the caller graph for this function:

◆ cf_archetype_get_more()

archetype* cf_archetype_get_more ( archetype arch)

Get next part of archetype.

Parameters
archarchetype, mustn't be NULL.
Returns
archetype's more field.

Definition at line 1735 of file plugin_common.cpp.

References archininventory::arch, CFAPI_ARCH_PROP_MORE, CFAPI_PARCH, cfapiArchetype_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Archetype_GetMore().

+ Here is the caller graph for this function:

◆ cf_archetype_get_name()

sstring cf_archetype_get_name ( archetype arch)

Get archetype's name.

Parameters
archarchetype, mustn't be NULL.
Returns
archetype's name.

Definition at line 1702 of file plugin_common.cpp.

References archininventory::arch, CFAPI_ARCH_PROP_NAME, CFAPI_SSTRING, cfapiArchetype_get_property, give::name, sstring, and is_valid_types_gen::type.

Referenced by Crossfire_Archetype_GetName(), and Crossfire_Archetype_GetNewObject().

+ Here is the caller graph for this function:

◆ cf_archetype_get_next()

archetype* cf_archetype_get_next ( archetype arch)

Get next archetype in linked list.

Parameters
archarchetype for which we want the next. Can be NULL, in which case it is equivalent to calling cf_archetype_get_first().
Returns
next archetype.

Definition at line 1719 of file plugin_common.cpp.

References archininventory::arch, CFAPI_ARCH_PROP_NEXT, CFAPI_PARCH, cfapiArchetype_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Archetype_GetNext().

+ Here is the caller graph for this function:

◆ cf_cost_string_from_value()

void cf_cost_string_from_value ( uint64_t  cost,
int  largest_coin,
char *  buffer,
int  length 
)

Wrapper for cost_string_from_value modified to take a char* and length instead of a StringBuffer.

Definition at line 994 of file plugin_common.cpp.

References CFAPI_NONE, cfapiCost_string_from_value, diamondslots::cost, and is_valid_types_gen::type.

Referenced by costStringFromValue().

+ Here is the caller graph for this function:

◆ cf_create_object()

object* cf_create_object ( void  )

Wrapper for object_new(). Grabs an object from the list of unused objects, makes sure it is initialised, and returns it.

If there are no free objects, expand_objects() is called to get more.

Returns
cleared and ready to use object*.
Note
will never fail, as expand_objects() will fatal() if memory allocation error.

Definition at line 1081 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_create, is_valid_types_gen::type, and autojail::value.

Referenced by createCFObject().

+ Here is the caller graph for this function:

◆ cf_create_object_by_name()

object* cf_create_object_by_name ( const char *  name)

◆ cf_find_animation()

int cf_find_animation ( const char *  name)

Wrapper for find_animation().

Definition at line 1498 of file plugin_common.cpp.

References animate::anim, CFAPI_INT, cfapiSystem_find_animation, give::name, and is_valid_types_gen::type.

Referenced by findAnimation().

+ Here is the caller graph for this function:

◆ cf_find_face()

int cf_find_face ( const char *  name,
int  error 
)

Wrapper for find_face().

Definition at line 1510 of file plugin_common.cpp.

References animate::anim, CFAPI_INT, cfapiSystem_find_face, report::error(), give::name, and is_valid_types_gen::type.

Referenced by findFace().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_find_string()

sstring cf_find_string ( const char *  str)

Definition at line 1189 of file plugin_common.cpp.

References CFAPI_SSTRING, cfapiSystem_find_string, sstring, make_face_from_files::str, and is_valid_types_gen::type.

Referenced by find_by_name().

+ Here is the caller graph for this function:

◆ cf_fix_object()

void cf_fix_object ( object op)

Wrapper for fix_object(). Updates all abilities given by applied objects in the inventory of the given object.

This functions starts from base values (archetype or player object) and then adjusts them according to what the player/monster has equipped.

Note that a player always has stats reset to their initial value.

July 95 - inserted stuff to handle new skills/exp system - b.t. spell system split, grace points now added to system –peterm

November 2006: max armor speed is always taken into account, no exception.

Parameters
opobject to reset.
Todo:
this function is too long, and should be cleaned / split.

Definition at line 1156 of file plugin_common.cpp.

References cfapiObject_fix, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_Fix().

+ Here is the caller graph for this function:

◆ cf_free_string()

void cf_free_string ( sstring  str)

Wrapper for free_string(). This will reduce the refcount, and if it has reached 0, str will be freed.

Parameters
strstring to release, which *must *have been returned from a previous add_string().
Note
the memory pointed to by str can be freed after this call, so don't use str anymore.

Definition at line 1182 of file plugin_common.cpp.

References cfapiSystem_remove_string, make_face_from_files::str, and is_valid_types_gen::type.

Referenced by closePlugin(), compilePython(), Player_QuestGetState(), Player_QuestSetState(), Player_QuestStart(), Player_QuestWasCompleted(), runapplyobject(), rundropobject(), runpickupobject(), setPlayerMessage(), and start_animation().

+ Here is the caller graph for this function:

◆ cf_friendlylist_get_first()

object* cf_friendlylist_get_first ( void  )

Get first object on friendly list.

Returns
first object on friendly list.

Definition at line 2020 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiFriendlylist_get_next, is_valid_types_gen::type, and autojail::value.

◆ cf_friendlylist_get_next()

object* cf_friendlylist_get_next ( object ob)

Get next object on friendly list.

Parameters
obobject we want the next of. If NULL then equivalent of cf_friendlylist_get_first().
Returns
next object.

Definition at line 2036 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiFriendlylist_get_next, guildjoin::ob, is_valid_types_gen::type, and autojail::value.

◆ cf_get_directory()

const char* cf_get_directory ( int  id)

Gets a directory Crossfire uses.

Parameters
idwhat directory to return:
  1. Where the map files are
  2. Directory for the unique items
  3. Directory to use for temporary files
  4. Configuration files
  5. Read/write data files
  6. Where the player files are
  7. Read only data files
Returns
directory. Must not be altered. NULL if invalid value.

Definition at line 1130 of file plugin_common.cpp.

References CFAPI_STRING, cfapiSystem_directory, and is_valid_types_gen::type.

Referenced by getConfigDirectory(), getDataDirectory(), getLocalDirectory(), getMapDirectory(), getPlayerDirectory(), getTempDirectory(), getUniqueDirectory(), and postInitPlugin().

+ Here is the caller graph for this function:

◆ cf_get_empty_map()

mapstruct* cf_get_empty_map ( int  sizex,
int  sizey 
)

Wrapper for get_empty_map().

Definition at line 948 of file plugin_common.cpp.

References CFAPI_PMAP, cfapiMap_get_map, and is_valid_types_gen::type.

Referenced by createMap().

+ Here is the caller graph for this function:

◆ cf_get_maps_directory()

char* cf_get_maps_directory ( const char *  name,
char *  buf,
int  size 
)

Wrapper for create_pathname(). Get the full path to a map file. This simply means prepending the correct map directory to the given path.

Parameters
namepath of the map.
bufbuffer that will contain the full path.
sizebuffer's length.
Returns
buf.

Definition at line 1069 of file plugin_common.cpp.

References buf, CFAPI_STRING, cfapiMap_create_path, give::name, and is_valid_types_gen::type.

Referenced by eventListener(), getEventFiles(), postInitPlugin(), and python_command_function().

+ Here is the caller graph for this function:

◆ cf_get_month_name()

const char* cf_get_month_name ( int  index)

Definition at line 1565 of file plugin_common.cpp.

References CFAPI_STRING, cfapiSystem_get_month_name, npc_dialog::index, rotate-tower::result, and is_valid_types_gen::type.

Referenced by getMonthName().

+ Here is the caller graph for this function:

◆ cf_get_periodofday_name()

const char* cf_get_periodofday_name ( int  index)

Definition at line 1583 of file plugin_common.cpp.

References CFAPI_STRING, cfapiSystem_get_periodofday_name, npc_dialog::index, rotate-tower::result, and is_valid_types_gen::type.

Referenced by getPeriodofdayName().

+ Here is the caller graph for this function:

◆ cf_get_season_name()

const char* cf_get_season_name ( int  index)

Definition at line 1556 of file plugin_common.cpp.

References CFAPI_STRING, cfapiSystem_get_season_name, npc_dialog::index, rotate-tower::result, and is_valid_types_gen::type.

Referenced by getSeasonName().

+ Here is the caller graph for this function:

◆ cf_get_time()

void cf_get_time ( timeofday_t tod)

Definition at line 1549 of file plugin_common.cpp.

References CFAPI_NONE, cfapiSystem_get_time, and is_valid_types_gen::type.

Referenced by get_newspaper_content(), getTime(), and store_time().

+ Here is the caller graph for this function:

◆ cf_get_weekday_name()

const char* cf_get_weekday_name ( int  index)

Definition at line 1574 of file plugin_common.cpp.

References CFAPI_STRING, cfapiSystem_get_weekday_name, npc_dialog::index, rotate-tower::result, and is_valid_types_gen::type.

Referenced by getWeekdayName().

+ Here is the caller graph for this function:

◆ cf_identify()

object* cf_identify ( object op)

Wrapper for identify(). Identifies an item. Supposed to fix face-values as well here, but later. Note - this may merge op with other object, so this function returns either the merged object or the original if no merge happened.

Parameters
opitem to identify. Can be already identified without ill effects.
Return values
objectThe identify object - this may vary from op if the object was merged.
Parameters
op
Returns

Definition at line 812 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_identify, give::op, rotate-tower::result, and is_valid_types_gen::type.

◆ cf_init_plugin()

int cf_init_plugin ( f_plug_api  getHooks)

Definition at line 146 of file plugin_common.cpp.

References cfapiArchetype_get_property, cfapiCost_string_from_value, cfapiFriendlylist_get_next, cfapiGenerate_random_map, cfapiMap_change_light, cfapiMap_create_path, cfapiMap_find_by_archetype_name, cfapiMap_get_map, cfapiMap_get_object_at, cfapiMap_get_property, cfapiMap_has_been_loaded, cfapiMap_message, cfapiMap_set_property, cfapiMap_trigger_connected, cfapiObject_activate_rune, cfapiObject_apply, cfapiObject_apply_below, cfapiObject_cast, cfapiObject_change_abil, cfapiObject_change_exp, cfapiObject_check_spell, cfapiObject_check_trigger, cfapiObject_clear, cfapiObject_clone, cfapiObject_create, cfapiObject_delete, cfapiObject_describe, cfapiObject_distance, cfapiObject_drain, cfapiObject_drop, cfapiObject_find_archetype_inside, cfapiObject_find_by_arch_name, cfapiObject_find_by_name, cfapiObject_fix, cfapiObject_forget_spell, cfapiObject_get_key, cfapiObject_get_property, cfapiObject_give_skill, cfapiObject_identify, cfapiObject_insert, cfapiObject_learn_spell, cfapiObject_merge, cfapiObject_move, cfapiObject_out_of_map, cfapiObject_pay_amount, cfapiObject_pay_item, cfapiObject_perm_exp, cfapiObject_pickup, cfapiObject_query_money, cfapiObject_remove, cfapiObject_remove_depletion, cfapiObject_reset, cfapiObject_say, cfapiObject_set_key, cfapiObject_set_property, cfapiObject_split, cfapiObject_teleport, cfapiObject_transfer, cfapiObject_transmute, cfapiObject_update, cfapiObject_user_event, cfapiParty_get_property, cfapiPlayer_can_pay, cfapiPlayer_find, cfapiPlayer_knowledge, cfapiPlayer_message, cfapiPlayer_quest, cfapiRegion_get_property, cfapiSet_random_map_variable, cfapiSystem_add_string, cfapiSystem_directory, cfapiSystem_find_animation, cfapiSystem_find_face, cfapiSystem_find_string, cfapiSystem_get_archetype_vector, cfapiSystem_get_map_vector, cfapiSystem_get_month_name, cfapiSystem_get_object_vector, cfapiSystem_get_party_vector, cfapiSystem_get_periodofday_name, cfapiSystem_get_region_vector, cfapiSystem_get_season_name, cfapiSystem_get_time, cfapiSystem_get_weekday_name, cfapiSystem_log, cfapiSystem_re_cmp, cfapiSystem_register_command, cfapiSystem_register_global_event, cfapiSystem_remove_string, cfapiSystem_strdup_local, cfapiSystem_timer_create, cfapiSystem_timer_destroy, cfapiSystem_unregister_command, cfapiSystem_unregister_global_event, GET_HOOK, and Moving_Fog::z.

Referenced by initPlugin().

+ Here is the caller graph for this function:

◆ cf_log()

◆ cf_log_plain()

void cf_log_plain ( LogLevel  logLevel,
const char *  message 
)

Wrapper for LOG() that uses directly a buffer, without format

Definition at line 1542 of file plugin_common.cpp.

References CFAPI_NONE, cfapiSystem_log, diamondslots::message, and is_valid_types_gen::type.

Referenced by Crossfire_Object_CastAbility(), and log_python_error().

+ Here is the caller graph for this function:

◆ cf_map_change_light()

int cf_map_change_light ( mapstruct m,
int  change 
)

Wrapper for change_map_light().

Definition at line 1420 of file plugin_common.cpp.

References CFAPI_INT, cfapiMap_change_light, m, is_valid_types_gen::type, and autojail::value.

Referenced by Map_ChangeLight().

+ Here is the caller graph for this function:

◆ cf_map_find_by_archetype_name()

object* cf_map_find_by_archetype_name ( const char *  str,
mapstruct map,
int  nx,
int  ny 
)

Kinda wrapper for map_find_by_archetype_name().

Definition at line 1371 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiMap_find_by_archetype_name, disinfect::map, make_face_from_files::str, is_valid_types_gen::type, and autojail::value.

Referenced by Map_Check().

+ Here is the caller graph for this function:

◆ cf_map_get_darkness()

int cf_map_get_darkness ( mapstruct map)

Definition at line 1396 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_DARKNESS, and disinfect::map.

Referenced by Map_GetDarkness().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_difficulty()

int cf_map_get_difficulty ( mapstruct map)

Definition at line 1380 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_DIFFICULTY, and disinfect::map.

Referenced by Map_GetDifficulty().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_enter_x()

int cf_map_get_enter_x ( mapstruct map)

Definition at line 1408 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_ENTER_X, and disinfect::map.

Referenced by Map_GetEnterX().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_enter_y()

int cf_map_get_enter_y ( mapstruct map)

Definition at line 1412 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_ENTER_Y, and disinfect::map.

Referenced by Map_GetEnterY().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_first()

mapstruct* cf_map_get_first ( void  )

Gives access to first_map.

Returns
first_map.

Definition at line 975 of file plugin_common.cpp.

References cf_map_get_map_property(), and CFAPI_MAP_PROP_NEXT.

+ Here is the call graph for this function:

◆ cf_map_get_flags()

int cf_map_get_flags ( mapstruct oldmap,
mapstruct **  newmap,
int16_t  x,
int16_t  y,
int16_t *  nx,
int16_t *  ny 
)

Wrapper for get_map_flags(). This rolls up wall, blocks_magic, blocks_view, etc, all into one function that just returns a P_.. value (see map.h) it will also do map translation for tiled maps, returning new values into newmap, nx, and ny. Any and all of those values can be null, in which case if a new map is needed (returned by a P_NEW_MAP value, another call to get_map_from_coord is needed. The case of not passing values is if we're just checking for the existence of something on those spaces, but don't expect to insert/remove anything from those spaces.

Parameters
oldmapmap for which we want information.
newmapif not NULL, will contain the actual map checked if not oldmap.
x
ycoordinates to check
nx
nyif not NULL, will contain the actual coordinates checked.
Returns
flags for specified position, with maybe P_OUT_OF_MAP or P_NEW_MAP set.

Definition at line 1461 of file plugin_common.cpp.

References CFAPI_INT, CFAPI_MAP_PROP_FLAGS, cfapiMap_get_property, is_valid_types_gen::type, autojail::value, diamondslots::x, and diamondslots::y.

Referenced by Map_Check().

+ Here is the caller graph for this function:

◆ cf_map_get_height()

int cf_map_get_height ( mapstruct map)

Definition at line 1404 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_HEIGHT, and disinfect::map.

Referenced by find_by_name(), and Map_GetHeight().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_int_property()

◆ cf_map_get_light()

int cf_map_get_light ( mapstruct map)

◆ cf_map_get_map()

mapstruct* cf_map_get_map ( const char *  name,
int  flags 
)

Wrapper for ready_map_name(). Makes sure the given map is loaded and swapped in.

Parameters
namepath name of the map.
flags
  • 0x1 (MAP_FLUSH): flush the map - always load from the map directory, and don't do unique items or the like.
  • 0x2 (MAP_PLAYER_UNIQUE) - this is a unique map for each player. dont do any more name translation on it.
Returns
pointer to the given map, NULL on failure.

Definition at line 935 of file plugin_common.cpp.

References CFAPI_PMAP, cfapiMap_get_map, flags, give::name, and is_valid_types_gen::type.

Referenced by ensure_map_in_memory(), readyMap(), and runteleport().

+ Here is the caller graph for this function:

◆ cf_map_get_map_property()

mapstruct* cf_map_get_map_property ( mapstruct map,
int  propcode 
)

Definition at line 279 of file plugin_common.cpp.

References CFAPI_PMAP, cfapiMap_get_property, disinfect::map, is_valid_types_gen::type, and autojail::value.

Referenced by cf_map_get_first(), and Map_Next().

+ Here is the caller graph for this function:

◆ cf_map_get_object_at()

object* cf_map_get_object_at ( mapstruct m,
int  x,
int  y 
)

Wrapper for GET_MAP_OB(). Gets the bottom object on a map. Not multitile aware.

Definition at line 655 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiMap_get_object_at, m, is_valid_types_gen::type, autojail::value, diamondslots::x, and diamondslots::y.

Referenced by Map_GetFirstObjectAt().

+ Here is the caller graph for this function:

◆ cf_map_get_players()

int cf_map_get_players ( mapstruct map)

Definition at line 1392 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_PLAYERS, and disinfect::map.

Referenced by Map_GetPlayers().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_region_property()

region* cf_map_get_region_property ( mapstruct map,
int  propcode 
)

Definition at line 288 of file plugin_common.cpp.

References CFAPI_PREGION, cfapiMap_get_property, disinfect::map, is_valid_types_gen::type, and autojail::value.

Referenced by eventListener(), and Map_GetRegion().

+ Here is the caller graph for this function:

◆ cf_map_get_reset_time()

int cf_map_get_reset_time ( mapstruct map)

Definition at line 1384 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_RESET_TIME, and disinfect::map.

Referenced by Map_GetResetTime().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_reset_timeout()

int cf_map_get_reset_timeout ( mapstruct map)

Definition at line 1388 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_RESET_TIMEOUT, and disinfect::map.

Referenced by Map_GetResetTimeout().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_get_sstring_property()

sstring cf_map_get_sstring_property ( mapstruct map,
int  propcode 
)

◆ cf_map_get_width()

int cf_map_get_width ( mapstruct map)

Definition at line 1400 of file plugin_common.cpp.

References cf_map_get_int_property(), CFAPI_MAP_PROP_WIDTH, and disinfect::map.

Referenced by find_by_name(), and Map_GetWidth().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_map_has_been_loaded()

mapstruct* cf_map_has_been_loaded ( const char *  name)

Wrapper for has_been_loaded(). Checks whether map has been loaded.

Parameters
namepath of the map to search. Can be NULL.
Returns
the mapstruct which has a name matching the given argument. return NULL if no match is found.

Definition at line 961 of file plugin_common.cpp.

References CFAPI_PMAP, cfapiMap_has_been_loaded, give::name, and is_valid_types_gen::type.

Referenced by getMapHasBeenLoaded().

+ Here is the caller graph for this function:

◆ cf_map_insert_object()

object* cf_map_insert_object ( mapstruct where,
object op,
int  x,
int  y 
)

Wrapper for object_insert_in_map_at().

Todo:
merge/replace with cf_object_change_map

Definition at line 1329 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_insert, give::op, is_valid_types_gen::type, autojail::value, python_pickup::where, diamondslots::x, and diamondslots::y.

Referenced by Map_CreateObject(), and Map_Insert().

+ Here is the caller graph for this function:

◆ cf_map_insert_object_around()

object* cf_map_insert_object_around ( mapstruct where,
object op,
int  x,
int  y 
)

Will insert op in the map where around the spot x, y. Combination of object_find_free_spot and object_insert_in_map_at.

Parameters
wheremap to insert into.
opwhat to insert.
x
ywhere to insert op.
Returns
NULL if op couldn't be inserted around the spot, else op or an object it merged with.

Definition at line 1351 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_insert, give::op, is_valid_types_gen::type, autojail::value, python_pickup::where, diamondslots::x, and diamondslots::y.

Referenced by Map_InsertAround().

+ Here is the caller graph for this function:

◆ cf_map_insert_object_there()

object* cf_map_insert_object_there ( object op,
mapstruct m,
object originator,
int  flag 
)

Wrapper for object_insert_in_map().

Definition at line 1315 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_insert, m, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by runghosted().

+ Here is the caller graph for this function:

◆ cf_map_message()

void cf_map_message ( mapstruct m,
const char *  msg,
int  color 
)

Partial wrapper for ext_info_map().

Todo:
add missing parameters.

Definition at line 667 of file plugin_common.cpp.

References cfapiMap_message, smoking_pipe::color, m, navar-midane_pickup::msg, and is_valid_types_gen::type.

Referenced by Map_Message(), and runmessage().

+ Here is the caller graph for this function:

◆ cf_map_set_int_property()

void cf_map_set_int_property ( mapstruct map,
int  propcode,
int  value 
)

◆ cf_map_set_string_property()

void cf_map_set_string_property ( mapstruct map,
int  propcode,
const char *  value 
)

Definition at line 305 of file plugin_common.cpp.

References CFAPI_STRING, cfapiMap_set_property, disinfect::map, is_valid_types_gen::type, and autojail::value.

Referenced by Map_SetPath().

+ Here is the caller graph for this function:

◆ cf_map_trigger_connected()

void cf_map_trigger_connected ( objectlink ol,
object cause,
int  state 
)

Wrapper for trigger_connected().

Definition at line 1028 of file plugin_common.cpp.

References CFAPI_NONE, cfapiMap_trigger_connected, dragon::state, and is_valid_types_gen::type.

Referenced by Map_TriggerConnected(), and runtrigger().

+ Here is the caller graph for this function:

◆ cf_object_apply()

int cf_object_apply ( object op,
object tmp,
int  aflag 
)

Wrapper for apply_manual(). Main apply handler.

Checks for unpaid items before applying.

Parameters
opobject causing tmp to be applied.
tmpobject being applied.
aflagspecial (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 542 of file plugin_common.cpp.

References cfapiObject_apply, give::op, Ice::tmp, and is_valid_types_gen::type.

Referenced by Crossfire_Object_Apply(), and runapplyobject().

+ Here is the caller graph for this function:

◆ cf_object_apply_below()

void cf_object_apply_below ( object pl)

Wrapper for apply_by_living_below(). 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
plplayer.

Definition at line 553 of file plugin_common.cpp.

References cfapiObject_apply_below, altar_valkyrie::pl, and is_valid_types_gen::type.

Referenced by runapply().

+ Here is the caller graph for this function:

◆ cf_object_cast_spell()

int cf_object_cast_spell ( object op,
object caster,
int  dir,
object spell_ob,
char *  stringarg 
)

Wrapper for cast_spell().

Definition at line 744 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_cast, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_Cast(), and Crossfire_Object_CastAbility().

+ Here is the caller graph for this function:

◆ cf_object_change_abil()

int cf_object_change_abil ( object op,
object tmp 
)

Wrapper for change_abil().

Definition at line 1671 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_change_abil, give::op, Ice::tmp, and is_valid_types_gen::type.

Referenced by Crossfire_Object_ChangeAbil().

+ Here is the caller graph for this function:

◆ cf_object_change_exp()

void cf_object_change_exp ( object op,
int64_t  exp,
const char *  skill_name,
int  flag 
)

Wrapper for change_exp().

Definition at line 504 of file plugin_common.cpp.

References CFAPI_NONE, cfapiObject_change_exp, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_AddExp().

+ Here is the caller graph for this function:

◆ cf_object_change_map()

object* cf_object_change_map ( object op,
mapstruct m,
object originator,
int  flag,
int  x,
int  y 
)

Wrapper for object_insert_in_map_at().

Definition at line 642 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_transfer, m, give::op, is_valid_types_gen::type, autojail::value, diamondslots::x, and diamondslots::y.

Referenced by Object_SetMap().

+ Here is the caller graph for this function:

◆ cf_object_check_for_spell()

object* cf_object_check_for_spell ( object op,
const char *  name 
)

Wrapper for check_spell_known(). Checks to see if player knows the spell. If the name is the same as an existing spell, we presume they know it.

Parameters
opobject we're looking into.
namespell name. Doesn't need to be a shared string.
Returns
1 if op knows the spell, 0 if it don't.

Definition at line 778 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_check_spell, give::name, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_KnowSpell().

+ Here is the caller graph for this function:

◆ cf_object_check_trigger()

int cf_object_check_trigger ( object op,
object cause 
)

Wrapper for check_trigger().

Definition at line 1016 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_check_trigger, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_CheckTrigger().

+ Here is the caller graph for this function:

◆ cf_object_clone()

object * cf_object_clone ( object op,
int  clonetype 
)

Clone an object.

Parameters
opwhat to clone.
clonetype
Returns
clone.

Definition at line 683 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_clone, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_Clone(), and runghosted().

+ Here is the caller graph for this function:

◆ cf_object_drop()

void cf_object_drop ( object op,
object author 
)

Definition at line 1043 of file plugin_common.cpp.

References board::author, cfapiObject_drop, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_Drop(), and rundropobject().

+ Here is the caller graph for this function:

◆ cf_object_find_by_arch_name()

object* cf_object_find_by_arch_name ( const object who,
const char *  name 
)

Wrapper for object_find_by_arch_name(). Find object in inventory by archetype name.

Parameters
whowhere to search.
namewhat to search.
Returns
first object in who's inventory that has the archetype name match. NULL if no match.
Note
will not search in inventory of items in inventory.

Definition at line 592 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_find_by_arch_name, give::name, rotate-tower::result, is_valid_types_gen::type, and autojail::who.

Referenced by Crossfire_Object_CheckArchInventory().

+ Here is the caller graph for this function:

◆ cf_object_find_by_name()

object* cf_object_find_by_name ( const object who,
const char *  name 
)

Wrapper for object_find_by_name(). Finds an object in inventory name.

Parameters
whothe object to search
namename to search for
Returns
the first object which has a name equal to the argument, NULL if none found.

Definition at line 605 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_find_by_name, give::name, rotate-tower::result, is_valid_types_gen::type, and autojail::who.

Referenced by runapplyobject(), and rundropobject().

+ Here is the caller graph for this function:

◆ cf_object_forget_spell()

void cf_object_forget_spell ( object op,
object sp 
)

Wrapper for do_forget_spell(), except takes an object, not a string.

Todo:
make coherent with do_forget_spell() (string instead of ob).

Definition at line 768 of file plugin_common.cpp.

References cfapiObject_forget_spell, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_ForgetSpell().

+ Here is the caller graph for this function:

◆ cf_object_free_drop_inventory()

void cf_object_free_drop_inventory ( object ob)

Wrapper for object_free_drop_inventory(). Frees everything allocated by an object, removes it from the list of used objects, and puts it on the list of free objects. The IS_FREED() flag is set in the object. The object must have been removed by object_remove() first for this function to succeed.

Inventory will be dropped on the ground if in a map, else freed too.

Parameters
obobject to free. Will become invalid when function returns.

Definition at line 571 of file plugin_common.cpp.

References cfapiObject_delete, guildjoin::ob, and is_valid_types_gen::type.

Referenced by Crossfire_Object_Remove(), and runghosted().

+ Here is the caller graph for this function:

◆ cf_object_get_archetype_property()

archetype* cf_object_get_archetype_property ( object op,
int  propcode 
)

Definition at line 416 of file plugin_common.cpp.

References CFAPI_PARCH, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetArchetype(), and Object_GetOtherArchetype().

+ Here is the caller graph for this function:

◆ cf_object_get_double_property()

double cf_object_get_double_property ( object op,
int  propcode 
)

Definition at line 432 of file plugin_common.cpp.

References CFAPI_DOUBLE, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetExpMul().

+ Here is the caller graph for this function:

◆ cf_object_get_flag()

int cf_object_get_flag ( object ob,
int  flag 
)

◆ cf_object_get_float_property()

float cf_object_get_float_property ( object op,
int  propcode 
)

Definition at line 408 of file plugin_common.cpp.

References CFAPI_FLOAT, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetFloatProperty().

+ Here is the caller graph for this function:

◆ cf_object_get_int64_property()

int64_t cf_object_get_int64_property ( object op,
int  propcode 
)

Definition at line 381 of file plugin_common.cpp.

References CFAPI_SINT64, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetExp(), and Object_GetTotalExp().

+ Here is the caller graph for this function:

◆ cf_object_get_int_property()

int cf_object_get_int_property ( object op,
int  propcode 
)

Definition at line 335 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetIntProperty(), Object_GetMaterial(), Player_GetBedX(), and Player_GetBedY().

+ Here is the caller graph for this function:

◆ cf_object_get_key()

const char* cf_object_get_key ( object op,
const char *  keyname 
)

Gets value for specified key, equivalent of object_get_value().

Parameters
opobject for which we search a key.
keynamekey to look for. Not required to be a shared string.
Returns
value (shared string), or NULL if not found.

Definition at line 1637 of file plugin_common.cpp.

References CFAPI_SSTRING, cfapiObject_get_key, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_ReadKey().

+ Here is the caller graph for this function:

◆ cf_object_get_long_property()

long cf_object_get_long_property ( object op,
long  propcode 
)

Definition at line 342 of file plugin_common.cpp.

References CFAPI_LONG, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetValue().

+ Here is the caller graph for this function:

◆ cf_object_get_map_property()

mapstruct* cf_object_get_map_property ( object op,
int  propcode 
)

Definition at line 373 of file plugin_common.cpp.

References CFAPI_PMAP, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetMap().

+ Here is the caller graph for this function:

◆ cf_object_get_movetype_property()

MoveType cf_object_get_movetype_property ( object op,
int  propcode 
)

◆ cf_object_get_msg()

const char* cf_object_get_msg ( object )

◆ cf_object_get_nrof()

int cf_object_get_nrof ( object )

◆ cf_object_get_object_property()

object* cf_object_get_object_property ( object op,
int  propcode 
)

Definition at line 365 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by add_death(), Object_GetObjectProperty(), and Player_GetObjectProperty().

+ Here is the caller graph for this function:

◆ cf_object_get_partylist_property()

partylist* cf_object_get_partylist_property ( object op,
int  propcode 
)

Definition at line 424 of file plugin_common.cpp.

References CFAPI_PPARTY, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by cf_player_get_party().

+ Here is the caller graph for this function:

◆ cf_object_get_resistance()

int16_t cf_object_get_resistance ( object op,
int  rtype 
)

Definition at line 313 of file plugin_common.cpp.

References CFAPI_INT16, CFAPI_OBJECT_PROP_RESIST, cfapiObject_get_property, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_GetResist().

+ Here is the caller graph for this function:

◆ cf_object_get_sstring_property()

sstring cf_object_get_sstring_property ( object op,
int  propcode 
)

Definition at line 440 of file plugin_common.cpp.

References CFAPI_SSTRING, cfapiObject_get_property, give::op, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetMaterial(), and Object_GetSStringProperty().

+ Here is the caller graph for this function:

◆ cf_object_get_string_property()

char* cf_object_get_string_property ( object op,
int  propcode,
char *  buf,
int  size 
)

Definition at line 448 of file plugin_common.cpp.

References buf, CFAPI_STRING, cfapiObject_get_property, give::op, and is_valid_types_gen::type.

Referenced by Player_GetBedMap().

+ Here is the caller graph for this function:

◆ cf_object_get_weight()

int cf_object_get_weight ( object ob)

◆ cf_object_get_weight_limit()

int cf_object_get_weight_limit ( object ob)

◆ cf_object_insert_in_ob()

object* cf_object_insert_in_ob ( object op,
object where 
)

Wrapper for object_insert_in_ob().

Definition at line 1298 of file plugin_common.cpp.

References cf_object_get_flag(), CFAPI_POBJECT, cfapiObject_insert, cfapiObject_remove, FLAG_REMOVED, give::op, is_valid_types_gen::type, autojail::value, and python_pickup::where.

Referenced by Crossfire_Object_InsertInto().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_object_insert_object()

object* cf_object_insert_object ( object op,
object container 
)

Definition at line 1056 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_insert, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_CreateInside(), and eventListener().

+ Here is the caller graph for this function:

◆ cf_object_learn_spell()

void cf_object_learn_spell ( object op,
object spell,
int  special_prayer 
)

Wrapper for do_learn_spell().

Definition at line 756 of file plugin_common.cpp.

References CFAPI_NONE, cfapiObject_learn_spell, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_LearnSpell().

+ Here is the caller graph for this function:

◆ cf_object_move()

int cf_object_move ( object op,
int  dir,
object originator 
)

Definition at line 531 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_move, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_Move(), and runmovement().

+ Here is the caller graph for this function:

◆ cf_object_move_to()

int cf_object_move_to ( object op,
int  x,
int  y 
)

Wrapper for move_to(). Move an object one square toward a specified destination on the same map. The move takes into account blocked squares for op, and things like that. No check is done to know if the object has enough speed to move.

Parameters
opobject to move
x
ydestination coordinates
Returns
0 if op is on the specified spot, 1 if it moved towards the goal, 2 if it didn't find any path to the goal.

Definition at line 630 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_transfer, give::op, is_valid_types_gen::type, autojail::value, diamondslots::x, and diamondslots::y.

Referenced by Crossfire_Object_MoveTo(), and runmoveto().

+ Here is the caller graph for this function:

◆ cf_object_out_of_map()

int cf_object_out_of_map ( object op,
int  x,
int  y 
)

Definition at line 1035 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_out_of_map, give::op, is_valid_types_gen::type, autojail::value, diamondslots::x, and diamondslots::y.

Referenced by Crossfire_Object_GetOutOfMap().

+ Here is the caller graph for this function:

◆ cf_object_pay_amount()

int cf_object_pay_amount ( object pl,
uint64_t  to_pay 
)

Wrapper for pay_for_amount().

Definition at line 732 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_pay_amount, altar_valkyrie::pl, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_PayAmount().

+ Here is the caller graph for this function:

◆ cf_object_pay_item()

int cf_object_pay_item ( object op,
object pl 
)

Wrapper for pay_for_item().

Definition at line 720 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_pay_item, give::op, altar_valkyrie::pl, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_Pay().

+ Here is the caller graph for this function:

◆ cf_object_perm_exp()

int64_t cf_object_perm_exp ( object op)

Wrapper for PERM_EXP macro.

Returns
The amount of total experience that is permanent experience

Definition at line 515 of file plugin_common.cpp.

References CFAPI_SINT64, cfapiObject_perm_exp, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_PermExp().

+ Here is the caller graph for this function:

◆ cf_object_pickup()

void cf_object_pickup ( object op,
object what 
)

Definition at line 1434 of file plugin_common.cpp.

References CFAPI_NONE, cfapiObject_pickup, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Object_Take(), runpickup(), and runpickupobject().

+ Here is the caller graph for this function:

◆ cf_object_present_archname_inside()

object* cf_object_present_archname_inside ( object op,
char *  whatstr 
)

Kinda wrapper for arch_present_in_ob().

Definition at line 579 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_find_archetype_inside, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_CheckInventory().

+ Here is the caller graph for this function:

◆ cf_object_query_cost()

int cf_object_query_cost ( const object tmp,
object who,
int  flag 
)

◆ cf_object_query_cost_string()

void cf_object_query_cost_string ( const object tmp,
object who,
int  flag,
char *  buffer,
int  length 
)

◆ cf_object_query_money()

int cf_object_query_money ( const object op)

Wrapper for query_money().

Definition at line 983 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_query_money, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetMoney().

+ Here is the caller graph for this function:

◆ cf_object_remove()

void cf_object_remove ( object op)

Wrapper for object_remove(). This function removes the object op from the linked list of objects which it is currently tied to. When this function is done, the object will have no environment. If the object previously had an environment, the x and y coordinates will be updated to the previous environment.

Will inform the client of the removal if needed.

Parameters
opobject to remove. Must not be removed yet, else abort() is called.
Todo:
this function is a piece of overbloated crap or at lest look like need cleanup it does to much different things.

Definition at line 562 of file plugin_common.cpp.

References cfapiObject_remove, give::op, and is_valid_types_gen::type.

Referenced by animate(), Crossfire_Object_InsertInto(), Crossfire_Object_Remove(), runghosted(), and start_animation().

+ Here is the caller graph for this function:

◆ cf_object_remove_depletion()

int cf_object_remove_depletion ( object op,
int  level 
)

Wrapper for remove_depletion(). Remove depletion from op, if present, and warn player of such restorations.

Parameters
opwho to remove depletion from.
levelmaximum depletion level to remove, if -1 no maximum.
Returns
0 if no depletion (or with no drained statistics) was present or level was insufficient, 1 if something was removed.

Definition at line 798 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_remove_depletion, give::op, rotate-tower::result, and is_valid_types_gen::type.

Referenced by Crossfire_Object_RemoveDepletion().

+ Here is the caller graph for this function:

◆ cf_object_say()

void cf_object_say ( object op,
const char *  msg 
)

Definition at line 1049 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_say, navar-midane_pickup::msg, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_Say(), and runsay().

+ Here is the caller graph for this function:

◆ cf_object_set_animation()

int cf_object_set_animation ( object op,
const char *  animation 
)

Set the object's animation.

Parameters
opwho to change the animation for.
animationanimation's name to set.
Returns
0 if invalid animation, non zero is set.

Definition at line 486 of file plugin_common.cpp.

References CFAPI_INT, CFAPI_OBJECT_PROP_ANIMATION, cfapiObject_set_property, give::op, and is_valid_types_gen::type.

Referenced by Object_SetAnim().

+ Here is the caller graph for this function:

◆ cf_object_set_face()

int cf_object_set_face ( object op,
const char *  face 
)

Set the object's face.

Parameters
opwho to change the face for.
faceface to set.
Returns
0 if invalid face, non zero is set.

Definition at line 474 of file plugin_common.cpp.

References CFAPI_INT, CFAPI_OBJECT_PROP_FACE, cfapiObject_set_property, give::op, and is_valid_types_gen::type.

Referenced by Object_SetFace().

+ Here is the caller graph for this function:

◆ cf_object_set_flag()

void cf_object_set_flag ( object ob,
int  flag,
int  value 
)

Definition at line 1288 of file plugin_common.cpp.

References CFAPI_OBJECT_PROP_FLAGS, cfapiObject_set_property, guildjoin::ob, is_valid_types_gen::type, and autojail::value.

Referenced by animate_one(), Object_SetFlagProperty(), and Object_SetPickable().

+ Here is the caller graph for this function:

◆ cf_object_set_float_property()

void cf_object_set_float_property ( object op,
int  propcode,
float  value 
)

Definition at line 396 of file plugin_common.cpp.

References CFAPI_FLOAT, cfapiObject_set_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_SetFloatProperty().

+ Here is the caller graph for this function:

◆ cf_object_set_int64_property()

void cf_object_set_int64_property ( object op,
int  propcode,
int64_t  value 
)

Definition at line 402 of file plugin_common.cpp.

References CFAPI_SINT64, cfapiObject_set_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_SetExp().

+ Here is the caller graph for this function:

◆ cf_object_set_int_property()

void cf_object_set_int_property ( object op,
int  propcode,
int  value 
)

Definition at line 329 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_set_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_SetIntProperty(), Player_SetBedX(), and Player_SetBedY().

+ Here is the caller graph for this function:

◆ cf_object_set_key()

int cf_object_set_key ( object op,
const char *  keyname,
const char *  value,
int  add_key 
)

Sets a value for specified key, equivalent to object_set_value().

Parameters
opobject which will contain the key/value
keynamekey
valuevalue
add_keyif 0, key is only updated if it exists, else it's updated or added.
Returns
TRUE or FALSE.

Definition at line 1659 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_set_key, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_WriteKey().

+ Here is the caller graph for this function:

◆ cf_object_set_long_property()

void cf_object_set_long_property ( object op,
int  propcode,
long  value 
)

Definition at line 390 of file plugin_common.cpp.

References CFAPI_LONG, cfapiObject_set_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_SetValue().

+ Here is the caller graph for this function:

◆ cf_object_set_movetype_property()

void cf_object_set_movetype_property ( object op,
int  propcode,
MoveType  value 
)

◆ cf_object_set_nrof()

int cf_object_set_nrof ( object ob,
int  nrof 
)
Returns
-1=nrof is invalid, 0=nrof is ok#

Definition at line 1260 of file plugin_common.cpp.

References CFAPI_OBJECT_PROP_NROF, cfapiObject_set_property, guildjoin::ob, and is_valid_types_gen::type.

Referenced by Object_SetQuantity().

+ Here is the caller graph for this function:

◆ cf_object_set_object_property()

void cf_object_set_object_property ( object op,
int  propcode,
object value 
)

Definition at line 493 of file plugin_common.cpp.

References CFAPI_POBJECT, cfapiObject_set_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Object_SetEnemy(), and Object_SetOwner().

+ Here is the caller graph for this function:

◆ cf_object_set_resistance()

void cf_object_set_resistance ( object op,
int  rtype,
int16_t  value 
)

Definition at line 321 of file plugin_common.cpp.

References CFAPI_INT16, CFAPI_OBJECT_PROP_RESIST, cfapiObject_set_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_SetResist().

+ Here is the caller graph for this function:

◆ cf_object_set_string_property()

void cf_object_set_string_property ( object op,
int  propcode,
const char *  value 
)

◆ cf_object_set_weight()

void cf_object_set_weight ( object ob,
int  weight 
)

◆ cf_object_set_weight_limit()

void cf_object_set_weight_limit ( object ob,
int  weight 
)

◆ cf_object_split()

object* cf_object_split ( object orig_ob,
uint32_t  nr,
char *  err,
size_t  size 
)

Wrapper for object_split().

Definition at line 697 of file plugin_common.cpp.

References CFAPI_NONE, CFAPI_POBJECT, cfapiObject_split, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_Split().

+ Here is the caller graph for this function:

◆ cf_object_teleport()

int cf_object_teleport ( object ob,
mapstruct map,
int  x,
int  y 
)

Definition at line 1360 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_teleport, disinfect::map, give::op, is_valid_types_gen::type, autojail::value, diamondslots::x, and diamondslots::y.

Referenced by Crossfire_Object_Teleport(), and runteleport().

+ Here is the caller graph for this function:

◆ cf_object_transfer()

int cf_object_transfer ( object op,
int  x,
int  y,
int  randomly,
object originator 
)

Wrapper for transfer_ob(). Move an object (even linked objects) to another spot on the same map.

Does nothing if there is no free spot.

Parameters
opwhat to move.
x
ynew coordinates.
randomlyif true, use object_find_free_spot() to find the destination, otherwise use object_find_first_free_spot().
originatorwhat is causing op to move.
Return values
1op was destroyed.
0op was moved.

Definition at line 618 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_transfer, give::op, is_valid_types_gen::type, autojail::value, diamondslots::x, and diamondslots::y.

Referenced by Crossfire_Object_Reposition().

+ Here is the caller graph for this function:

◆ cf_object_update()

void cf_object_update ( object op,
int  flags 
)

Definition at line 1428 of file plugin_common.cpp.

References cfapiObject_update, flags, give::op, and is_valid_types_gen::type.

Referenced by animate_one().

+ Here is the caller graph for this function:

◆ cf_object_user_event()

int cf_object_user_event ( object op,
object activator,
object third,
const char *  message,
int  fix 
)

Definition at line 262 of file plugin_common.cpp.

References diamondslots::activator, CFAPI_INT, cfapiObject_user_event, diamondslots::message, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Object_Event().

+ Here is the caller graph for this function:

◆ cf_party_get_first()

partylist* cf_party_get_first ( void  )

Get first party.

Returns
first party in partylist.

Definition at line 1783 of file plugin_common.cpp.

References CFAPI_PARTY_PROP_NEXT, CFAPI_PPARTY, cfapiParty_get_property, is_valid_types_gen::type, and autojail::value.

◆ cf_party_get_first_player()

player* cf_party_get_first_player ( partylist party)

Get first player in party.

Parameters
partyparty, mustn't be NULL.
Returns
party's first player.

Definition at line 1846 of file plugin_common.cpp.

References CFAPI_PARTY_PROP_PLAYER, CFAPI_PPLAYER, cfapiParty_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Party_GetPlayers().

+ Here is the caller graph for this function:

◆ cf_party_get_name()

const char* cf_party_get_name ( partylist party)
Parameters
partyparty, mustn't be NULL.
Returns
party's name.

Definition at line 1798 of file plugin_common.cpp.

References CFAPI_PARTY_PROP_NAME, CFAPI_SSTRING, cfapiParty_get_property, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Party_GetName().

+ Here is the caller graph for this function:

◆ cf_party_get_next()

partylist* cf_party_get_next ( partylist party)

Get next party in party list.

Parameters
partyparty, can be NULL in which case behaves like cf_party_get_first().
Returns
party's next field.

Definition at line 1814 of file plugin_common.cpp.

References CFAPI_PARTY_PROP_NEXT, CFAPI_PPARTY, cfapiParty_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Party_GetNext().

+ Here is the caller graph for this function:

◆ cf_party_get_next_player()

player* cf_party_get_next_player ( partylist party,
player op 
)

Get next player in party.

Parameters
partyparty, mustn't be NULL.
opplayer we want the next of. Can be NULL, in this case behaves like cf_party_get_first_player().
Returns
party's name.

Definition at line 1864 of file plugin_common.cpp.

References CFAPI_PARTY_PROP_PLAYER, CFAPI_PPLAYER, cfapiParty_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Party_GetPlayers().

+ Here is the caller graph for this function:

◆ cf_party_get_password()

const char* cf_party_get_password ( partylist party)

Get party's password.

Parameters
partyparty, mustn't be NULL.
Returns
party's password field.

Definition at line 1830 of file plugin_common.cpp.

References CFAPI_PARTY_PROP_PASSWORD, CFAPI_SSTRING, cfapiParty_get_property, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Party_GetPassword().

+ Here is the caller graph for this function:

◆ cf_player_arrest()

int cf_player_arrest ( object who)

Wrapper for player_arrest(). Put a player into jail, taking into account cursed exits and player's region.

Parameters
whoplayer to put in jail
Return values
0player was moved to jail.
-1no jail found.
-2couldn't move to jail (map loading error, or already at jail's position).
-3op isn't a player.

Definition at line 924 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_move, is_valid_types_gen::type, autojail::value, and autojail::who.

Referenced by Crossfire_Object_Arrest().

+ Here is the caller graph for this function:

◆ cf_player_can_pay()

int cf_player_can_pay ( object pl)

Wrapper for can_pay().

Definition at line 886 of file plugin_common.cpp.

References CFAPI_INT, cfapiPlayer_can_pay, altar_valkyrie::pl, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Player_CanPay().

+ Here is the caller graph for this function:

◆ cf_player_find()

player* cf_player_find ( const char *  plname)

Wrapper for find_player_partial_name().

Definition at line 825 of file plugin_common.cpp.

References CFAPI_PPLAYER, cfapiPlayer_find, is_valid_types_gen::type, and autojail::value.

Referenced by findPlayer().

+ Here is the caller graph for this function:

◆ cf_player_get_ip()

sstring cf_player_get_ip ( object op)

Definition at line 848 of file plugin_common.cpp.

References CFAPI_PLAYER_PROP_IP, CFAPI_SSTRING, cfapiObject_get_property, give::op, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Player_GetIP().

+ Here is the caller graph for this function:

◆ cf_player_get_marked_item()

object* cf_player_get_marked_item ( object op)

Definition at line 857 of file plugin_common.cpp.

References CFAPI_PLAYER_PROP_MARKED_ITEM, CFAPI_POBJECT, cfapiObject_get_property, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Player_GetMarkedItem().

+ Here is the caller graph for this function:

◆ cf_player_get_party()

partylist* cf_player_get_party ( object op)

Definition at line 872 of file plugin_common.cpp.

References cf_object_get_partylist_property(), CFAPI_PLAYER_PROP_PARTY, and give::op.

Referenced by Player_GetParty().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cf_player_get_title()

char* cf_player_get_title ( object op,
char *  title,
int  size 
)

Definition at line 834 of file plugin_common.cpp.

References CFAPI_PLAYER_PROP_TITLE, CFAPI_STRING, cfapiObject_get_property, give::op, and is_valid_types_gen::type.

Referenced by Player_GetTitle().

+ Here is the caller graph for this function:

◆ cf_player_knowledge_give()

void cf_player_knowledge_give ( object op,
const char *  knowledge 
)

Wrapper for knowledge_give();

Parameters
opwho to give knowledge to.
knowledgeknowledge to give, internal value.

Definition at line 913 of file plugin_common.cpp.

References CFAPI_NONE, cfapiPlayer_knowledge, giveknowledge::knowledge, give::op, and is_valid_types_gen::type.

Referenced by Player_GiveKnowledge().

+ Here is the caller graph for this function:

◆ cf_player_knowledge_has()

int cf_player_knowledge_has ( object op,
const char *  knowledge 
)

Wrapper for knowledge_player_has().

Parameters
opwho to check knowledge for.
knowledgewhat to check for.
Returns
0 if op is not a player or knowledge is not known, 1 else.

Definition at line 900 of file plugin_common.cpp.

References CFAPI_INT, cfapiPlayer_knowledge, giveknowledge::knowledge, give::op, is_valid_types_gen::type, and autojail::value.

Referenced by Player_KnowledgeKnown().

+ Here is the caller graph for this function:

◆ cf_player_message()

void cf_player_message ( object op,
const char *  txt,
int  flags 
)

Definition at line 787 of file plugin_common.cpp.

References CFAPI_NONE, cfapiPlayer_message, flags, give::op, and is_valid_types_gen::type.

Referenced by Crossfire_Player_Message(), and runnotice().

+ Here is the caller graph for this function:

◆ cf_player_move()

int cf_player_move ( player pl,
int  dir 
)

Definition at line 524 of file plugin_common.cpp.

References CFAPI_INT, cfapiObject_move, altar_valkyrie::pl, and is_valid_types_gen::type.

Referenced by runghosted(), and runmovement().

+ Here is the caller graph for this function:

◆ cf_player_set_marked_item()

void cf_player_set_marked_item ( object op,
object ob 
)

Definition at line 866 of file plugin_common.cpp.

References CFAPI_PLAYER_PROP_MARKED_ITEM, cfapiObject_set_property, guildjoin::ob, give::op, and is_valid_types_gen::type.

Referenced by Player_SetMarkedItem().

+ Here is the caller graph for this function:

◆ cf_player_set_party()

void cf_player_set_party ( object op,
partylist party 
)

Definition at line 876 of file plugin_common.cpp.

References CFAPI_PLAYER_PROP_PARTY, cfapiObject_set_property, give::op, and is_valid_types_gen::type.

Referenced by Player_SetParty().

+ Here is the caller graph for this function:

◆ cf_player_set_title()

void cf_player_set_title ( object op,
const char *  title 
)

Definition at line 842 of file plugin_common.cpp.

References CFAPI_PLAYER_PROP_TITLE, cfapiObject_set_property, give::op, and is_valid_types_gen::type.

Referenced by Player_SetTitle().

+ Here is the caller graph for this function:

◆ cf_query_name()

char* cf_query_name ( object ob,
char *  name,
int  size 
)

Definition at line 1201 of file plugin_common.cpp.

References CFAPI_OBJECT_PROP_NAME, CFAPI_STRING, cfapiObject_get_property, give::name, guildjoin::ob, and is_valid_types_gen::type.

Referenced by Crossfire_Object_QueryName(), and Object_GetName().

+ Here is the caller graph for this function:

◆ cf_query_name_pl()

sstring cf_query_name_pl ( object ob)

Definition at line 1209 of file plugin_common.cpp.

References CFAPI_OBJECT_PROP_NAME_PLURAL, CFAPI_SSTRING, cfapiObject_get_property, guildjoin::ob, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Object_GetNamePl().

+ Here is the caller graph for this function:

◆ cf_quest_get_player_state()

int cf_quest_get_player_state ( object pl,
sstring  quest_code 
)

Wrapper for quest_get_player_state(). Get the quest state for a player.

Parameters
plplayer.
quest_codeinternal quest code.
Returns
QC_COMPLETED if finished and quest can't be replayed, 0 if not started or finished and can be replayed, else quest-specific value.

Definition at line 2051 of file plugin_common.cpp.

References CFAPI_INT, CFAPI_PLAYER_QUEST_GET_STATE, cfapiPlayer_quest, altar_valkyrie::pl, and is_valid_types_gen::type.

Referenced by Player_QuestGetState().

+ Here is the caller graph for this function:

◆ cf_quest_set_player_state()

void cf_quest_set_player_state ( object pl,
sstring  quest_code,
int  state 
)

Wrapper for quest_set_player_state(); Set the state of a quest for a player.

Parameters
plplayer to set the state for.
quest_codequest internal code.
statenew state for the quest, must be greater than 0 else forced to 100 and a warning is emitted.

Definition at line 2075 of file plugin_common.cpp.

References CFAPI_NONE, CFAPI_PLAYER_QUEST_SET_STATE, cfapiPlayer_quest, altar_valkyrie::pl, dragon::state, and is_valid_types_gen::type.

Referenced by Player_QuestSetState().

+ Here is the caller graph for this function:

◆ cf_quest_start()

void cf_quest_start ( object pl,
sstring  quest_code,
int  state 
)

Wrapper for quest_start(). Start a quest for a player. Will notify the player.

Parameters
plplayer.
quest_codeinternal quest code.
stateinitial quest state, must be greater than 0 else forced to 100 and warning emitted.

Definition at line 2064 of file plugin_common.cpp.

References CFAPI_NONE, CFAPI_PLAYER_QUEST_START, cfapiPlayer_quest, altar_valkyrie::pl, dragon::state, and is_valid_types_gen::type.

Referenced by Player_QuestStart().

+ Here is the caller graph for this function:

◆ cf_quest_was_completed()

int cf_quest_was_completed ( object pl,
sstring  quest_code 
)

Wrapper for quest_was_completed(). Check if a quest was completed once for a player, without taking account the current state.

Parameters
plwho to check for.
quest_codequest internal code.
Returns
1 if the quest was already completed at least once, 0 else.

Definition at line 2086 of file plugin_common.cpp.

References CFAPI_INT, CFAPI_PLAYER_QUEST_WAS_COMPLETED, cfapiPlayer_quest, altar_valkyrie::pl, and is_valid_types_gen::type.

Referenced by Player_QuestWasCompleted().

+ Here is the caller graph for this function:

◆ cf_random_map_generate()

mapstruct* cf_random_map_generate ( const char *  OutFileName,
RMParms RP,
char **  use_layout,
sstring  reset_group 
)

Wrapper for generate_random_map(). Main random map routine. Generates a random map based on specified parameters.

Parameters
OutFileNamethe path the map should have.
RPparameters for generation.
use_layoutif not NULL, this should be a suitable layout.
reset_groupif not NULL, the reset group this map will be part of, else the path will be used.
Returns
Crossfire map, which should be free()d by caller.

Definition at line 1485 of file plugin_common.cpp.

References CFAPI_PMAP, cfapiGenerate_random_map, disinfect::map, and is_valid_types_gen::type.

◆ cf_random_map_set_variable()

int cf_random_map_set_variable ( RMParms rp,
const char *  buf 
)

◆ cf_re_cmp()

const char* cf_re_cmp ( const char *  str,
const char *  regexp 
)

Wrapper for re_cmp(). re-cmp - get regular expression match.

Parameters
strstring that will be matched against the regexp.
regexpregular expression.
Returns
  • no match or error in regexp.
  • pointer to beginning of matching string

Definition at line 1143 of file plugin_common.cpp.

References CFAPI_STRING, cfapiSystem_re_cmp, rotate-tower::result, make_face_from_files::str, and is_valid_types_gen::type.

Referenced by matchString().

+ Here is the caller graph for this function:

◆ cf_region_get_first()

region* cf_region_get_first ( void  )

Get first region in region list.

Returns
first region.

Definition at line 1878 of file plugin_common.cpp.

References CFAPI_PREGION, CFAPI_REGION_PROP_NEXT, cfapiRegion_get_property, is_valid_types_gen::type, and autojail::value.

◆ cf_region_get_jail_path()

const char* cf_region_get_jail_path ( region reg)

Get jail path of region.

Parameters
regregion. Mustn't be NULL.
Returns
region's jail path, can be NULL.

Definition at line 2004 of file plugin_common.cpp.

References CFAPI_REGION_PROP_JAIL_PATH, CFAPI_SSTRING, cfapiRegion_get_property, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetJailPath().

+ Here is the caller graph for this function:

◆ cf_region_get_jail_x()

int cf_region_get_jail_x ( region reg)

Get region's jail x coordinate.

Parameters
regregion. Mustn't be NULL.
Returns
region's x coordinate for jail.

Definition at line 1974 of file plugin_common.cpp.

References CFAPI_INT, CFAPI_REGION_PROP_JAIL_X, cfapiRegion_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetJailX().

+ Here is the caller graph for this function:

◆ cf_region_get_jail_y()

int cf_region_get_jail_y ( region reg)

Get region's jail y coordinate.

Parameters
regregion. Mustn't be NULL.
Returns
region's y coordinate for jail.

Definition at line 1989 of file plugin_common.cpp.

References CFAPI_INT, CFAPI_REGION_PROP_JAIL_Y, cfapiRegion_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetJailY().

+ Here is the caller graph for this function:

◆ cf_region_get_longname()

const char* cf_region_get_longname ( region reg)

Get longname of region.

Parameters
regregion. Mustn't be NULL.
Returns
region's longname.

Definition at line 1942 of file plugin_common.cpp.

References CFAPI_REGION_PROP_LONGNAME, CFAPI_SSTRING, cfapiRegion_get_property, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetLongname().

+ Here is the caller graph for this function:

◆ cf_region_get_message()

const char* cf_region_get_message ( region reg)

Get message of region.

Parameters
regregion. Mustn't be NULL.
Returns
region's message.

Definition at line 1958 of file plugin_common.cpp.

References CFAPI_REGION_PROP_MESSAGE, CFAPI_SSTRING, cfapiRegion_get_property, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetMessage().

+ Here is the caller graph for this function:

◆ cf_region_get_name()

const char* cf_region_get_name ( region reg)

Get name of region.

Parameters
regregion. Mustn't be NULL.
Returns
region's name.

Definition at line 1894 of file plugin_common.cpp.

References CFAPI_REGION_PROP_NAME, CFAPI_SSTRING, cfapiRegion_get_property, sstring, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetName().

+ Here is the caller graph for this function:

◆ cf_region_get_next()

region* cf_region_get_next ( region reg)

Get next region in region list.

Parameters
regregion. Can be NULL in which case equivalent of cf_region_get_first().
Returns
next region.

Definition at line 1910 of file plugin_common.cpp.

References CFAPI_PREGION, CFAPI_REGION_PROP_NEXT, cfapiRegion_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetNext().

+ Here is the caller graph for this function:

◆ cf_region_get_parent()

region* cf_region_get_parent ( region reg)

Get parent of region.

Parameters
regregion. Mustn't be NULL.
Returns
region's parent.

Definition at line 1926 of file plugin_common.cpp.

References CFAPI_PREGION, CFAPI_REGION_PROP_PARENT, cfapiRegion_get_property, is_valid_types_gen::type, and autojail::value.

Referenced by Crossfire_Region_GetParent().

+ Here is the caller graph for this function:

◆ cf_spring_trap()

void cf_spring_trap ( object trap,
object victim 
)

Wrapper for spring_trap().

Definition at line 1005 of file plugin_common.cpp.

References cfapiObject_activate_rune, is_valid_types_gen::type, and sword_of_souls::victim.

Referenced by Crossfire_Object_ActivateRune().

+ Here is the caller graph for this function:

◆ cf_strdup_local()

char* cf_strdup_local ( const char *  str)

Wrapper for strdup_local().

Definition at line 1446 of file plugin_common.cpp.

References CFAPI_STRING, cfapiSystem_strdup_local, make_face_from_files::str, and is_valid_types_gen::type.

Referenced by initnotice(), initsay(), initteleport(), and start_animation().

+ Here is the caller graph for this function:

◆ cf_system_get_archetype_vector()

void cf_system_get_archetype_vector ( int  property,
std::vector< archetype * > *  list 
)

Definition at line 2128 of file plugin_common.cpp.

References CFAPI_ARCHETYPE_VECTOR, cfapiSystem_get_archetype_vector, guildoracle::list, and is_valid_types_gen::type.

Referenced by getArchetypes().

+ Here is the caller graph for this function:

◆ cf_system_get_map_vector()

void cf_system_get_map_vector ( int  property,
std::vector< mapstruct * > *  list 
)

Definition at line 2122 of file plugin_common.cpp.

References CFAPI_MAP_VECTOR, cfapiSystem_get_map_vector, guildoracle::list, and is_valid_types_gen::type.

Referenced by getMaps().

+ Here is the caller graph for this function:

◆ cf_system_get_object_vector()

void cf_system_get_object_vector ( int  property,
std::vector< object * > *  list 
)

Definition at line 2116 of file plugin_common.cpp.

References CFAPI_OBJECT_VECTOR, cfapiSystem_get_object_vector, guildoracle::list, and is_valid_types_gen::type.

Referenced by getFriendlyList(), and getPlayers().

+ Here is the caller graph for this function:

◆ cf_system_get_party_vector()

void cf_system_get_party_vector ( int  property,
std::vector< partylist * > *  list 
)

Definition at line 2134 of file plugin_common.cpp.

References CFAPI_PARTY_VECTOR, cfapiSystem_get_party_vector, guildoracle::list, and is_valid_types_gen::type.

Referenced by getParties().

+ Here is the caller graph for this function:

◆ cf_system_get_region_vector()

void cf_system_get_region_vector ( int  property,
std::vector< region * > *  list 
)

Definition at line 2140 of file plugin_common.cpp.

References CFAPI_REGION_VECTOR, cfapiSystem_get_region_vector, guildoracle::list, and is_valid_types_gen::type.

Referenced by getRegions().

+ Here is the caller graph for this function:

◆ cf_system_register_command()

command_registration cf_system_register_command ( const char *  name,
command_function  func,
uint8_t  command_type,
float  time 
)

◆ cf_system_register_command_extra()

command_registration cf_system_register_command_extra ( const char *  name,
const char *  extra,
command_function_extra  func,
uint8_t  command_type,
float  time 
)

Definition at line 2103 of file plugin_common.cpp.

References CFAPI_SINT64, cfapiSystem_register_command, give::name, and is_valid_types_gen::type.

Referenced by registerCommand().

+ Here is the caller graph for this function:

◆ cf_system_register_global_event()

void cf_system_register_global_event ( int  event,
const char *  name,
f_plug_event  hook 
)

Definition at line 1102 of file plugin_common.cpp.

References CFAPI_NONE, cfapiSystem_register_global_event, animate::event, give::name, and is_valid_types_gen::type.

Referenced by postInitPlugin(), and registerGEvent().

+ Here is the caller graph for this function:

◆ cf_system_unregister_command()

void cf_system_unregister_command ( command_registration  command)

Definition at line 2111 of file plugin_common.cpp.

References cfapiSystem_unregister_command, devourers::command, and is_valid_types_gen::type.

Referenced by closePlugin().

+ Here is the caller graph for this function:

◆ cf_system_unregister_global_event()

void cf_system_unregister_global_event ( int  event,
const char *  name 
)

Definition at line 1109 of file plugin_common.cpp.

References CFAPI_NONE, cfapiSystem_unregister_global_event, animate::event, give::name, and is_valid_types_gen::type.

Referenced by unregisterGEvent().

+ Here is the caller graph for this function:

◆ cf_timer_create()

int cf_timer_create ( object ob,
long  delay,
int  mode 
)

Creates a timer, equivalent of calling cftimer_create().

Parameters
obobject that will get called. Should handle EVENT_TIMER.
delaydelay, seconds or ticks.
modetimer mode, TIMER_MODE_SECONDS or TIMER_MODE_CYCLES
Returns
timer identifier, or one of TIMER_ERR_ID, TIMER_ERR_OBJ or TIMER_ERR_MODE

Definition at line 1604 of file plugin_common.cpp.

References CFAPI_INT, cfapiSystem_timer_create, guildjoin::ob, and is_valid_types_gen::type.

Referenced by Crossfire_Object_CreateTimer().

+ Here is the caller graph for this function:

◆ cf_timer_destroy()

int cf_timer_destroy ( int  id)

Destroys specified timer, equivalent of calling cftimer_destroy().

Parameters
idtimer to destroy
Returns
TIMER_ERR_ID if invalid id, TIMER_ERR_NONE else.

Definition at line 1620 of file plugin_common.cpp.

References CFAPI_INT, cfapiSystem_timer_destroy, and is_valid_types_gen::type.

Referenced by destroyTimer().

+ Here is the caller graph for this function: