Tales of Maj'Eyal - User contributions [en]

Resource

2018-06-30T07:27:26Z

Ghostbuster: Fixed paradox description that refered to the no longer existing "paradox mastery" talent.

{| class="wikitable" style="border: 1px solid gray; font-size: large;"
|ToME Version: || 1.4.3
|}


'''Resources''' are power pools used for various [[talents]] in Tales of Maj'Eyal. There are several different kinds of resources, and some of them have unique behaviors. Several resources are affected by [[Fatigue]]. Each resource has a unique bar on the interface displaying the current level of the resource.

==Air==
Only appears when you can't breathe for some reason. Being underwater, in a wall, or buried in sand will generally prevent you from breathing. You take an increasingly large amount of damage each turn after reaching 0 Air. Some items allow you to breathe underwater, or remove the need to breathe at all. Some underwater areas will have bubbles that can restore air until they are depleted.

Most races have 100 air, with [[yeek]] characters having 200. Two artifacts, [[Coral Spray]] and [[Vargh Redemption]] will raise the cap by 50 air.
* The first turn you are underwater your air will drop by 5 and will then decrease by 2 each subsequent turn.
* The first turn you are in a wall your air will drop by 20 and will then decrease by 17 each subsequent turn.
* The first turn you are buried in sand your air will drop by 10 and will then decrease by 7 each subsequent turn.
* When you can breathe again normally you regain 3 air per turn.
* Underwater bubbles will restore 20 per turn (minus the loss of 2 from being underwater, for a total gain of 18).
* When your air runs out you begin taking damage. The first turn it is 20% of your max life and it increases by 5% each turn (so 25% on the second turn, 30% on the third). This is quickly fatal.

==Equilibrium==
Equilibrium is the [[resource]] used by the Wild Gift class of talents, and represents how far the character is out of balance with Nature. It is sometimes abbreviated "EQ". [[Fatigue]] does not impact equilibrium at all.

Equilibrium starts at 0, and is raised by talent use; a high Equilibrium increases the chance of failure. If Equilibrium exceeds [[Willpower]], an attempt to use a Wild Gift talent has a (sqrt(Equilibrium - Willpower) / 60) chance to fizzle, causing the loss of a turn. This can be seen in the resource bar as "% failure".

Equilibrium does not naturally reduce itself over time, but it can be restored by:
* Walking on the wilderness map
* Standing in the area of effect of a Font of Life
* Using the {{t|Meditation}} talent passively or actively
* Successfully killing an enemy with the {{t|Swallow}} talent
* Being hit while {{t|Resolve}} is active but {{t|Antimagic Shield}} is not
* Coming under a life regeneration effect while under the influence of {{t|Ancestral Life}}
* Being hit while wearing various [[egos|equipment with on-hit EQ regeneration]]

Note that if a player/creature has an [[Equilibrium]] bar, using [[Vim]]-based talents will increase it by a noticeable amount.

==Feedback==
Feedback represents using pain as a means of psionic grounding and it can be used to power feedback abilities. Characters that have the feedback resource will gain feedback in proportion to any damage received. The base conversion rate depends on character level: it starts at 50% at level 1, and decays to 20% at level 50. Feedback is used by the [[Solipsist]]'s {{c|Feedback}} and {{c|Discharge}} talent trees. It decays at the rate of 10% or 1 per turn (whichever is greater). Feedback is affected by [[fatigue]].

==Hate==
Hate is the [[resource]] used by the Afflicted classes: [[Cursed]] and [[Doomed]]. Hate does not regenerate, and even decays over time. It is mainly recovered while fighting or use of the {{t|Feed}} talent. Hate is affected by [[fatigue]].

You can have up to 100 points of hate. Afflicted suffer from reduced healing while not at maximum hate -- by 50% at zero hate. Your hate slowly decays (more quickly when the level is higher), down to a minimum of half your hate at the end of the most recent combat. The strengths of many abilities also depend on your level of hate.

Here are some ways Hate is regained:

* '''Kill something''': 8 points, more for higher [[rank]] -- 24 points for a boss
* '''Take a big hit''' (over 15% of your maximum life): 2 points + 2 points per 5% life lost above 15%
* '''Take a hit while at low health''' (under 25% of maximum life): 4 points
* '''Do massive damage''' (over 33% in one hit)

The Doomed {{c|Dark Sustenance}} tree has the talent {{t|Feed}}, which can be used to replenish hate. Various Cursed talents also give Hate bonuses.

==Life==
{{:Life}}

==Mana==
Used by most of the magical spell talents. It works much like Spell Points or Mana in most other RPGs. Only Mage classes can regenerate Mana naturally. Certain class talents and gear can grant passive Mana regen, and having a Manasurge rune inscribed will grant some passive regen while resting. Your maximum increases with level (+4 per level), gear, and [[Willpower]] (+5 per point). Mana is doubly affected by [[fatigue]], making fatigue a primary concern for mana-using characters.

==Souls==
Used by [[Necromancer]]s, and represents the number of souls caught within the necrotic aura. Each soul can become an undead minion. The pool is replenished by killing living beings within the necrotic aura.

==Negative energy==
Negative energy is the power source for predominantly-[[Anorithil]] talents. [[Necromancer]]s can also get access to the tree by becoming a [[Lich]]. Liches will regenerate negative energy over time, whereas Anorithil and Adventurers lose negative energy over time.

It can be replenished by an Anorithil using:
* {{t|Twilight}} talent
* {{t|Twilight Surge}} talent

Maximum negative energy is increased by 3 whenever a character gains a level. Negative energy is affected by [[fatigue]].

==Positive energy==
Positive energy is a resource used by both of the [[Celestial (Metaclass)|Celestial]] classes (the [[Sun Paladin]]s and [[Anorithil]]). Many early talents will actually replenish it rather than drain it, shown as negative numbers in costs. It decreases over time if not used.

Maximum positive energy is increased by 3 whenever a character gains a level. Positive energy is affected by [[fatigue]].

