A quick description of Callbacks, from a person who knows nothing:

"They are like Superloads or Hooks, but more focused."

To use a Callback, simply insert one into your talent (or timed_effect) just like you would anything else.

If the Callback has additional arguements, add them onto the end, after the normal (self, t) or (self, eff).

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(did we actually move?)

force(did somebody force us to move?)

ox, oy(our starting location)

x, y(where we moved to

-- 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, self, dead, death_note)

val(damage dealt)

self(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(self, src, death_note)

Special note: self in this case is referring to your summon. Do not confuse this with your actual self.

src(who killed our summon?)

death_note()

-- Called whenever an Actor kills something.

callbackOnKill(self, death_note)

Special note: self in this case is referring to who died. Do not confuse this with your actual, living, self.

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(self)

Special note: self in this case is whoever was shooting at you. Do not confuse this with yourself.

-- Called whenever an archery attack misses us.

callbackOnArcheryMiss(self)

Special note: self in this case is whoever was shooting at you. Do not confuse this with yourself.

-- 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(self, dam)

Special note: self in this case is whoever was attacking you. Do not confuse this with yourself.

dam(our damage dealt)

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

callbackOnMeleeMiss(self, dam)

Special note: self in this case is whoever was attacking you. Do not confuse this with yourself.

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: You can 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.

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)

Callback

2015-03-08T06:08:38Z

StarKeep:

A quick description of Callbacks, from a person who knows nothing:

"They are like Superloads or Hooks, but more focused."

To use a Callback, simply insert one into your talent (or timed_effect) just like you would anything else.

If the Callback has additional arguements, add them onto the end, after the normal (self, t) or (self, eff).

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(did we actually move?)

force(did somebody force us to move?)

ox, oy(our starting location)

x, y(where we moved to

-- 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, self, dead, death_note)

val(damage dealt)

self(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(self, src, death_note)

Special note: self in this case is referring to your summon. Do not confuse this with your actual self.

src(who killed our summon?)

death_note()

-- Called whenever an Actor kills something.

callbackOnKill(self, death_note)

Special note: self in this case is referring to who died. Do not confuse this with your actual, living, self.

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(self)

Special note: self in this case is whoever was shooting at you. Do not confuse this with yourself.

-- Called whenever an archery attack misses us.

callbackOnArcheryMiss(self)

Special note: self in this case is whoever was shooting at you. Do not confuse this with yourself.

-- 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(self, dam)

Special note: self in this case is whoever was attacking you. Do not confuse this with yourself.

dam(our damage dealt)

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

callbackOnMeleeMiss(self, dam)

Special note: self in this case is whoever was attacking you. Do not confuse this with yourself.

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("special")

Special note: "special" 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: You can 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.

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)

Debugging

2013-11-08T05:02:16Z

StarKeep: /* Lua console */

=== Debugging: Figuring out what went wrong ===

==== Updating your configuration ====
Enabling cheat/development mode will grant you access to the internal Lua console and some additional dialogs/options useful for debugging. It will stop you from uploading characters online, though, but you can always turn this mode off.

<ul>
<li>Navigate to the corresponding configuration directory (replace HOME with your home directory).

{| class="wikitable"
| Windows || HOME\T-Engine\4.0\settings
|-
| Linux || HOME/.t-egine/4.0/settings
|-
| Mac OSX || HOME\Library\Application Support\T-Engine\4.0\settings
|}
</li>
<li>Create a file called ''cheat.cfg'' in that directory, and put the following text in that file.
<pre>
cheat = true
</pre>
<li>
To turn cheat/development mode off, just change ''true'' to ''false'' or delete the ''cheat.cfg'' file.
</li>
</ul>

==== Inside of ToME ====

{| class="wikitable"
! Key Shortcut !! Result
|-
| Ctrl+L || Lua console
|-
| Ctrl+A || Debug dialog
|-
| Ctrl+S || save the game
|-
| Ctrl+Alt+Shift+R || Reload the last save
|}

NOTE: The keybinding may not be set, in this case you have to bind it yourself first.

==== Lua console ====

Summary of features:
* Inspect values and execute code
* Cursor positioning
* Tab auto-completion
* Copy and paste with system clipboard

The Lua console drops you into the global namespace and gives you access to [[t4modules engine structure|the engine]]. If you want to inspect values, start the line with an equal sign. For example, say you want to inspect the player:

<code>
=game.player
</code>

The console has cursor positioning so you can use the Left and Right arrows, as well as Home and End to move to the beginning and end of the current line, respectively. You can paste the clipboard's contents to the cursor position with Ctrl+V (note, not Apple+V on Mac). The current line can be copied to the clipboard with Ctrl+C (again, not Apple+C).

Here are some useful commands to know.
;Level up to level 50
: <code>
game.player:forceLevelup(50)
</code>
;Remove godmode invulnerability
: <code>
game.player.invulnerable=0
</code>
;Change your damage bonus
: <code>
game.player.inc_damage.all=
</code>
;Change your resistance
: <code>
game.player.resists.all=
</code>
;Learn a new talent (1 level in Slash in the example)
: <code>
game.player:learnTalent(game.player.T_SLASH, true, 1)
</code>
;Change category mastery
: <code>
game.player:setTalentTypeMastery("cunning/survival", 1.5)
</code>
;Change base stat - up to 100 max (reduce strength by 20 in the example)
: <code>
game.player:incStat("str", -20)
</code>
;Change stat bonus (set Cunning bonus to 50 in the example)
: <code>
game.player.inc_stats[game.player.STAT_CUN] = 50
</code>
;Apply an effect on the player (frozen for 10 turns)
: <code>
game.player:setEffect(game.player.EFF_FROZEN, 10, {})
</code>
;Change your max HP
: <code>
game.player.max_life=1
game.player:resetToFull()
</code>
;Teleport (to the Assassin Lord)
: <code>
game:changeLevel(2,"thieves-tunnels")
</code>
;Add 5000 gold
: <code>
game.player:incMoney(5000)
</code>
;Give yourself 10 unassigned class skills
: <code>
game.player.unused_talents=10
</code>
;Give yourself 10 unused stat points
: <code>
game.player.unused_stats=10
</code>
;Give yourself an extra stat point each level (default=3)
: <code>
game.player.stats_per_level=4
</code>
;Give yourself 10 unused generic points
: <code>
game.player.unused_generics=10
</code>
;Give yourself 10 unused category points
: <code>
game.player.unused_talents_types=10
</code>
;Give yourself 10 lives:
: <code>
game.player.easy_mode_lifes=10
</code>

=== Output log text to file immediately (Only needed on Windows) ===

Without this, you have to close the game for the log file to be updated!

Instructions:

<ol>
<li>Create a shortcut to t-engine.exe.</li>
<li>Right-click the shortcut and select Properties.</li>
<li>Add the command to the end of the "Target" line:
<code>
--flush-stdout
</code>
</li>
</ol>

The end of the Target line should look like this then: <pre>\t-engine.exe --flush-stdout</pre>

This can be used in combination with a [http://en.wikipedia.org/wiki/Tail_(Unix) tail] program that shows the content of the log file in realtime.

=== Load module and create character on startup ===

You can create a character once then use the premade from the command line:

<pre>
t-engine -Mtome -n -E"auto_quickbirth='player'"
</pre>

if your premade was named "player." (Or create a shortcut in Windows, similarly to the instructions above for outputting log text to a file.)