summaryrefslogtreecommitdiff
path: root/api_new.txt
diff options
context:
space:
mode:
Diffstat (limited to 'api_new.txt')
-rw-r--r--api_new.txt52
1 files changed, 27 insertions, 25 deletions
diff --git a/api_new.txt b/api_new.txt
index 41a4bc8..15b87a3 100644
--- a/api_new.txt
+++ b/api_new.txt
@@ -1,5 +1,5 @@
-Mobs Redo API (last updated 13th Oct 2017)
+Mobs Redo API (last updated 18th Oct 2017)
==========================================
Welcome to the world of mobs in minetest and hopefully an easy guide to defining
@@ -228,30 +228,32 @@ Custom Definition Functions
Along with the above mob registry settings we can also use custom functions to
enhance mob functionality and have them do many interesting things:
- 'on_die' a function that is called when the mob is killed the
- parameters are (self, pos)
- 'on_rightclick' its same as in minetest.register_entity()
- 'on_blast' is called when an explosion happens near mob when using TNT
- functions, parameters are (object, damage) and returns
- (do_damage, do_knockback, drops)
- 'on_spawn' is a custom function that runs on mob spawn with 'self' as
- variable, return true at end of function to run only once.
- 'on_breed' called when two similar mobs breed, paramaters are
- (parent1, parent2) objects, return false to stop child from
- being resized and owner/tamed flags and child textures being
- applied. Function itself must spawn new child mob.
- 'on_grown' is called when a child mob has grown up, only paramater is
- (self).
- 'do_punch' called when mob is punched with paramaters (self, hitter,
- time_from_last_punch, tool_capabilities, direction), return
- false to stop punch damage and knockback from taking place.
- 'custom_attack' when set this function is called instead of the normal mob
- melee attack, parameters are (self, to_attack).
- 'on_die' a function that is called when mob is killed
- 'do_custom' a custom function that is called every tick while mob is
- active and which has access to all of the self.* variables
- e.g. (self.health for health or self.standing_in for node
- status), return with 'false' to skip remainder of mob API.
+ 'on_die' a function that is called when the mob is killed the
+ parameters are (self, pos)
+ 'on_rightclick' its same as in minetest.register_entity()
+ 'on_blast' is called when an explosion happens near mob when using TNT
+ functions, parameters are (object, damage) and returns
+ (do_damage, do_knockback, drops)
+ 'on_spawn' is a custom function that runs on mob spawn with 'self' as
+ variable, return true at end of function to run only once.
+ 'after_activate' is a custom function that runs once mob has been activated
+ with these paramaters (self, staticdata, def, dtime)
+ 'on_breed' called when two similar mobs breed, paramaters are
+ (parent1, parent2) objects, return false to stop child from
+ being resized and owner/tamed flags and child textures being
+ applied. Function itself must spawn new child mob.
+ 'on_grown' is called when a child mob has grown up, only paramater is
+ (self).
+ 'do_punch' called when mob is punched with paramaters (self, hitter,
+ time_from_last_punch, tool_capabilities, direction), return
+ false to stop punch damage and knockback from taking place.
+ 'custom_attack' when set this function is called instead of the normal mob
+ melee attack, parameters are (self, to_attack).
+ 'on_die' a function that is called when mob is killed
+ 'do_custom' a custom function that is called every tick while mob is
+ active and which has access to all of the self.* variables
+ e.g. (self.health for health or self.standing_in for node
+ status), return with 'false' to skip remainder of mob API.
Internal Variables