==Paradox==
Paradox is the resource used by the {{c|Chronomancy}} talents. It is somewhat like [[Equilibrium]] -- it starts at 0, and increases as talents are used. High paradox causes failures, anomalies, and backfires, but also increases the power of some talents. The damage (and sometimes duration, etc) of most Chronomancy talents is multiplied by a "paradox modifier" determined by the following formula: sqrt(0.5 + Paradox / 600). [[Fatigue]] has a unique effect on paradox, increasing the failure rate but not the cost of feedback-using talents.

The cost of active paradox talents increases the higher your paradox already is; it is multiplied by 1 + (Paradox / 300).

Paradox failures simply cause you to lose a turn like equilibrium failures. However, unlike equilibrium failures, your paradox still increases by the cost of the talent that failed.

If an anomaly occurs, not only do you lose the turn and talent, but a random Anomaly talent is used. Your paradox is also reduced by twice the cost of the talent that failed. Anomaly chance is rolled before failure chance.

If a backfire occurs, the talent targets the caster.

To calculate paradox failure, anomaly, and backfire chance, a modified paradox is calculated by the following formula: (Paradox - [[Willpower]] * 2). Some items, such as the Shard of Crystallized Time, add directly to the Willpower stat used in this calculation, as does Temporal Form.

Then calculate the fatigue modifier: (100 + 2 * [[Fatigue]]) / 100.

Failures can only occur if modified paradox is over 200; if so, the chance is ceil(fatigue_modifier * (modified_paradox / 200)^2).

Anomalies can only occur if modified paradox is over 300; if so, the chance is ceil(fatigue_modifier * (modified_paradox / 300)^3).

Backfires can only occur if modified paradox is over 400; if so, the chance is ceil(fatigue_modifier * (modified_paradox / 400)^4).

==Psi==
Psi is the resource used by Psionic classes, such as [[Solipsist]] and [[Mindslayer]]. It slowly regenerates over time, can be restored by talents and some equipment. Players can increase psi pool by raising willpower (+1 per point invested in willpower except for the [[Solipsist]] class). Psi is doubly affected by [[fatigue]].

==Stamina==
Stamina is the resource used by most physical talents. It is regenerated at a rate of 0.3 per turn if there are no other modifiers. Resting will accelerate the rate at which stamina is recovered. Stamina capacity is increased by raising willpower (+2.5 max stamina per point) and when gaining a level (+3 max stamina per level). Stamina is affected by [[fatigue]].

==Vim==
Vim is the resource used by the [[Defiler]] metaclass. Vim does not regenerate but is instead regained in several ways, all involving combat. [[Fatigue]] plays no role in determining vim costs. The vim pool grows by 4 points every level and is not influenced by any stats.

Ways of regaining vim:

* '''Kill bounty:''' Each kill returns one point of vim per 20 [[Willpower]].
* '''Kill refunds:''' If you kill something directly with a vim-using talent, the talents cost in vim is restored. This ''only'' works with straight damage -- infecting someone with a disease won't return any vim this way, even if your victim dies from it three rounds later. Though if you kill something with a Bone Nova, for example, you will get its cost refunded.
* '''Special Talents:''' Some talents can also restore your vim, such as {{t|Drain}} and {{t|Leech}}.

==Steam==
Steam is the resource used by the [[Tinker]] metaclass. It was introduced as part of the [[Embers of Rage]] DLC. [[Fatigue]] plays no role in determining steam costs.

Steam is generated by steam generator injectors, which generate a constant amount of steam per turn. Steam is consumed by steam-powered weapons when used in melee or ranged fire, by steam-using talents, and by steam-using sustains. Unlike some other resources, steam-using sustains drain a fixed amount of steam ''per turn''.
[[Category:Game Mechanics]] [[Category:Resources]]

Hooks

2018-02-05T23:07:46Z

Ghostbuster: Cosmetic changes. Also added hook Combat:attackTargetWith:attackerBonuses

[[Category:Development]][[Category:Addons]]
For addons, hooks are a way of causing certain code to be triggered by events happening in the game.

They are all used the same way, with "ToME:load" being replaced with the actual hook name:

