Adds a news item for the current user.
addnews(string $text[, array<string|int, mixed> $params = [] ][, string $textDomain = 'partial_news' ][, bool $hideFromBio = null ]) : mixed
activate_buffs(mixed $tag) : mixed
process_lifetaps(mixed $ltaps, mixed $damage) : mixed
process_dmgshield(mixed $dshield, mixed $damage) : mixed
expire_buffs() : mixed
expire_buffs_afterbattle() : mixed
Prepare all data for show battle bars.
prepare_data_battlebars(array<string|int, mixed> $enemies) : array<string|int, mixed>
This function prepares the fight, sets up options and gives hook a hook to change options on a per-player basis.
prepare_fight([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
the options given by a module or basics
This functions prepares companions to be able to take part in a fight. Uses global copies.
prepare_companions() : mixed
Suspends companions on a given parameter.
suspend_companions(string $susp[, string $nomsg = null ]) : mixed
The type of suspension
The message to be displayed upon suspending. If false, no message will be displayed.
Enables suspended companions.
unsuspend_companions(string $susp[, string $nomsg = null ]) : mixed
The type of suspension
The message to be displayed upon unsuspending. If false, no message will be displayed.
Automatically chooses the first still living enemy as target for attacks.
autosettarget(array<string|int, mixed> $localenemies) : array<string|int, mixed>
the stack of enemies to find a valid one from
Based upon the type of the companion different actions are performed and the companion is marked as "used" after that.
report_companion_move(array<string|int, mixed> $companion[, string $activate = 'fight' ]) : array<string|int, mixed>
The companion itself
The stage of activation. Can be one of these: "fight", "defend", "heal" or "magic".
Based upon the companion's stats damage values are calculated.
rollcompaniondamage(array<string|int, mixed> $companion) : array<string|int, mixed>
Adds a new creature to the badguy array.
battle_spawn(mixed $creature) : mixed
A standard badguy array. If numeric, the corresponding badguy will be loaded from the database.
Allows creatures to heal themselves or another badguy.
battle_heal(int $amount[, mixed $target = false ]) : mixed
Amount of helath to be restored
if false badguy will heal itself otherwise the enemy with this index
Executes the given script or loads the script and then executes it.
execute_ai_script(string $script) : mixed
the script to be executed
Battle: attack of player.
battle_player_attacks() : bool
Battle: attack of badguy.
battle_badguy_attacks() : bool
Function to show result of victory battle.
battlevictory(array<string|int, mixed> $enemies[, bool $denyflawless = false ][, bool $forest = true ]) : mixed
Process win experiencie in battle win in forest.
battlegainexperienceforest() : mixed
Process win experiencie in battle win in graveyard.
battlegainexperiencegraveyard() : mixed
Function to show result of defeated battle.
battledefeat(array<string|int, mixed> $enemies[, string|false $where = 'forest' ][, bool $candie = true ][, bool $lostexp = true ][, bool $lostgold = true ]) : mixed
Can die in battle?
Lost exp when die in battle?
Lost gold when die in battle?
Show result of.
battleshowresults(array<string|int, mixed> $lotgdBattleContent) : mixed
rolldamage() : mixed
report_power_move(mixed $crit, mixed $dmg) : mixed
suspend_buffs([mixed $susp = false ][, mixed $msg = false ]) : mixed
suspend_buff_by_name(mixed $name[, mixed $msg = false ]) : mixed
unsuspend_buff_by_name(mixed $name[, mixed $msg = false ]) : mixed
is_buff_active(mixed $name) : mixed
unsuspend_buffs([mixed $susp = false ][, mixed $msg = false ]) : mixed
apply_bodyguard(mixed $level) : mixed
apply_skill(mixed $skill, mixed $l) : mixed
calculate_buff_fields() : mixed
restore_buff_fields() : mixed
apply_buff(mixed $name, mixed $buff) : mixed
apply_companion(mixed $name, mixed $companion[, mixed $ignorelimit = false ]) : mixed
strip_buff(mixed $name) : mixed
strip_all_buffs() : mixed
has_buff(mixed $name) : mixed
Delete an account and create a backup.
char_cleanup(int $accountId, int $type) : bool
In order to create a backup and delete the data, the EntityRepository of each table needs to have the following two methods:
Create backup of Entity in "logd_snapshots".
createBackupOfEntity(int $accountId, object $repository, string $entityName) : bool
Create a basic info backup of account.
createBackupBasicInfo(int $accountId, mixed $account) : bool
checkban([mixed $login = false ]) : mixed
process_post_save_data(mixed $post, mixed $old, mixed &$flashMessages, mixed $module, mixed $textDomain) : mixed
Generate a base creature stats Can use for generated your own creatures in your modules.
lotgd_generate_creature_levels([false|int $level = null ]) : array<string|int, mixed>
Level of creature
Generate a dummy creature Doppelganger.
lotgd_generate_doppelganger(int $level) : array<string|int, mixed>
Transform creature to adapt to player.
lotgd_transform_creature(array<string|int, mixed> $badguy[, bool $debug = true ]) : array<string|int, mixed>
Data of creature
Show or not debug of creature
Search for creature in data base.
lotgd_search_creature(int $multi, int $targetlevel, int $mintargetlevel[, bool $packofmonsters = false ][, bool|null $forest = true ]) : array<string|int, mixed>
For diferent or same creatures
TRUE for creature of forest, FALSE for graveyard and NULL for none
get_creature_stats(mixed $dk) : mixed
get_creature_hitpoints(mixed $attrs) : mixed
get_creature_attack(mixed $attrs) : mixed
get_creature_defense(mixed $attrs) : mixed
get_creature_speed(mixed $attrs) : mixed
lotgd_show_debug_creature(iteratable<string|int, mixed> $badguy) : mixed
Check if is a new day.
checkday() : mixed
is_new_day(int $now) : bool
getgametime() : mixed
Undocumented function.
gametime() : int
convertgametime(int $intime[, mixed $debug = false ]) : mixed
gametimedetails() : mixed
secondstonextgameday([mixed $details = false ]) : mixed
Select 1 death message.
select_deathmessage([string $zone = 'forest' ][, array<string|int, mixed> $extraParams = [] ]) : array<string|int, mixed>
Documentated by Catscradler Add to the user's log if $field $value and $consolidate have values, entry will be merged with existing line from today with identical $field.
debuglog(string $message[, int $target = false ][, int $user = false ][, string $field = false ][, int $value = false ][, bool $consolidate = true ]) : mixed
otherwise, a new line will be added to the log.
the text to be added
acctid of the user on the receiving end of the event eg. the user who did NOT initiate PvP, gold transfer recipient (optional)
acctid of the user the log entry is about (optional, defaults to current user)
the label for this line, appears as first word on this line in the log eg. healing, forestwin (optional)
how much was gained or lost. Only useful if also using $field and $consolidate (optional)
add $value to previous log lines with the same $field, keeping a running total for today (optional, defaults to true)
dump_item(mixed $item) : mixed
dump_item_ascode(mixed $item[, mixed $indent = " " ]) : mixed
handle_event(mixed $location[, mixed $baseLink = false ]) : mixed
Returns the experience needed to advance to the next level.
exp_for_next_level(int $curlevel, int $curdk) : int
the current level of the player
the current number of dragonkills
fightnav([mixed $allowspecial = true ][, mixed $allowflee = true ][, mixed $script = false ]) : mixed
do_forced_nav(mixed $anonymous, mixed $overrideforced) : mixed
Buff creature for optimize to character stats.
buffbadguy(mixed $badguy[, string $hook = 'buffbadguy' ]) : array<string|int, mixed>
Hook to activate when buff badguy
gamelog(mixed $message[, mixed $category = 'general' ][, mixed $filed = false ]) : mixed
holidayize(mixed $text[, mixed $type = 'unknown' ]) : mixed
increment_specialty(mixed $colorcode[, mixed $spec = false ]) : mixed
Function for send Mails to users Has the same structure as the php "mail()" function, but this function checks if you want to send emails in html format or not.
lotgd_mail(mixed $to, mixed $subject, mixed $message[, mixed $additional_headers = '' ][, mixed $additional_parameters = '' ]) : mixed
activate_module(mixed $module) : mixed
deactivate_module(mixed $module) : mixed
uninstall_module(mixed $module) : mixed
install_module(mixed $module[, mixed $force = true ]) : mixed
blockmodule(mixed $modulename) : mixed
unblockmodule(mixed $modulename) : mixed
module_collect_events(mixed $type[, mixed $allowinactive = false ]) : mixed
module_events(mixed $eventtype, mixed $basechance[, mixed $baseLink = false ]) : mixed
module_do_event(mixed $type, mixed $module[, mixed $allowinactive = false ][, mixed $baseLink = false ]) : mixed
event_sort(mixed $a, mixed $b) : mixed
module_display_events(mixed $eventtype[, mixed $forcescript = false ]) : mixed
modulehook(mixed $hookname[, mixed $args = false ][, mixed $allowinactive = false ][, mixed $only = false ]) : mixed
Delete hooks of module.
module_wipehooks(string $module) : mixed
module_addeventhook(mixed $type, mixed $chance) : mixed
module_drophook(mixed $hookname[, mixed $functioncall = false ]) : mixed
Called by modules to register themselves for a game module hook point, with default priority.
module_addhook(string $hookname[, string $functioncall = false ][, string $whenactive = false ]) : mixed
Modules with identical priorities will execute alphabetically. Modules can only have one hook on a given hook name, even if they call this function multiple times, unless they specify different values for the functioncall argument.
The hook to receive a notification for
The function that should be called, if not specified, use {modulename}_dohook() as the function
an expression that should be evaluated before triggering the event, if not specified, none
Called by modules to register themselves for a game module hook point, with a given priority -- lower numbers execute first.
module_addhook_priority(string $hookname[, int $priority = 50 ][, string $functioncall = false ][, string $whenactive = false ]) : mixed
Modules with identical priorities will execute alphabetically. Modules can only have one hook on a given hook name, even if they call this function multiple times, unless they specify different values for the functioncall argument.
The hook to receive a notification for
The priority for this hooking -- lower numbers execute first. < 50 means earlier-than-normal execution, > 50 means later than normal execution. Priority only affects execution order compared to other events registered on the same hook, all events on a given hook will execute before the game resumes execution.
The function that should be called, if not specified, use {modulename}_dohook() as the function
an expression that should be evaluated before triggering the event, if not specified, none
injectmodule(mixed $modulename[, mixed $force = false ]) : mixed
Returns the status of a module as a bitfield.
module_status(string $modulename[, string $version = null ]) : int
The module name
The version to check for (null for don't care)
Determines if a module is activated.
is_module_active(string $modulename) : bool
The module name
Determines if a module is installed.
is_module_installed(string $modulename[, string $version = false ]) : bool
The module name
The version to check for
Get status of module.
get_module_install_status() : array<string|int, mixed>
Delete all objtype for objid.
module_delete_objprefs(string $objtype, int $objid) : mixed
Get value for a setting for a module, objtype and objid.
get_module_objpref(string $objtype, int $objid, string $name[, string $module = false ]) : mixed
Set value for a setting for a module, objtype and objid.
set_module_objpref(string $objtype, int $objid, string $name, mixed $value[, string $module = false ]) : mixed
Increment value for a setting for a module, objtype and objid.
increment_module_objpref(string $objtype, int $objid, string $name[, float|int $value = 1 ][, string $module = false ]) : mixed
Load objpref of a module.
load_module_objpref(string $objtype, int $objid[, string $module = false ]) : array<string|int, mixed>
Delete all module user preferences.
module_delete_userprefs(int $user) : mixed
Get all module prefs of a user.
get_all_module_prefs([string $module = false ][, int $user = false ]) : array<string|int, mixed>
Get pref of user for a given module and setting.
get_module_pref(string $name[, string $module = false ][, int $user = false ]) : mixed
Set pref of user for a given module and setting.
set_module_pref(string $name, mixed $value[, string $module = false ][, int $user = false ]) : mixed
Increment pref of user for a given module and setting.
increment_module_pref(string $name[, int|float $value = 1 ][, string $module = false ][, int $user = false ]) : mixed
Clear a setting for a given module and user.
clear_module_pref(string $name[, string $module = false ][, int $user = false ]) : mixed
Load prefs of a module.
load_module_prefs(string $module[, int $user = false ]) : array<string|int, mixed>
An associative array of all the settings for the given module.
get_all_module_settings([string $module = false ]) : array<string|int, mixed>
Get value for setting of a module.
get_module_setting(mixed $name[, mixed $module = false ]) : mixed
Set value for setting of a module.
set_module_setting(string $name, mixed $value[, string $module = false ]) : mixed
Increment value for a setting of module.
increment_module_setting(string $name[, float|int $value = 1 ][, string $module = false ]) : mixed
Clear settings of a module.
clear_module_settings([string $module = false ]) : mixed
Load settings of a module.
load_module_settings(string $module) : array<string|int, mixed>
Checks if the module requirements are satisfied. Should a module require other modules to be installed and active, then optionally makes them so.
module_check_requirements(array<string|int, mixed> $reqs[, mixed $forceinject = false ]) : bool
Requirements of a module from _getmoduleinfo()
Preloads data for multiple modules in one shot rather than having to make SQL calls for each hook, when many of the hooks are found on every page.
mass_module_prepare(array<string|int, mixed> $hooknames) : bool
names of hooks whose attached modules should be preloaded
get_module_info(mixed $shortname) : mixed
module_editor_navs(mixed $like, mixed $linkprefix) : mixed
module_objpref_edit(mixed $type, mixed $module, mixed $id) : mixed
module_compare_versions(mixed $a, mixed $b) : mixed
Evaluates a PHP Expression.
module_condition(string $condition) : bool
The PHP condition to evaluate
get_racename([mixed $thisuser = true ]) : mixed
module_pref_filter(mixed $a) : mixed
getmountname() : mixed
getmount(mixed $horse) : mixed
get_player_title([mixed $old = false ]) : mixed
get_player_basename([mixed $old = false ]) : mixed
change_player_name(mixed $newname[, mixed $old = false ]) : mixed
change_player_ctitle(mixed $nctitle[, mixed $old = false ]) : mixed
change_player_title(mixed $ntitle[, mixed $old = false ]) : mixed
Resets the character stats array.
wipe_charstats() : mixed
Add a attribute and/or value to the character stats display.
addcharstat(string $label[, string $value = null ]) : mixed
The label to use
(optional) value to display
Returns the character stat related to the category ($cat) and the label.
getcharstat(string $cat, string $label) : string
The relavent category for the stat
The label of the character stat
Sets a value to the passed category & label for character stats.
setcharstat(string $cat, string $label, mixed $val) : mixed
The category for the char stat
The label associated with the value
The value of the attribute
Is alias of getcharstat.
getcharstat_value(string $section, string $title) : string
The character stat section
The stat display label
Returns output formatted character stats.
getcharstats(array<string|int, mixed> $buffs) : string
Returns the current character stats or (if the character isn't logged in) the currently online players Hooks provided: charstats.
charstats([bool $return = true ]) : array<string|int, mixed>
get_partner([mixed $player = false ]) : mixed
killplayer([mixed $explossproportion = 0.1 ][, mixed $goldlossproportion = 1 ]) : mixed
get_player_hitpoints([mixed $player = false ]) : mixed
explained_get_player_hitpoints([mixed $player = false ][, mixed $colored = false ]) : mixed
get_player_attack([mixed $player = false ]) : mixed
explained_row_get_player_attack([mixed $player = false ]) : mixed
explained_get_player_attack([mixed $player = false ][, mixed $colored = false ]) : mixed
get_player_defense([mixed $player = false ]) : mixed
explained_row_get_player_defense([mixed $player = false ]) : mixed
explained_get_player_defense([mixed $player = false ][, mixed $colored = false ]) : mixed
get_player_speed([mixed $player = false ]) : mixed
get_player_physical_resistance([mixed $player = false ]) : mixed
This contains functions to support pvp.
setup_pvp_target(int $characterId) : bool|array<string|int, mixed>
pvpvictory(mixed $badguy, mixed $killedloc) : mixed
pvpdefeat(mixed $badguy, mixed $killedloc) : mixed
pvpwarning([mixed $dokill = false ]) : mixed
redirect(mixed $location[, mixed $reason = false ]) : mixed
saveuser([mixed $update_last_on = true ]) : mixed
savesetting(string $settingname, mixed $value) : mixed
clearsettings() : mixed
getsetting(string $settingname[, mixed $default = false ]) : mixed
getAllSettings() : mixed
Construct FORM LOTGD style.
lotgd_showform(mixed $layout, array<string|int, mixed> $row[, bool $nosave = false ][, false|pattern $keypref = false ][, bool $print = true ][, callable $callback = null ]) : mixed
This can use for personalize the form used to show all inputs or for more process. Can still use lotgd_show_form_field in your callable Both functions get same parameters function($info, $row, $key, $keyout, $val, $extensions)
lotgd_show_form_field(mixed $info, mixed $row, mixed $key, mixed $keyout, mixed $val, mixed $extensions) : mixed
Construct TABS Semantic UI style.
lotgd_showtabs(array<string|int, mixed> $tabs[, bool $print = true ][, callable $callback = null ][, bool $browse = false ]) : mixed
Format: [ 'title for tab 1' => 'Content of tab 1' 'title for tab 2' => 'Content of tab 2' ]
Print tabs or return
If you need proccess de content of tab can pass a callback. Default no process content and only show. callback recibe paraments $callback($content, $title)
Indicate type of menu: tabular or browse menu
check_su_access(mixed $level) : mixed
Check Superuser premission.
checkSuPermission(int $permission[, string|null $return = null ]) : bool|redirect
Just check and redirect if denied you have permission.
substitute(mixed $string[, mixed $extra = false ][, mixed $extrarep = false ]) : mixed
substitute_array(mixed $string[, mixed $extra = false ][, mixed $extrarep = false ]) : mixed
systemmail(mixed $to, mixed $subject, mixed $body, mixed $from[, mixed $noemail = false ]) : mixed
Select 1 taunt.
select_taunt([array<string|int, mixed> $extraParams = [] ]) : array<string|int, mixed>
apply_temp_stat(mixed $name, mixed $value[, mixed $type = 'add' ]) : mixed
check_temp_stat(mixed $name[, mixed $color = false ]) : mixed
suspend_temp_stats() : mixed
restore_temp_stats() : mixed
valid_dk_title(mixed $title, mixed $dks, mixed $gender) : mixed
get_dk_title(mixed $dks, mixed $gender[, mixed $ref = false ]) : mixed
Alias of mt_rand with some improvements.
e_rand([int|float $min = null ][, int|float $max = null ]) : int
Same as e_rand but $min and $max are multiplied by 1000.
r_rand([int|float $min = null ][, int|float $max = null ]) : int|float
Check if given email is valid.
is_email(string $email) : bool
Turns an array into an URL argument string.
arraytourl(array<string|int, mixed> $array) : string
Takes an array and encodes it in key=val&key=val form. Does not add starting ?
The array to turn into an URL
Takes an array and returns its arguments in an array.
urltoarray(string $url) : array<string|int, mixed>
The URL
Turns the given parameter into a string.
createstring(mixed $array) : string
If the given parameter is an array or object, it is serialized, and the serialized string is return.
Otherwise, the parameter is cast as a string and returned.
myDefine(mixed $name, mixed $value) : mixed
list_files(mixed $ruta, mixed $sort) : mixed
_curl(mixed $url) : mixed
_sock(mixed $url) : mixed
pullurl(mixed $url) : mixed
safeescape(mixed $input) : mixed
nltoappon(mixed $in) : mixed
bell_rand([mixed $min = false ][, mixed $max = false ]) : mixed