Functions

Function Arguments Description Result File
arr2strarrayConvert array to string using = delimiter.stringcommon
attack_meleehero_stats, target_statsSimulates a melee attack between a hero and its target.integercombat
attack_rangedhero_stats, target_statsSimulates a ranged attack between hero and its target.integercombat
auto_combatEDIT
book_vesselEDIT
can_castEDIT
cast_abvenenumEDIT
cast_analysEDIT
cast_armatrutzEDIT
cast_astral_theftEDIT
cast_attributoEDIT
cast_axxeleratusEDIT
cast_balsamEDIT
cast_banish_spiritsEDIT
cast_bannbaladinEDIT
cast_blitzEDIT
cast_calm_stormEDIT
cast_camouflageEDIT
cast_claudibusEDIT
cast_conjure_spiritEDIT
cast_darknessEDIT
cast_destructiboEDIT
cast_disruptivoEDIT
cast_dominationEDIT
cast_duplicatusEDIT
cast_eagle_wolfEDIT
cast_eagles_eyeEDIT
cast_ecliptifactusEDIT
cast_elementareEDIT
cast_evil_eyeEDIT
cast_exposamiEDIT
cast_fires_baneEDIT
cast_flim_flamEDIT
cast_foramenEDIT
cast_fortifexEDIT
cast_freeze_softEDIT
cast_fulminictusEDIT
cast_gardianumEDIT
cast_heptagonEDIT
cast_horriphobusEDIT
cast_ignifaxiusEDIT
cast_invercanoEDIT
cast_iron_rustEDIT
cast_karnifiloEDIT
cast_klarum_purumEDIT
cast_meeknessEDIT
cast_melt_solidEDIT
cast_motoricusEDIT
cast_nekropathiaEDIT
cast_nihilatioEDIT
cast_ocean_floorEDIT
cast_odem_arcanumEDIT
cast_paralysisEDIT
cast_penetrizzelEDIT
cast_plumbumbarumEDIT
cast_psychostabilisEDIT
cast_radauEDIT
cast_regeneratioEDIT
cast_respondamiEDIT
cast_sensibarEDIT
cast_silentiumEDIT
cast_skelettariusEDIT
cast_solidridEDIT
cast_somnigravisEDIT
cast_spellEDIT
cast_summon_crowsEDIT
cast_transversalisEDIT
cast_visibiliEDIT
cast_witchs_eyeEDIT
cast_witchs_knotEDIT
change_qtyEDIT
check_combat_stateEDIT
check_encounterEDIT
check_party_skillEDIT
check_quest_statusEDIT
check_skillEDIT
check_skillsEDIT
collect_itemEDIT
continue_combatcombat_id(?) Decodes the JSON log and returns the data as object.objectcombat
convert_moneyEDIT
count_distancehero_field, target_fieldCalculates the number of cells between hero and its target.integercombat
count_itemEDIT
count_levelEDIT
count_milesEDIT
count_spaceEDIT
deposit_itemEDIT
display_item_statsEDIT
eat_drinkEDIT
eat_foodEDIT
equip_itemEDIT
exit_to_mapReturns URL forcing player to exit to Aventuria map.stringbasic
format_textEDIT
futureEDIT
generate_nameclass_id, gender_idPicks a random name from the list according to hero's class and gender.stringgeneration
generate_statsclass_idGenerates positive and negative attributes, deity, weight and height for a new hero.objectgeneration
get_adEDIT
get_attributesEDIT
get_audioEDIT
get_available_heroesuser_idGet a list of heroes that were created by a specific player.arraybasic
get_barter_itemsEDIT
get_best_atskillReturns the ID of the most skilled hero in the party.integerbasic
get_casters_listspellGenerates and returns an HTML list with highlighted casters.stringbasic
get_combat_statshero_idReturns an object containing hero's derived values, which are relevant for combat.objectcombat
get_current_cityReturn player's current city location ID.integerbasic
get_current_locationEDIT
get_default_slotsEDIT
get_deposit_recipeEDIT
get_deposited_itemsEDIT
get_diagramEDIT
get_dice_rangeEDIT
get_diseasedisease_idReturns all information about the disease: name, symptoms, cure and healing price.objectbasic
get_drinksEDIT
get_encounterEDIT
get_enemiesEDIT
get_exit_urlobjChecks what is exit URL from current location via get queried object and returns the URL.stringbasic
get_field_typeEDIT
get_fightersEDIT
get_god_statsEDIT
get_gods_listEDIT
get_gossipEDIT
get_healthy_heroesEDIT
get_hero_by_classclass_id, gender_idChecks if the party contains a hero with specific class and gender and returns his numeric ID.integerbasic
get_hero_facehero_idGet hero's portrait URL according to his current condition.stringbasic
get_hero_namehero_idReturns hero's short name with a fallback to his full name.stringbasic
get_hero_nameshero_idsGet hero names list by array of IDs delimited by comma.stringbasic
get_hero_statshero_idCalculates and returns an object of creatures attributes and skills.arraybasic
get_heroesEDIT
get_heroes_listskillThe function returns the generated HTML list with highlighted options.stringbasic
get_holidaymonth, dayReturns a list of annual holidays by provided month and day.stringcalendar
get_housesEDIT
get_inventoryEDIT
get_ipEDIT
get_item_ownerEDIT
get_item_slotEDIT
get_item_statsEDIT
get_item_typeEDIT
get_level_rangeEDIT
get_loadEDIT
get_lvlhero_idCalculates a level according to Experience Points. In case of a party, it returns the lowest level among the members.integercombat
get_mailboxEDIT
get_miraclegod_idGet random miracle of the corresponding god and shows the dialog message.stringbasic
get_money_intEDIT
get_month_objectmonth, yearGenerates an object of days in provided month with containing, day number, week number, week day and a list of holidays. The object can be used to displaying tabled calendar.objectcalendar
get_party_locationChecks players recent visited location and returns an exit URL.stringbasic
get_poisonEDIT
get_randomarray, excludePicks a random element from array, excluding the provided option.mixedbasic
get_random_lineEDIT
get_random_opponentsquantityReturns an array with randomly picked character IDs.arraycombat
get_restEDIT
get_rumorsEDIT
get_siblingsEDIT
get_skills_listReturns a list of skill names for any character.arraygeneration
get_spells_listReturns a list of all available spells.arraygeneration
get_start_inventoryEDIT
get_start_skillsclass_id, god_idGenerates a list of start values for the provided class. Also adds deity modifiers.stringgeneration
get_start_spellsclass_id, schoolReturns start spell values for magical characters according to their class and representation.stringgeneration
get_stateEDIT
get_the_heroesGet a list of heroes that are currently in the party.arraybasic
get_the_priceEDIT
get_today_dataEDIT
get_topicEDIT
get_topicshero_idReturns a list of dialog options grouped by topics.objectbasic
get_town_imgEDIT
get_weatherEDIT
get_worst_atskillReturns the ID of the most unskilled hero in the party.integerbasic
go_fishingEDIT
go_gatheringEDIT
go_huntingEDIT
has_aspEDIT
has_itemEDIT
has_item_typeEDIT
has_spaceEDIT
has_statestate, hero_idChecks whether specific hero has specific state.integerbasic
has_strEDIT
have_itemEDIT
have_sexEDIT
have_spaceEDIT
hero_detailsEDIT
hex2iidEDIT
if_have_classEDIT
if_have_genderEDIT
if_have_itemEDIT
if_have_moneyEDIT
if_is_finishedEDIT
if_is_readEDIT
if_quest_isEDIT
import_gameEDIT
improve_skillskill, hero_idImproves selected skill or spell by 1.boolgeneration
inc_tplEDIT
is_2handeditem_idChecks whether the weapon is two-handed.boolcombat
is_archerEDIT
is_casterEDIT
is_cityEDIT
is_finishedEDIT
is_mageEDIT
is_marketlocation_idChecks whether current location holds a market today.boolcalendar
is_metEDIT
is_okhero_idChecks whether the hero fills okay. If not return HTML with his complaint.stringbasic
is_rangeditem_idCheckes whether the item is a ranged weapon.boolcombat
is_readEDIT
language_descriptionEDIT
latinize_textEDIT
list_skillsReturns an object of all hero skills grouped by type.objectbasic
list_spellsReturns an object of all spells grouped by magic schools.objectbasic
list_titlesEDIT
loot_chestEDIT
loot_itemEDIT
loot_itemsEDIT
loot_listEDIT
mark_asEDIT
move_toEDIT
pick_encounterEDIT
pop_exithtml, exit_urlDisplays popup with custom HTML and button leading to another page.basic
pop_formhtml, submit, closeDisplay custom HTML with an option to submit a form.basic
pop_htmlhtml, closeDisplay popup with custom HTML or post ID with conditional close button.basic
pop_printEDIT
pop_reloadhtml, buttonDisplays popup with custom HTML and button reloading the current page.basic
pray_godgod_idDetermines whether the heroes deserve the gods mercy and should get a miracle.stringbasic
purchaseEDIT
regenerateEDIT
register_taxonomiesEDIT
rel_urlEDIT
remove_itemEDIT
remove_itemsEDIT
remove_statestate, hero_idRemoves specific state from specific hero.boolbasic
remove_valueEDIT
rent_roomEDIT
reset_inventoryEDIT
reset_valuefield_name, hero_id(?) Resets fields to their default states.basic
return_errorerror_idRedirects to error page with corresponding message.boolbasic
return_xyfield_nameConverts xNyN string to an object of two elements.objectcombat
roa_acf_update_valueEDIT
roa_add_edit_postEDIT
roa_add_icon_columnEDIT
roa_add_items_columnEDIT
roa_auto_redirect_after_logoutEDIT
roa_block_dashboardEDIT
roa_body_classesEDIT
roa_change_post_labelEDIT
roa_change_post_typeEDIT
roa_cleanEDIT
roa_commentsEDIT
roa_dashboard_widgetsEDIT
roa_default_imagesEDIT
roa_defer_parsing_of_jsEDIT
roa_deregister_stylesEDIT
roa_dialogs_widgetEDIT
roa_disable_autosaveEDIT
roa_disable_feedEDIT
roa_disable_pingsEDIT
roa_display_posts_iconsEDIT
roa_display_posts_itemsEDIT
roa_falseEDIT
roa_file_dataEDIT
roa_getEDIT
roa_get_fieldEDIT
roa_get_imgEDIT
roa_get_urlEDIT
roa_insert_postEDIT
roa_list_itemsEDIT
roa_login_redirectEDIT
roa_login_timeEDIT
roa_logout_without_confirmEDIT
roa_make_registered_column_sortableEDIT
roa_manage_columnsEDIT
roa_modify_user_tableEDIT
roa_modify_user_table_rowEDIT
roa_npc_widgetEDIT
roa_prefix_add_posts_orderEDIT
roa_quicktags_settingsEDIT
roa_register_cptEDIT
roa_remove_admin_barEDIT
roa_remove_dashboard_metaEDIT
roa_remove_link_relEDIT
roa_remove_meta_boxesEDIT
roa_remove_versionEDIT
roa_scriptsEDIT
roa_scripts_adminEDIT
roa_set_defaultsEDIT
roa_set_ttlEDIT
roa_shuffle_objEDIT
roa_sitemapEDIT
roa_sort_by_loginEDIT
roa_symbolsEDIT
roa_theme_setupEDIT
roa_unlimit_postsEDIT
roa_update_guidEDIT
roa_upload_size_limitEDIT
roa_widget_htmlEDIT
run_snippetEDIT
save_inventoryEDIT
sellEDIT
set_classesEDIT
set_locationSets location cookie and updates current city and encounter fields.basic
set_stateEDIT
set_valueEDIT
short_buttonEDIT
short_casters_listEDIT
short_check_ifEDIT
short_heroes_countEDIT
short_heroes_listEDIT
short_hintEDIT
short_items_listEDIT
short_nameEDIT
short_randomEDIT
short_rumorsEDIT
short_submitEDIT
short_today_isEDIT
show_abbrstringReturn the full version of the given abbreviature.stringbasic
show_classclass_idReturn hero class name by class ID.stringbasic
show_contentEDIT
show_deitygod_idShow god's name by his numeric ID.stringbasic
show_excerptEDIT
show_genderhero_id, male_str, female_strDetects creatures gender and returns the corresponding string.stringbasic
show_schoolschool_idReturns magic school name by school ID.stringbasic
show_week_dayweekday_idReturns Aventurian weekday name according to its number.stringcalendar
simulate_combatcombat_id, rounds, enemies_idsSimulates and autocombat between heroes and enemies.integercombat
sort_by_genderEDIT
start_combatcombat_id, hero_idsSets the combat field, creates combat log and returns an object with all positions and start values.objectcombat
storage_putEDIT
storage_takeEDIT
str2arrstringConvert string to array using = delimiter.arraycommon
str2numEDIT
swap_itemEDIT
swap_itemsEDIT
target_heroEDIT
todaykey, valueSets an event that is relevant for today.boolbasic
tomorrowkey, valueSets upcoming events for the next day.boolbasic
translate_fromEDIT
translate_toEDIT
update_aspEDIT
update_herohero_stats_objectReceives object with updated hero values and saves them to corresponding fields.stringbasic
update_moneyEDIT
update_reputationgod_id, modifier, ducatsUpdate reputation with specific god by given modifier or via money donation.boolbasic
update_statestate, value, hero_idAssigns a new value to existing state.boolbasic
update_valueEDIT
url_is_imageEDIT
use_itemEDIT
use_skill_acrobaticsEDIT
use_skill_alchemyEDIT
use_skill_ancient_tonguesEDIT
use_skill_animal_loreEDIT
use_skill_arcane_loreEDIT
use_skill_bindEDIT
use_skill_carouseEDIT
use_skill_cheatEDIT
use_skill_climbEDIT
use_skill_convertEDIT
use_skill_danceEDIT
use_skill_danger_senseEDIT
use_skill_driveEDIT
use_skill_evaluateEDIT
use_skill_geographyEDIT
use_skill_haggleEDIT
use_skill_herb_loreEDIT
use_skill_hideEDIT
use_skill_historyEDIT
use_skill_human_natureEDIT
use_skill_instrumentEDIT
use_skill_lieEDIT
use_skill_locksEDIT
use_skill_orientationEDIT
use_skill_perceptionEDIT
use_skill_physical_controlEDIT
use_skill_pickpocketEDIT
use_skill_readEDIT
use_skill_rideEDIT
use_skill_ritualEDIT
use_skill_seduceEDIT
use_skill_self_controlEDIT
use_skill_stealthEDIT
use_skill_streetwiseEDIT
use_skill_survivalEDIT
use_skill_swimEDIT
use_skill_tacticsEDIT
use_skill_tonguesEDIT
use_skill_trackEDIT
use_skill_train_animalsEDIT
use_skill_treat_diseaseEDIT
use_skill_treat_poisonEDIT
use_skill_treat_woundsEDIT
wand_ritualEDIT