class:bindHook("ToME:load", function(self, data)
your code
end

If the hook function has any arguments, they are accessed through the data variable like data.argumentname .

Here is a list of hooks currently available for addon creators and what they do.

'''ToME:load'''
Triggers when ToME loads up. Used to load an addons files into the game. Must be included in every addon or the addon will not work!
There are a few important functions you'll want to trigger to make the magic happen.

* ''Birther:loadDefinition'' will load a new race or class
* ''ActorTalents:loadDefinition'' will load new talents for your new race, class, or monster to use
* ''DamageType:loadDefinition'' will load new damage types for your talents to use
* ''ActorTemporaryEffects:loadDefinition'' will load new temporary effect, bad or good, to be used by talents and damage types
* ''WorldAchievements:loadDefinition'' loads new achievement. Not commonly used in addons
* ''PlayerLore:loadDefinition'' adds new lore to be collected by the player. Not commonly used in addons
* ''PartyIngredients:loadDefinition'' loads new ingredients to be collected by the player for reciptes. Not commonly used in addons.

So for example if we want a new class called "Pilgrim" with it's own unique talents, but no new damage types or effects, we could load it like so.

class:bindHook("ToME:load", function(self, data)
ActorTalents:loadDefinition("/data-classpack/talents/techniques/techniques-pilgrim.lua")
Birther:loadDefinition("/data-classpack/birth/pilgrim.lua")
end)

==Engine Hooks:==

'''Chat:Talkbox:command'''

/dialogs/Talkbox.lua/okclick

data = { command=command, params=params, talkbox=self}

Allows the addition of new chat commands.

'''Entity:loadList'''

/Entity.lua/loadList

data = { file=file, no_default=no_default, res=res, mod=mod, loaded=loaded}

Useful for adding new entries into a list file, without overwriting it.

'''MapGeneratorStatic:subgenRegister'''

/generator/map/Static.lua/generate

data = { mapfile=self.data.map, list=self.subgen}

Something for adding in new things to map generation?

==Module Hooks:==

'''Actor:actBase:Effects'''

/mod/class/Actor.lua/actBase

data = { }

Triggers when the actor does anything. Useful for anything with a constant effect. self is the actor doing the action.

'''Actor:move'''

/mod/class/Actor.lua/move

data = { moved=moved, force=force, ox=ox, oy=oy}

Triggers when an actor moves.

'''Actor:takeHit'''

/mod/class/Actor.lua/onTakeHit

data = { value=value, src=src}

Triggers when an actor is hit by something. It's useful mostly for talents and effects that alter or avoid damage being recieved on a particular actor. self in this case is the thing being hit. data.value
contains the amount of damage taken.

'''Actor:preUseTalent'''

/mod/class/Actor.lua/preUseTalent

data = { t=ab, silent=silent, fale=fake}

Triggers whenever an actor tries to use a talent, but before the talent is run. Useful for new resources or failure effects.

'''Actor:postUseTalent'''

/mod/class/Actor.lua/postUseTalent

data = { t=ab, ret=ret, trigger=trigger}

Triggers after an actor successfully uses a talent. Useful for new resources types.

'''Actor:getTalentFullDescription:ressources'''

/mod/class/Actor.lua/getTalentFullDescription

data = {str=d, t=t, addlevel=addlevel, config=config, fake_mastery=fake_mastery}

This is where you add code to make your new resource display.

'''Actor:getTalentFullDescription'''

/mod/class/Actor.lua/getTalentFullDescription

data = { str=d, t=t, addlevel=addlevel, config=config, fake_mastery=fake_mastery}

Let's you add something else just above the talent description.

'''ToME:run'''

/mod/class/Game.lua/run

data = { }

See ToME run. Run ToME run! Inserts code before the module starts running.

'''Game:alterGameMenu'''

/mod/class/Game.lua/setupCommands

data = { menu=l, unregister=function() self:unregisterDialog(menu) end}

Allows editing of the escape menu.

'''Combat:archeryAcquire'''

/mod/class/interface/Archery.lua/archeryAcquireTargets

data = { tg=tg, params=params, weapon=weapon, ammo=a}

Similar to Combat:attackTarget but with ranged weapons.

'''Combat:archeryHit'''

/mod/class/interface/Archery.lua/archery_projectile

data = { hitted=hitted, target=target, weapon=weapon, ammo=ammo, damtype=damtype, mult=mult, dam=dam}

Triggers when a projectile hits an actor.

'''Combat:attackTarget'''

/mod/class/interface/Combat.lua/attackTarget

data = { target=target, damtype=damtype, mult=mult, noenergy=noenergy}

Triggers when the actor starts to attack but before anything actually happens to weapons are taken into account. Useful for effects that prevent attacking. self is the actor trying to attack, data.target is his
target, data.damtype is the damage type being applied.

Return false to continue the attack without modifying it.

Return true to take into account changes made in the hook.
You can change data.mult and data.damtype to modify damage characteristics.

To cancel the attack set data.stop to true and data.hit to false and return true.

'''Combat:attackTargetWith'''

/mod/class/interface/Combat.lua/attackTargetWith

data = { hitted=hitted, crit=crit, target=target, weapon=weapon, damtype=damtype, mult=mult, dam=dam}

Triggers when the actor makes an attack after the weapon and whether it hits or not has been taken into account. Useful for just about any effect or skill that triggers on attack. self is the actor attacking,
data.target is the target being hit, data.hitted is whether or not the attack hit the target, and data.dam, data.damtype, and data.weapon should be self-evident.

'''Combat:attackTargetWith:attackerBonuses'''

/mod/class/interface/Combat.lua/attackTargetWith

data = { target=target, weapon=weapon, damtype=damtype, mult=mult, dam=dam, apr=apr, atk=atk, def=def, armor=armor}

Triggers when processing an actor attack before the damage computation.
Useful to take into account bonuses of the attacker and/or the target.
data.target is the target being hit, other parameters should be self-evident.

'''ToME:PlayerDumpJSON'''

/mod/class/interface/PlayerDumpJSON.lua/dumpToJSON

data = { title=title, js=js, tags=tags}

I'm guessing its for appending something to the character data before it is sent to the server.

'''Object:descCombat'''

/mod/class/Object.lua/getTextualDesc

data = { compare_with=compare_with, compare_fields=compare_fields, compare_table_fields=compare_table_fields, desc=desc, combat=combat}

Useful for editing the combat stats in an objects tooltips.

'''Object:descWielder'''

/mod/class/Object.lua/getTextualDesc

data = { compare_with=compare_with, compare_fields=compare_fields, compare_table_fields=compare_table_fields, desc=desc, w=w}

Useful for editing the weilder stats in an objects tooltips.

'''Object:descMisc'''

/mod/class/Object.lua/getTextualDesc

data = { compare_with=compare_with, compare_fields=compare_fields, compare_table_fields=compare_table_fields, desc=desc, object=self}

Should you want to add anything right at the bottom of an items tooltip, this hook is for you.

'''Object:descPowerSource'''

/mod/class/Object.lua/getDesc

data = { desc=desc, object=self}

Want to add in new power sources? Use this.

'''UISet:Minimalist:saveSettings'''

/mod/class/uiset/Minimalist.lua/saveSettings

data = { lines=lines}

Not sure, could be for adding framework for dealing with new settings.

'''UISet:Minimalist:Resources'''

/mod/class/uiset/Minimalist.lua/displayResources

data = { a=a, player=player, x=x, y=y, bx=bx, by=by, orient=orient, scale=scale}

Use for adding new resource bars.

'''UISet:Minimalist:Toolbar'''

/mod/class/uiset/Minimalist.lua/displayToolbar

data = { x=x, y=y, bx=bx, by=by, orient=orient, scale=scale, tb_bg=tb_bg}

Something for hooking code into the display of the toolbar. For what end, I have no idea.

'''DebugMain:use'''

/mod/dialogs/debug/DebugMain.lua/use

data = { act=act}

Use to code new debug commands.

'''DebugMain:generate'''

/mod/dialogs/debug/DebugMain.lua/generateList

data = { menu=list}

Use to add new commands to the debug menu.

'''DonationDialog:features'''

/mod/dialogs/Donation.lua/init

data = { list=donation_features}

Use to add new features to the list of donator features.

'''GameOptions:HUDs'''

/mod/dialogs/GameOptions.lua/generateList

data = { huds=huds}

Allows the addition of new HUD types to the HUD menu.

'''PlayerLevelup:addTalentType'''

/mod/dialogs/LevelupDialog.lua/learnType

data = { actor=self.actor, tt=tt}

Triggers when a player spends a category point in a category.

'''PlayerLevelup:subTalentType'''

/mod/dialogs/LevelupDialog.lua/learnType

data = { actor=self.actor, tt=tt}

Triggers when a player changes their mind and unspends a category point.

'''EquipInvenDialog:makeUI'''

/mod/dialogs/ShowEquipInven.lua/init

self:triggerHook{"EquipInvenDialog:makeUI", uis=uis}

Triggers during inventory screen creation. I guess it lets you edit it.

'''UseItemMenu:use'''

/mod/dialogs/UseItemDialog.lua/use

data = { actor=self.actor, object=self.object, inven=self.inven, item=self.item, act=act, onuse=self.onuse}

Use to add code for new menu items.

'''UseItemMenu:generate'''

/mod/dialogs/UseItemDialog.lua/generateList

data = { actor=self.actor, object=self.object, inven=self.inven, item=self.item, menu=list}

Use to add new menu items to the item action menu.

'''ToME:load'''

/mod/load.lua

data = { }

This is where you load up new files for your addon.

'''Quest:escort:reward'''

/data/chats/escort-quest.lua/reward_types

data = { reward_types=reward_types}

Allows editing of the escort rewards.

'''DamageProjector:base'''

/data/damage_types.lua/setDefaultProjector

data = { src=src, x=x, y=y, type=type, dam=dam}

'''DamageProjector:final'''

/data/damage_types.lua/setDefaultProjector

data = { src=src, x=x, y=y, type=type, dam=dam}

These are similar, but trigger slightly differently. Both trigger when the damage projector is used to put damage on something, such as a spell or other effect. The first one triggers before any other skills
effects, or calculations are taken into consideration. The other one takes place after this is all done and right before the damage is actually applied. In both cases, data.src is the actor doing the damage,
data.x and data.y are the locations of the target, data.type is the damage type and data.dam is the actual amount of damage.

'''Quest:escort:assign'''

/data/quests/escort-duty.lua/on_grant

data = { possible_types=possible_types}

This is where you add in (or remove) escortee types.

Hooks

2018-02-05T23:03:46Z

Ghostbuster: Changed the description of hook Combat:attackTarget that was clearly incorrect according to the code.

[[Category:Development]][[Category:Addons]]
For addons, hooks are a way of causing certain code to be triggered by events happening in the game.

They are all used the same way, with "ToME:load" being replaced with the actual hook name:

class:bindHook("ToME:load", function(self, data)
your code
end

If the hook function has any arguments, they are accessed through the data variable like data.argumentname .

Here is a list of hooks currently available for addon creators and what they do.

'''ToME:load'''
Triggers when ToME loads up. Used to load an addons files into the game. Must be included in every addon or the addon will not work!
There are a few important functions you'll want to trigger to make the magic happen.

* ''Birther:loadDefinition'' will load a new race or class
* ''ActorTalents:loadDefinition'' will load new talents for your new race, class, or monster to use
* ''DamageType:loadDefinition'' will load new damage types for your talents to use
* ''ActorTemporaryEffects:loadDefinition'' will load new temporary effect, bad or good, to be used by talents and damage types
* ''WorldAchievements:loadDefinition'' loads new achievement. Not commonly used in addons
* ''PlayerLore:loadDefinition'' adds new lore to be collected by the player. Not commonly used in addons
* ''PartyIngredients:loadDefinition'' loads new ingredients to be collected by the player for reciptes. Not commonly used in addons.

So for example if we want a new class called "Pilgrim" with it's own unique talents, but no new damage types or effects, we could load it like so.

class:bindHook("ToME:load", function(self, data)
ActorTalents:loadDefinition("/data-classpack/talents/techniques/techniques-pilgrim.lua")
Birther:loadDefinition("/data-classpack/birth/pilgrim.lua")
end)

==Engine Hooks:==

'''Chat:Talkbox:command'''

/dialogs/Talkbox.lua/okclick

data = { command=command, params=params, talkbox=self}

Allows the addition of new chat commands.

'''Entity:loadList'''

/Entity.lua/loadList

data = { file=file, no_default=no_default, res=res, mod=mod, loaded=loaded}

Useful for adding new entries into a list file, without overwriting it.

'''MapGeneratorStatic:subgenRegister'''

/generator/map/Static.lua/generate

data = { mapfile=self.data.map, list=self.subgen}

Something for adding in new things to map generation?

==Module Hooks:==

'''Actor:actBase:Effects'''

/mod/class/Actor.lua/actBase

data = { }

Triggers when the actor does anything. Useful for anything with a constant effect. self is the actor doing the action.

'''Actor:move'''

/mod/class/Actor.lua/move

data = { moved=moved, force=force, ox=ox, oy=oy}

Triggers when an actor moves.

'''Actor:takeHit'''

/mod/class/Actor.lua/onTakeHit

data = { value=value, src=src}

Triggers when an actor is hit by something. It's useful mostly for talents and effects that alter or avoid damage being recieved on a particular actor. self in this case is the thing being hit. data.value
contains the amount of damage taken.

'''Actor:preUseTalent'''

/mod/class/Actor.lua/preUseTalent

data = { t=ab, silent=silent, fale=fake}

Triggers whenever an actor tries to use a talent, but before the talent is run. Useful for new resources or failure effects.

'''Actor:postUseTalent'''

/mod/class/Actor.lua/postUseTalent

data = { t=ab, ret=ret, trigger=trigger}

Triggers after an actor successfully uses a talent. Useful for new resources types.

'''Actor:getTalentFullDescription:ressources'''

/mod/class/Actor.lua/getTalentFullDescription

data = {str=d, t=t, addlevel=addlevel, config=config, fake_mastery=fake_mastery}

This is where you add code to make your new resource display.

'''Actor:getTalentFullDescription'''

/mod/class/Actor.lua/getTalentFullDescription

data = { str=d, t=t, addlevel=addlevel, config=config, fake_mastery=fake_mastery}

Let's you add something else just above the talent description.

'''ToME:run'''

/mod/class/Game.lua/run

data = { }

See ToME run. Run ToME run! Inserts code before the module starts running.

'''Game:alterGameMenu'''

/mod/class/Game.lua/setupCommands

data = { menu=l, unregister=function() self:unregisterDialog(menu) end}

Allows editing of the escape menu.

'''Combat:archeryAcquire'''

/mod/class/interface/Archery.lua/archeryAcquireTargets

data = { tg=tg, params=params, weapon=weapon, ammo=a}

Similar to Combat:attackTarget but with ranged weapons.

'''Combat:archeryHit'''

/mod/class/interface/Archery.lua/archery_projectile

data = { hitted=hitted, target=target, weapon=weapon, ammo=ammo, damtype=damtype, mult=mult, dam=dam}

Triggers when a projectile hits an actor.

'''Combat:attackTarget'''

/mod/class/interface/Combat.lua/attackTarget

data = { target=target, damtype=damtype, mult=mult, noenergy=noenergy}

Triggers when the actor starts to attack but before anything actually happens to weapons are taken into account. Useful for effects that prevent attacking. self is the actor trying to attack, data.target is his
target, data.damtype is the damage type being applied.
Return false to continue the attack without modifying it.
Return true to take into account changes made in the hook.
You can change data.mult and data.damtype to modify damage characteristics.
To cancel the attack set data.stop to true and data.hit to false and return true.

'''Combat:attackTargetWith'''

/mod/class/interface/Combat.lua/attackTargetWith

data = { hitted=hitted, crit=crit, target=target, weapon=weapon, damtype=damtype, mult=mult, dam=dam}

Triggers when the actor makes an attack after the weapon and whether it hits or not has been taken into account. Useful for just about any effect or skill that triggers on attack. self is the actor attacking,
data.target is the target being hit, data.hitted is whether or not the attack hit the target, and data.dam, data.damtype, and data.weapon should be self-evident.

'''Combat:attackTargetWith:attackerBonuses'''

/mod/class/interface/Combat.lua/attackTargetWith

data = { target=target, weapon=weapon, damtype=damtype, mult=mult, dam=dam, apr=apr, atk=atk, def=def, armor=armor}

Triggers when processing an actor attack before the damage computation.
Useful to take into account bonuses of the attacker and/or the target.
data.target is the target being hit, other parameters should be self-evident.

'''ToME:PlayerDumpJSON'''

/mod/class/interface/PlayerDumpJSON.lua/dumpToJSON

data = { title=title, js=js, tags=tags}

I'm guessing its for appending something to the character data before it is sent to the server.

'''Object:descCombat'''

/mod/class/Object.lua/getTextualDesc

data = { compare_with=compare_with, compare_fields=compare_fields, compare_table_fields=compare_table_fields, desc=desc, combat=combat}

Useful for editing the combat stats in an objects tooltips.

'''Object:descWielder'''

/mod/class/Object.lua/getTextualDesc

data = { compare_with=compare_with, compare_fields=compare_fields, compare_table_fields=compare_table_fields, desc=desc, w=w}

Useful for editing the weilder stats in an objects tooltips.

'''Object:descMisc'''

/mod/class/Object.lua/getTextualDesc

data = { compare_with=compare_with, compare_fields=compare_fields, compare_table_fields=compare_table_fields, desc=desc, object=self}

Should you want to add anything right at the bottom of an items tooltip, this hook is for you.

'''Object:descPowerSource'''

/mod/class/Object.lua/getDesc

data = { desc=desc, object=self}

Want to add in new power sources? Use this.

'''UISet:Minimalist:saveSettings'''

/mod/class/uiset/Minimalist.lua/saveSettings

data = { lines=lines}

Not sure, could be for adding framework for dealing with new settings.

'''UISet:Minimalist:Resources'''

/mod/class/uiset/Minimalist.lua/displayResources

data = { a=a, player=player, x=x, y=y, bx=bx, by=by, orient=orient, scale=scale}

Use for adding new resource bars.

'''UISet:Minimalist:Toolbar'''

/mod/class/uiset/Minimalist.lua/displayToolbar

data = { x=x, y=y, bx=bx, by=by, orient=orient, scale=scale, tb_bg=tb_bg}

Something for hooking code into the display of the toolbar. For what end, I have no idea.

'''DebugMain:use'''

/mod/dialogs/debug/DebugMain.lua/use

data = { act=act}

Use to code new debug commands.

'''DebugMain:generate'''

/mod/dialogs/debug/DebugMain.lua/generateList

data = { menu=list}

Use to add new commands to the debug menu.

'''DonationDialog:features'''

/mod/dialogs/Donation.lua/init

data = { list=donation_features}

Use to add new features to the list of donator features.

'''GameOptions:HUDs'''

/mod/dialogs/GameOptions.lua/generateList

data = { huds=huds}

Allows the addition of new HUD types to the HUD menu.

'''PlayerLevelup:addTalentType'''

/mod/dialogs/LevelupDialog.lua/learnType

data = { actor=self.actor, tt=tt}

Triggers when a player spends a category point in a category.

'''PlayerLevelup:subTalentType'''

/mod/dialogs/LevelupDialog.lua/learnType

data = { actor=self.actor, tt=tt}

Triggers when a player changes their mind and unspends a category point.

'''EquipInvenDialog:makeUI'''

/mod/dialogs/ShowEquipInven.lua/init

self:triggerHook{"EquipInvenDialog:makeUI", uis=uis}

Triggers during inventory screen creation. I guess it lets you edit it.

'''UseItemMenu:use'''

/mod/dialogs/UseItemDialog.lua/use

data = { actor=self.actor, object=self.object, inven=self.inven, item=self.item, act=act, onuse=self.onuse}

Use to add code for new menu items.

'''UseItemMenu:generate'''

/mod/dialogs/UseItemDialog.lua/generateList

data = { actor=self.actor, object=self.object, inven=self.inven, item=self.item, menu=list}

Use to add new menu items to the item action menu.

'''ToME:load'''

/mod/load.lua

data = { }

This is where you load up new files for your addon.

'''Quest:escort:reward'''

/data/chats/escort-quest.lua/reward_types

data = { reward_types=reward_types}

Allows editing of the escort rewards.

'''DamageProjector:base'''

/data/damage_types.lua/setDefaultProjector

data = { src=src, x=x, y=y, type=type, dam=dam}

'''DamageProjector:final'''

/data/damage_types.lua/setDefaultProjector

data = { src=src, x=x, y=y, type=type, dam=dam}

These are similar, but trigger slightly differently. Both trigger when the damage projector is used to put damage on something, such as a spell or other effect. The first one triggers before any other skills
effects, or calculations are taken into consideration. The other one takes place after this is all done and right before the damage is actually applied. In both cases, data.src is the actor doing the damage,
data.x and data.y are the locations of the target, data.type is the damage type and data.dam is the actual amount of damage.

'''Quest:escort:assign'''

/data/quests/escort-duty.lua/on_grant

data = { possible_types=possible_types}

This is where you add in (or remove) escortee types.

Callback

2018-02-05T18:48:34Z

Ghostbuster: Fixed an error in callBack OnArcheryHit

[[Category:Development]][[Category:Addons]]
<big>Callbacks allow you to execute a batch of code at certain points of the game. Such as when you're healed, when you're taking damage, or when you've moved.</big>

Callbacks can be used in Talents, Timed Effects, or Items.
Callbacks only happen if;

An Actor has the Talent learnt, if its an Active or Passive.

An Actor has the Talent sustained, if its a Sustain.

An Actor has the Timed Effect on them.

An Actor has the item equipped.

To use a Callback, simply insert one into your talent, timed effect, or item like you would any function.

If the Callback has additional arguments, add them onto the end, after your first two arguments.

Talent callbacks use (self, t)

Timed Effect callbacks use (self, eff)

Item callbacks use (self, who)

In the case of Item callbacks, 'self' refers to the item itself, while 'who' refers to the actor wearing said item.

Provided below is a simple example of a Talent callback.

e.g. callbackOnMeleeAttack = function(self, t, target, hitted, crit, weapon, damtype, mult, dam)
if hitted and crit then
self:heal(dam/2)
end
end,

The result of this particular callback is that you would heal yourself for half the damage dealt every time you land a melee attack that crits.
You could use the same callback in an effect by replacing 't' (which represents the talent making the call) with 'eff' (which represents the effect making the call).

However, converting this into an Item callback is slightly more tricky. First you must change 't' to 'who' (which is the actor wearing the item). You would than need to change all references to 'self' in the code to 'who' to achive the same effect, as 'self' now refers to the item this callback is attached to.

callbackOnMeleeAttack = function(self, who, target, hitted, crit, weapon, damtype, mult, dam)
if hitted and crit then
who:heal(dam/2)
end
end,

List of callbacks in 1.2.5:

'''Actor.lua'''

-- Called once per global turn.

callbackOnActBase()

-- Called whenever an Actor begins their turn.

callbackOnAct()

-- Called whenever an Actor moves.

callbackOnMove(moved, force, ox, oy, x, y)

moved(was a move completed? this can be tricky; we may technically 'move' and still be in the same spot)

force(did somebody force us to move?)

ox, oy(our starting location)

x, y(where we moved to, or tried to move to (i.e. if we bump into a wall this will be the x and y of the wall)

*Note* If you want the callback to check if the actor actually moved from one tile to another, make sure you include an if statement that compares the starting location (ox and oy) to the actor's location (self.x and self.y).
Something like: ...if not (self.x == ox and self.y == oy) then...


-- Called whenever an Actor is healed.

callbackOnHeal(value, src)

value(amount healed)

src(source of the healing)

-- Called whenever an Actor takes damage. This happens at the end of onTakeHit, and right before the damage is actually dealt.

callbackOnHit(cb, src, death_note)

Special note: This passes along the damage dealt under cb.value. Make any changes you want to cb.value, than return cb, if you wish to change the damage dealt.

src(source of the damage)

death_note()

-- Called whenever an Actor deals damage.

callbackOnDealDamage(val, target, dead, death_note)

val(damage dealt)

target(who you're hitting)

dead(did the attack kill your target?)

death_note()

-- Called whenever an Actor dies.

callbackOnDeath(src, death_note)

src(who killed us?)

death_note()

-- Called whenever a Summon of an Actor dies.

callbackOnSummonDeath(summon, src, death_note)

summon(our summon)

src(who killed our summon?)

death_note()

-- Called whenever an Actor kills something.

callbackOnKill(src, death_note)

src(who we killed)

death_note()

-- Called whenever an Actor has a stat changed.

callbackOnStatChange(stat, v)

stat(the stat that was changed)

v(the value of the change)

-- Called whenever an Actor wears something.

callbackOnWear(o, bypass_set)

o(the object worn)

bypass_set()

-- Called whenever an Actor takes something off.

callbackOnTakeoff(o, bypass_set)

o(the object removed)

bypass_set()

-- Called whenever a magical or natural talent fails to activate.

callbackOnTalentDisturbed(ab)

ab(the talent that failed)

-- Called after a talent is used.

callbackOnTalentPost(ab, ret, silent)

ab(the talent that was used)

ret(whatever the talent returned)

Special note: Unless we are a sustain, we will fail if our talent returns anything but true.

silent()

-- Called whenever a sustain deactivates due to talent usage.

callbackBreakOnTalent(ab)

ab(the talent that was deactivated)

-- Called whenever a temporary effect tries to be applied.

callbackOnTemporaryEffect(eff_id, e, p)

eff_id(the effect id)

e(the base effect info, as shown in its timed_effect file)

p(the effect being applied, such as duration)

'''Archery.lua'''

-- Called whenever an archery attack hits us.

callbackOnArcheryHit(dam, src)

(dam, damage dealt. src, who hit us?)

-- Called whenever an archery attack misses us.

callbackOnArcheryMiss(src)

src(who failed to hit us?)

-- Called whenever an archery attack happens.

callbackOnArcheryAttack(target, hitted, crit, weapon, ammo, damtype, mult, dam)

target(who is being hit?)

hitted(did we hit?)

crit(did we crit?)

weapon(our weapon)

ammo(our ammo)

damtype(what type of damage did we do?)

mult(our damage multiplier)

dam(the damage dealt)

'''Combat.lua'''

-- Called whenever an enemy hits us with a melee attack.

callbackOnMeleeHit(target, dam)

Special note: target in this case is the enemy making the attack, not the attack's target (which would be you).

dam( damage dealt by the attack)

-- Called whenever an enemy misses us with a melee attack.

callbackOnMeleeMiss(target, dam)

Special note: target in this case is the enemy making the attack, not the attack's target (which would be you).

dam(our damage dealt)

-- Called whenever a melee attack happens.

callbackOnMeleeAttack(target, hitted, crit, weapon, damtype, mult, dam)

target(who is being hit?)

hitted(did we hit?)

crit(did we crit?)

weapon(our weapon)

damtype(what type of damage did we do?)

mult(our damage multiplier)

dam(the damage dealt)

-- Called whenever we crit.

callbackOnCrit(type, dam, chance, target)

Special note: type refers to either "physical" "spell" or "mind".

Special note 2: Only "physical" also returns a target along with it. Spell and mind do not.

dam(the damage dealt)

chance(the chance of the crit happening)

target(who did we hit?)

'''Player.lua'''

-- Called whenever we try to rest.

callbackOnRest(status)

Special note: status can either return "start" "stop" or "check".

"start" and "stop" simply allow you to do whatever you wish.

"check" will ask you to return either true or false. True will stop resting from ending.

-- Called whenever we run. (shift + direction)

callbackOnRun()

Special note: We will be unable to run if True is returned.

'''damage_types.lua'''

-- Called before we take damage. We can completely stop damage from ever happening from here.

callbackOnTakeDamage(src, x, y, type, dam, tmp, no_martyr)

Special note: This callback expects you to return a table. For our example's case, our table will be called 'data'.

You may return either data.dam or data.stopped. data.dam will behave just like you were passing the damage on, while data.stopped will stop the damage completely.

If stopped is a numerical value, the damage dealt will be set to this value before stopping.

stopped has a higher priority than dam, and dam will not directly impact stopped.

src(who is hitting us)

x, y(where is the damage happening?)

type(what damage type is hitting us?)

dam(how much are we being hit for?)

tmp()

no_martyr(set to true if your effect has the slightest chance of looping forever, usually due to dealing damage back)

Resource

2015-12-10T17:02:57Z

Ghostbuster:

[[Category:Game Mechanics]] [[Category:Resources]]

{{Spoilers}}

Resources are power pools used for various [[talents]] in ToME 4. There are several different kinds of resources, and some of them have unique behaviors. Several resources are affected by [[Fatigue]].

==Air==
Only appears when you can't breathe for some reason. Being underwater, in a wall, or buried in sand will generally prevent you from breathing. You take an increasingly large amount of damage each turn after reaching 0 Air. Some items allow you to breathe underwater, or remove the need to breathe at all. Some underwater areas will have bubbles that can restore air until they are depleted.

Most characters have 100 air, with [[yeek]] characters having 200. Two artifacts, [[Coral Spray]] and [[Vargh Redemption]] will raise the cap by 50 air.
* The first turn you are underwater your air will drop by 5 and will then decrease by 2 each subsequent turn.
* The first turn you are in a wall your air will drop by 20 and will then decrease by 17 each subsequent turn.
* The first turn you are buried in sand your air will drop by 10 and will then decrease by 7 each subsequent turn.
* When you can breathe again normally you regain 3 air per turn.
* Underwater bubbles will restore 20 per turn (minus the loss of 2 from being underwater, for a total gain of 18).
* When your air runs out you begin taking damage. The first turn it is 20% of your max life and it increases by 5% each turn (so 25% on the second turn, 30% on the third). This is quickly fatal.

==Equilibrium==
Equilibrium is the [[resources|resource]] used by the [[Wild-gift (category type)|Wild Gift]] talents, and represents how far the character is out of balance with Nature. It is sometimes abbreviated "EQ".

Equilibrium starts at 0, and is raised by talent use; a high Equilibrium increases the chance of failure. If Equilibrium exceeds [[Willpower]], an attempt to use a Wild Gift talent has a (sqrt(Equilibrium - Willpower) / 60) chance to fizzle, causing the loss of a turn.

Equilibrium does not naturally reduce itself over time, but it can be restored by:
* Walking on the wilderness map
* Standing in the area of effect of a Font of Life
* [[Meditation (talent)|Meditating]]
* [[Swallow (talent)|Swallowing]] enemies
* Being hit while [[Resolve (talent)|Resolve]] is active but [[Antimagic shield (talent)|Antimagic Shield]] is not
* Coming under a life regeneration effect while under the influence of [[Ancestral life (talent)|Ancestral Life]]
* Being hit while wearing various [[egos|equipment with on-hit EQ regeneration]]

Note that if a player/creature has an [[Equilibrium]] bar, using [[Vim|Vim-based]] talents will increase it by a noticeable amount.

==Feedback==
Feedback represents using pain as a means of psionic grounding and it can be used to power feedback abilities. Characters that have the feedback resource will gain feedback in proportion to any damage received. The base conversion rate depends on character level: it starts at 50% at level 1, and decays to 20% at level 50. Feedback is used by the [[Solipsist]]'s [[Feedback (category)|Feedback]] and [[Discharge (category)|Discharge]] talent trees. It decays at the rate of 10% or 1 per turn (whichever is greater).

==Hate==
Hate is the [[resources|resource]] used by the Afflicted classes, the [[Cursed]] and the [[Doomed]]. Hate does not regenerate, and even decays over time. It is mainly recovered while fighting. Hate is affected by [[fatigue]].

You can have up to 100 points of hate. Afflicted suffer from reduced healing while not at maximum hate -- by 50% at zero hate. Your Hate slowly decays (more quickly when the level is higher), down to a minimum of half your Hate at the end of the most recent combat. The strengths of many abilities also depend on your level of Hate.

Here are some ways Hate is regained:

* '''Kill something''': 8 points, more for higher [[rank]] -- 24 points for a boss
* '''Take a big hit''' (over 15% of your maximum life): 2 points + 2 points per 5% life lost above 15%
* '''Take a hit while at low health''' (under 25% of maximum life): 4 points
* '''Do massive damage''' (over 33% in one hit)

The Doomed [[Dark sustenance (category)|Dark Sustenance]] tree has the talent [[Feed (talent)|Feed]], which can be used to replenish hate. Various Cursed talents also give Hate bonuses.

==Life==
{{:Life}}

==Mana==
Used by most of the magical spell talents. It works much like Spell Points or Mana in most other RPGs. Only Mage classes can regenerate Mana naturally. Certain class talents and gear can grant passive Mana regen, and having a Manasurge rune inscribed will grant some passive regen while resting. Your maximum increases with level (+4 per level), gear, and [[Willpower]] (+5 per point).

==Necrotic==
Used by [[Necromancer|Necromancers]], and represents the number of souls caught within the necrotic aura. Each soul can become an undead minion. The pool is replenished by killing living beings within the necrotic aura.

==Negative energy==
Negative energy is the power source for predominantly-[[Anorithil]] talents. [[Necromancer]]s can also get access to the tree by becoming a [[Lich]].

It can be replenished by Anorithil using:
* [[Twilight (talent)|Twilight]]: 15 positive, 6 cooldown, recover (20 + 0.4 * talent * cunning) negative energy
* [[Twilight surge (talent)|Twilight Surge]]: recover 20 negative and 10 positive energy
among other ways.

Liches will regenerate negative energy over time, whereas Anorithil and Adventurers lose negative energy over time.

Maximum negative energy is increased by 3 whenever a character gains a level.

==Paradox==
Paradox is the resource used by the Chronomancy talents. It is somewhat like [[Equilibrium]] -- it starts at 0, and increases as talents are used. High paradox causes failures, anomalies, and backfires, but also increases the power of some talents. The damage (and sometimes duration, etc) of most Chronomancy talents is multiplied by a "paradox modifier" determined by the following formula: sqrt(0.5 + Paradox / 600).

The cost of active paradox talents increases the higher your paradox already is; it is multiplied by 1 + (Paradox / 300).

Paradox failures simply cause you to lose a turn like equilibrium failures. However, unlike equilibrium failures, your paradox still increases by the cost of the talent that failed.

If an anomaly occurs, not only do you lose the turn and talent, but a random Anomaly talent is used. Your paradox is also reduced by twice the cost of the talent that failed. Anomaly chance is rolled before failure chance.

If a backfire occurs, the talent targets the caster.

To calculate paradox failure, anomaly, and backfire chance, first calculate modified paradox by the following formula: (Paradox - [[Willpower]] * Willpower_modifier). Some items, such as the Shard of Crystallized Time, add directly to the Willpower stat used in this calculation, as does Temporal Form. Willpower_modifier is 1 + ([[Paradox mastery (talent)|Paradox Mastery]] talent level / 10).

Then calculate the fatigue modifier: (100 + 2 * [[Fatigue]]) / 100.

Failures can only occur if modified paradox is over 200; if so, the chance is ceil(fatigue_modifier * (modified_paradox / 200)^2).

Anomalies can only occur if modified paradox is over 300; if so, the chance is ceil(fatigue_modifier * (modified_paradox / 300)^3).

Backfires can only occur if modified paradox is over 400; if so, the chance is ceil(fatigue_modifier * (modified_paradox / 400)^4).

==Positive energy==
Positive energy is a resource used by both of the [[Celestial (Metaclass)|Celestial]] classes (the [[Sun Paladin|Sun Paladins]] and [[Anorithil]]). Many early talents will actually replenish it rather than drain it, shown as negative numbers in costs. It decreases over time if not used.

The size of the positive energy pool (max positive energy) is increased by 3 whenever a character gains a level.

==Psi==
Psi is the resource used by Psionic classes, such as [[Solipsist]] and [[Mindslayer]]. It slowly regenerates over time, can be restored by talents and some equipment. Mind damage type reduces psi (if left) instead of health. Players can increase psi pool by raising willpower (+1 per point invested in willpower except for the [[Solipsist]] class).

==Stamina==
Stamina is the resource used by most physical talents. It is regenerated at a rate of 0.3 per turn if there are no other modifiers. Resting will accelerate the rate at which stamina is recovered. Stamina capacity is increased by raising willpower (+2.5 max stamina per point) and when gaining a level (+3 max stamina per level).

==Vim==
Vim is the resource used by the [[Defiler]] metaclass. Vim does not regenerate but is instead regained in several ways, all involving combat. [[Fatigue]] plays no role in determining vim costs. The vim pool grows by 4 points every level and is not influenced by any stats.

Ways of regaining vim:

* '''Kill bounty:''' Each kill returns one point of vim per 20 [[Willpower]].
* '''Kill refunds:''' If you kill something directly with a vim-using talent, the talents cost in vim is restored. This ''only'' works with straight damage -- infecting someone with a disease won't return any vim this way, even if your victim dies from it three rounds later. Though if you kill something with a Bone Nova, for example, you will get its cost refunded.
* '''Special Talents:''' Some talents can also restore your vim, such as [[Drain (talent)|Drain]] and [[Leech (talent)|Leech]].