Rename mobs mod to mcl_mobs
[MineClone/MineClone2.git] / mods / ENTITIES / mcl_mobs / api.txt
2 Mobs Redo: MineClone 2 Edition
3 API documentation
4 ==============================
6 Welcome to the world of mobs in Minetest and hopefully an easy guide to defining
7 your own mobs and having them appear in your worlds.
10 Registering Mobs
11 ----------------
13 To register a mob and have it ready for use requires the following function:
15    mobs:register_mob(name, definition)
17 The 'name' of a mob usually starts with the mod name it's running from followed
18 by it's own name e.g.
20    "mobs_monster:sand_monster" or "mymod:totally_awesome_beast"
22 ... and the 'definition' is a table which holds all of the settings and
23 functions needed for the mob to work properly which contains the following:
25    'nametag'       contains the name which is shown above mob.
26    'type'          holds the type of mob that inhabits your world e.g.
27       "animal"     usually docile and walking around.
28       "monster"    attacks player or npc on sight.
29       "npc"        walk around and will defend themselves if hit first, they
30                    kill monsters.
31    'hp_min'        has the minimum health value the mob can spawn with.
32    'hp_max'        has the maximum health value the mob can spawn with.
33    'armor'         holds strength of mob, 100 is normal, lower is more powerful
34                    and needs more hits and better weapons to kill.
35    'passive'       when true allows animals to defend themselves when hit,
36                    otherwise they amble onwards.
37    'walk_velocity' is the speed that your mob can walk around.
38    'run_velocity'  is the speed your mob can run with, usually when attacking.
39    'walk_chance'   has a 0-100 chance value your mob will walk from standing,
40                    set to 0 for jumping mobs only.
41    'jump'          when true allows your mob to jump updwards.
42    'jump_height'   holds the height your mob can jump, 0 to disable jumping.
43    'stepheight'    height of a block that your mob can easily walk up onto,
44                    defaults to 1.1.
45    'fly'           when true allows your mob to fly around instead of walking.
46    'fly_in'        holds the node name that the mob flies (or swims) around
47                    in e.g. "air" or "default:water_source".
48    'runaway'       if true causes animals to turn and run away when hit.
49    'view_range'    how many nodes in distance the mob can see a player.
50    'damage'        how many health points the mob does to a player or another
51                    mob when melee attacking.
52    'knock_back'    when true has mobs falling backwards when hit, the greater
53                    the damage the more they move back.
54    'fear_height'   is how high a cliff or edge has to be before the mob stops
55                    walking, 0 to turn off height fear.
56    'fall_speed'    has the maximum speed the mob can fall at, default is -10.
57    'fall_damage'   when true causes falling to inflict damage.
58    'water_damage'  holds the damage per second infliced to mobs when standing in
59                    water.
60    'lava_damage'   holds the damage per second inflicted to mobs when standing
61                    in lava or fire.
62    'light_damage'  holds the damage per second inflicted to mobs when it's too
63                    bright (above 13 light).
64    'suffocation'   when true causes mobs to suffocate inside solid blocks.
65    'floats'        when set to 1 mob will float in water, 0 has them sink.
66    'follow'        mobs follow player when holding any of the items which appear
67                    on this table, the same items can be fed to a mob to tame or
68                    breed e.g. {"farming:wheat", "default:apple"}
70    'reach'               is how far the mob can attack player when standing
71                          nearby, default is 3 nodes.
72    'docile_by_day'       when true has mobs wandering around during daylight
73                          hours and only attacking player at night or when
74                          provoked.
75    'attacks_monsters'    when true has npc's attacking monsters or not.
76    'attack_animals'      when true will have monsters attacking animals.
77    'owner_loyal'         when true will have tamed mobs attack anything player
78                          punches when nearby.
79    'group_attack'        when true has same mob type grouping together to attack
80                          offender.
81    'attack_type'         tells the api what a mob does when attacking the player
82                          or another mob:
83       'dogfight'         is a melee attack when player is within mob reach.
84       'shoot'            has mob shoot pre-defined arrows at player when inside
85                          view_range.
86       'dogshoot'         has melee attack when inside reach and shoot attack
87                          when inside view_range.
88       'explode'          causes mob to stop and explode when inside reach.
89    'explosion_radius'           the radius of explosion node destruction,
90                                 defaults to 1
91    'explosion_damage_radius'    the radius of explosion entity & player damage,
92                                 defaults to explosion_radius * 2
93    'explosion_timer'     number of seconds before mob explodes while its target
94                          is still inside reach or explosion_damage_radius,
95                          defaults to 3.
96    'allow_fuse_reset'    Allow 'explode' attack_type to reset fuse and resume
97                          chasing if target leaves the blast radius or line of
98                          sight. Defaults to true.
99    'stop_to_explode'     When set to true (default), mob must stop and wait for
100                          explosion_timer in order to explode. If false, mob will
101                          continue chasing.
102    'arrow'               holds the pre-defined arrow object to shoot when
103                          attacking.
104    'dogshoot_switch'     allows switching between attack types by using timers
105                          (1 for shoot, 2 for dogfight)
106    'dogshoot_count_max'  contains how many seconds before switching from
107                          dogfight to shoot.
108    'dogshoot_count2_max' contains how many seconds before switching from shoot
109                          to dogfight.
110    'shoot_interval'      has the number of seconds between shots.
111    'shoot_offset'        holds the y position added as to where the
112                          arrow/fireball appears on mob.
113    'specific_attack'     has a table of entity names that mob can also attack
114                          e.g. {"player", "mobs_animal:chicken"}.
115    'runaway_from'        contains a table with mob names to run away from, add
116                          "player" to list to runaway from player also.
117    'blood_amount'        contains the number of blood droplets to appear when
118                          mob is hit.
119    'blood_texture'       has the texture name to use for droplets e.g.
120                          "mobs_blood.png", or table {"blood1.png", "blood2.png"}
121    'pathfinding'         set to 1 for mobs to use pathfinder feature to locate
122                          player, set to 2 so they can build/break also (only
123                          works with dogfight attack and when 'mobs_griefing'
124                          in minetest.conf is not false).
125    'immune_to'           is a table that holds specific damage when being hit by
126                          certain items e.g.
127       {"default:sword_wood",  0} -- causes no damage.
128       {"default:gold_lump", -10} -- heals by 10 health points.
129       {"default:coal_block", 20} -- 20 damage when hit on head with coal blocks.
131    'makes_footstep_sound' when true you can hear mobs walking.
132    'sounds'               this is a table with sounds of the mob
133       'distance'          maximum distance sounds can be heard, default is 10.
134       'random'            random sound that plays during gameplay.
135       'war_cry'           what you hear when mob starts to attack player.
136       'attack'            what you hear when being attacked.
137       'shoot_attack'      sound played when mob shoots.
138       'damage'            sound heard when mob is hurt.
139       'death'             played when mob is killed.
140       'jump'              played when mob jumps.
141       'fuse'              sound played when mob explode timer starts.
142       'explode'           sound played when mob explodes.
144    'drops'     table of items that are dropped when mob is killed, fields are:
145       'name'   name of item to drop.
146       'chance' chance of drop, 1 for always, 2 for 1-in-2 chance etc.
147       'min'    minimum number of items dropped.
148       'max'    maximum number of items dropped.
150    'visual'            holds the look of the mob you wish to create:
151       'cube'           looks like a normal node
152       'sprite'         sprite which looks same from all angles.
153       'upright_sprite' flat model standing upright.
154       'wielditem'      how it looks when player holds it in hand.
155       'mesh'           uses separate object file to define mob.
156    'visual_size'       has the size of the mob, defaults to {x = 1, y = 1}
157    'collisionbox'      has the box in which mob can be interacted with the
158                        world e.g. {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5}
159    'selectionbox'      has the box in which player can interact with mob
160    'textures'          holds a table list of textures to be used for mob, or you
161                        could use multiple lists inside another table for random
162                        selection e.g. { {"texture1.png"}, {"texture2.png"} }
163    'child_texture'     holds the texture table for when baby mobs are used.
164    'gotten_texture'    holds the texture table for when self.gotten value is
165                        true, used for milking cows or shearing sheep.
166    'mesh'              holds the name of the external object used for mob model
167                        e.g. "mobs_cow.b3d"
168    'gotten_mesh"       holds the name of the external object used for when
169                        self.gotten is true for mobs.
170    'rotate'            custom model rotation, 0 = front, 90 = side, 180 = back,
171                        270 = other side.
172    'double_melee_attack' when true has the api choose between 'punch' and
173                       'punch2' animations.
175    'animation'       holds a table containing animation names and settings for use with mesh models:
176       'stand_start'  start frame for when mob stands still.
177       'stand_end'    end frame of stand animation.
178       'stand_speed'  speed of animation in frames per second.
179       'walk_start'   when mob is walking around.
180       'walk_end'
181       'walk_speed'
182       'run_start'    when a mob runs or attacks.
183       'run_end'
184       'run_speed'
185       'fly_start'    when a mob is flying.
186       'fly_end'
187       'fly_speed'
188       'punch_start'  when a mob melee attacks.
189       'punch_end'
190       'punch_speed'
191       'punch2_start' alternative melee attack animation.
192       'punch2_end'
193       'punch2_speed'
194       'shoot_start'  shooting animation.
195       'shoot_end'
196       'shoot_speed'
197       'die_start'    death animation
198       'die_end'
199       'die_speed'
200       'die_loop'     when set to false stops the animation looping.
202       Using '_loop = false' setting will stop any of the above animations from
203       looping.
205       'speed_normal' is used for animation speed for compatibility with some
206                      older mobs.
209     MineClone 2 extensions:
211       'ignores_nametag' if true, mob cannot be named by nametag
212       'rain_damage' damage per second if mob is standing in rain (default: 0)
213       'sunlight_damage' holds the damage per second inflicted to mobs when they
214                         are in direct sunlight
216 Node Replacement
217 ----------------
219 Mobs can look around for specific nodes as they walk and replace them to mimic
220 eating.
222    'replace_what'   group of items to replace e.g.
223                     {"farming:wheat_8", "farming:carrot_8"}
224                     or you can use the specific options of what, with and
225                     y offset by using this instead:
226                     {
227                        {"group:grass", "air", 0},
228                        {"default:dirt_with_grass", "default:dirt", -1}
229                     }
230    'replace_with'   replace with what e.g. "air" or in chickens case "mobs:egg"
231    'replace_rate'   how random should the replace rate be (typically 10)
232    'replace_offset' +/- value to check specific node to replace
234    'on_replace(self, pos, oldnode, newnode)' is called when mob is about to
235                                              replace a node.
236       'self'    ObjectRef of mob
237       'pos'     Position of node to replace
238       'oldnode' Current node
239       'newnode' What the node will become after replacing
241        If false is returned, the mob will not replace the node.
243        By default, replacing sets self.gotten to true and resets the object
244        properties.
247 Custom Definition Functions
248 ---------------------------
250 Along with the above mob registry settings we can also use custom functions to
251 enhance mob functionality and have them do many interesting things:
253    'on_die'         a function that is called when the mob is killed the
254                     parameters are (self, pos)
255    'on_rightclick'  its same as in minetest.register_entity()
256    'on_blast'       is called when an explosion happens near mob when using TNT
257                     functions, parameters are (object, damage) and returns
258                     (do_damage, do_knockback, drops)
259    'on_spawn'       is a custom function that runs on mob spawn with 'self' as
260                     variable, return true at end of function to run only once.
261    'after_activate' is a custom function that runs once mob has been activated
262                     with these paramaters (self, staticdata, def, dtime)
263    'on_breed'       called when two similar mobs breed, paramaters are
264                     (parent1, parent2) objects, return false to stop child from
265                     being resized and owner/tamed flags and child textures being
266                     applied.  Function itself must spawn new child mob.
267    'on_grown'       is called when a child mob has grown up, only paramater is
268                     (self).
269    'do_punch'       called when mob is punched with paramaters (self, hitter,
270                     time_from_last_punch, tool_capabilities, direction), return
271                     false to stop punch damage and knockback from taking place.
272    'custom_attack'  when set this function is called instead of the normal mob
273                     melee attack, parameters are (self, to_attack).
274    'on_die'         a function that is called when mob is killed (self, pos)
275    'do_custom'      a custom function that is called every tick while mob is
276                     active and which has access to all of the self.* variables
277                     e.g. ( for health or self.standing_in for node
278                     status), return with 'false' to skip remainder of mob API.
281 Internal Variables
282 ------------------
284 The mob api also has some preset variables and functions that it will remember
285 for each mob.
287    ''        contains current health of mob (cannot exceed
288                         self.hp_max)
289    'self.texture_list'  contains list of all mob textures
290    'self.child_texture' contains mob child texture when growing up
291    'self.base_texture'  contains current skin texture which was randomly
292                         selected from textures list
293    'self.gotten'        this is used for obtaining milk from cow and wool from
294                         sheep
295    'self.horny'         when animal fed enough it is set to true and animal can
296                         breed with same animal
297    'self.hornytimer'    background timer that controls breeding functions and
298                         mob childhood timings
299    'self.child'         used for when breeding animals have child, will use
300                         child_texture and be half size
301    'self.owner'         string used to set owner of npc mobs, typically used for
302                         dogs
303    'self.order'         set to "follow" or "stand" so that npc will follow owner
304                         or stand it's ground
305    'self.nametag'       contains the name of the mob which it can show above
308 Spawning Mobs in World
309 ----------------------
311 mobs:register_spawn(name, nodes, max_light, min_light, chance,
312    active_object_count, max_height, day_toggle)
314 mobs:spawn_specfic(name, nodes, neighbors, min_light, max_light, interval,
315    chance, active_object_count, min_height, max_height, day_toggle, on_spawn)
317 These functions register a spawn algorithm for the mob. Without this function
318 the call the mobs won't spawn.
320     'name'                is the name of the animal/monster
321     'nodes'               is a list of nodenames on that the animal/monster can
322                           spawn on top of
323     'neighbors'           is a list of nodenames on that the animal/monster will
324                           spawn beside (default is {"air"} for
325                           mobs:register_spawn)
326     'max_light'           is the maximum of light
327     'min_light'           is the minimum of light
328     'interval'            is same as in register_abm() (default is 30 for
329                           mobs:register_spawn)
330     'chance'              is same as in register_abm()
331     'active_object_count' number of this type of mob to spawn at one time inside
332                           map area
333     'min_height'          is the minimum height the mob can spawn
334     'max_height'          is the maximum height the mob can spawn
335     'day_toggle'          true for day spawning, false for night or nil for
336                           anytime
337     'on_spawn'            is a custom function which runs after mob has spawned
338                           and gives self and pos values.
340 A simpler way to handle mob spawns has been added with the mobs:spawn(def)
341 command which uses above names to make settings clearer:
343     mobs:spawn({name = "mobs_monster:tree_monster",
344        nodes = {"group:leaves"},
345        max_light = 7,
346     })
349 For each mob that spawns with this function is a field in mobs.spawning_mobs.
350 It tells if the mob should spawn or not.  Default is true.  So other mods can
351 only use the API of this mod by disabling the spawning of the default mobs in
352 this mod.
355 mobs:spawn_abm_check(pos, node, name)
357 This global function can be changed to contain additional checks for mobs to
358 spawn e.g. mobs that spawn only in specific areas and the like.  By returning
359 true the mob will not spawn.
361     'pos'    holds the position of the spawning mob
362     'node'   contains the node the mob is spawning on top of
363     'name'   is the name of the animal/monster
366 MineClone 2 extensions
367 ----------------------
369 mobs:spawn_child(pos, mob_type)
371 This function spawns a mob as a child. The parameter mob_type is the
372 entitystring of the new mob.
373 This function returns the mob on success and nil otherwise.
376 Making Arrows
377 -------------
379 mobs:register_arrow(name, definition)
381 This function registers a arrow for mobs with the attack type shoot.
383     'name'            is the name of the arrow
384     'definition'      is a table with the following values:
385        'visual'       same is in minetest.register_entity()
386        'visual_size'  same is in minetest.register_entity()
387        'textures'     same is in minetest.register_entity()
388        'velocity'     the velocity of the arrow
389        'drop'         if set to true any arrows hitting a node will drop as item
390        'hit_player'   a function that is called when the arrow hits a player;
391                       this function should hurt the player, the parameters are
392                       (self, player)
393        'hit_mob'      a function that is called when the arrow hits a mob;
394                       this function should hurt the mob, the parameters are
395                       (self, player)
396        'hit_node'     a function that is called when the arrow hits a node, the
397                       parameters are (self, pos, node)
398        'tail'         when set to 1 adds a trail or tail to mob arrows
399        'tail_texture' texture string used for above effect
400        'tail_size'    has size for above texture (defaults to between 5 and 10)
401        'expire'       contains float value for how long tail appears for
402                       (defaults to 0.25)
403        'glow'         has value for how brightly tail glows 1 to 10 (default is
404                       0 for no glow)
405        'rotate'       integer value in degrees to rotate arrow
406        'on_step'      is a custom function when arrow is active, nil for
407                       default.
410 Spawn Eggs
411 ----------
413 mobs:register_egg(name, description, background, addegg, no_creative)
415 This function registers a spawn egg which can be used by admin to properly spawn in a mob.
417    'name'        this is the name of your new mob to spawn e.g. "mob:sheep"
418    'description' the name of the new egg you are creating e.g. "Spawn Sheep"
419    'background'  the texture displayed for the egg in inventory
420    'addegg'      would you like an egg image in front of your texture (1 = yes,
421                  0 = no)
422    'no_creative' when set to true this stops spawn egg appearing in creative
423                  mode for destructive mobs like Dungeon Masters.
426 Explosion Function
427 ------------------
429 mobs:explosion(pos, radius) -- DEPRECATED!!!  use mobs:boom() instead
431 mobs:boom(self, pos, radius)
432    'self' mob entity
433    'pos' centre position of explosion
434    'radius' radius of explosion (typically set to 3)
436 This function generates an explosion which removes nodes in a specific radius
437 and damages any entity caught inside the blast radius.  Protection will limit
438 node destruction but not entity damage.
441 mobs:capture_mob
442 ----------------
444 mobs:capture_mob(...)
446 Does nothing and returns false.
448 This function is provided for compability with Mobs Redo for an attempt to
449 capture a mob.
450 Mobs cannot be captured in MineClone 2.
452 In Mobs Redo, this is generally called inside the on_rightclick section of the mob
453 api code, it provides a chance of capturing the mob. See Mobs Redo documentation
454 of parameters.
456 Feeding and Taming/Breeding
457 ---------------------------
459 mobs:feed_tame(self, clicker, feed_count, breed, tame)
461 This function allows the mob to be fed the item inside self.follow be it apple,
462 wheat or whatever a set number of times and be tamed or bred as a result.
463 Will return true when mob is fed with item it likes.
465    'self'       mob information
466    'clicker'    player information
467    'feed_count' number of times mob must be fed to tame or breed
468    'breed'      true or false stating if mob can be bred and a child created
469                 afterwards
470    'tame'       true or false stating if mob can be tamed so player can pick
471                 them up
474 Protecting Mobs
475 ---------------
477 mobs:protect(self, clicker)
479 This function can be used to right-click any tamed mob with mobs:protector item,
480 this will protect the mob from harm inside of a protected area from other
481 players.  Will return true when mob right-clicked with mobs:protector item.
483    'self'    mob information
484    'clicker' player information
487 Riding Mobs
488 -----------
490 Mobs can now be ridden by players and the following shows its functions and
491 usage:
494 mobs:attach(self, player)
496 This function attaches a player to the mob so it can be ridden.
498    'self'   mob information
499    'player' player information
502 mobs:detach(player, offset)
504 This function will detach the player currently riding a mob to an offset
505 position.
507    'player' player information
508    'offset' position table containing offset values
511 mobs:drive(self, move_animation, stand_animation, can_fly, dtime)
513 This function allows an attached player to move the mob around and animate it at
514 same time.
516    'self'            mob information
517    'move_animation'  string containing movement animation e.g. "walk"
518    'stand_animation' string containing standing animation e.g. "stand"
519    'can_fly'         if true then jump and sneak controls will allow mob to fly
520                      up and down
521    'dtime'           tick time used inside drive function
524 mobs:fly(self, dtime, speed, can_shoot, arrow_entity, move_animation, stand_animation)
526 This function allows an attached player to fly the mob around using directional
527 controls.
529    'self'            mob information
530    'dtime'           tick time used inside fly function
531    'speed'           speed of flight
532    'can_shoot'       true if mob can fire arrow (sneak and left mouse button
533                      fires)
534    'arrow_entity'    name of arrow entity used for firing
535    'move_animation'  string containing name of pre-defined animation e.g. "walk"
536                      or "fly" etc.
537    'stand_animation' string containing name of pre-defined animation e.g.
538                      "stand" or "blink" etc.
540 Note: animation names above are from the pre-defined animation lists inside mob
541 registry without extensions.
544 mobs:set_animation(self, name)
546 This function sets the current animation for mob, defaulting to "stand" if not
547 found.
549    'self' mob information
550    'name' name of animation
553 Certain variables need to be set before using the above functions:
555    'self.v2'                toggle switch used to define below values for the
556                             first time
557    'self.max_speed_forward' max speed mob can move forward
558    'self.max_speed_reverse' max speed mob can move backwards
559    'self.accel'             acceleration speed
560    'self.terrain_type'      integer containing terrain mob can walk on
561                             (1 = water, 2 or 3 = land)
562    'self.driver_attach_at'  position offset for attaching player to mob
563    'self.driver_eye_offset' position offset for attached player view
564    'self.driver_scale'      sets driver scale for mobs larger than {x=1, y=1}
567 External Settings for "minetest.conf"
568 ------------------------------------
570    'enable_damage'          if true monsters will attack players (default is true)
571    'only_peaceful_mobs'     if true only animals will spawn in game (default is
572                             false)
573    'mobs_disable_blood'     if false blood effects appear when mob is hit (default
574                             is false)
575    'mobs_spawn_protected'   if set to false then mobs will not spawn in protected
576                             areas (default is true)
577    'remove_far_mobs'        if true then untamed mobs that are outside players
578                              visual range will be removed (default is true)
579    'mobname'                can change specific mob chance rate (0 to disable) and
580                             spawn number e.g. mobs_animal:cow = 1000,5
581    'mob_difficulty'         sets difficulty level (health and hit damage
582                             multiplied by this number), defaults to 1.0.
583    'mob_show_health'        if false then punching mob will not show health status
584                             (true by default)
585    'mob_chance_multiplier'  multiplies chance of all mobs spawning and can be set
586                             to 0.5 to have mobs spawn more or 2.0 to spawn less.
587                             e.g.  1 in 7000 * 0.5 = 1 in 3500 so better odds of
588                             spawning.
589    'mobs_spawn'             if false then mobs no longer spawn without spawner or
590                             spawn egg.
591    'mobs_drop_items'        when false mobs no longer drop items when they die.
592    'mobs_griefing'          when false mobs cannot break blocks when using either
593                             pathfinding level 2, replace functions or mobs:boom
594                             function.
596 Players can override the spawn chance for each mob registered by adding a line
597 to their minetest.conf file with a new value, the lower the value the more each
598 mob will spawn e.g.
600 mobs_animal:sheep_chance 11000
601 mobs_monster:sand_monster_chance 100
604 Rideable Horse Example Mob
605 --------------------------
607 mobs:register_mob("mob_horse:horse", {
608         type = "animal",
609         visual = "mesh",
610         visual_size = {x = 1.20, y = 1.20},
611         mesh = "mobs_horse.x",
612         collisionbox = {-0.4, -0.01, -0.4, 0.4, 1.25, 0.4},
613         animation = { 
614                 speed_normal = 15,
615                 speed_run = 30,
616                 stand_start = 25,
617                 stand_end = 75,
618                 walk_start = 75,
619                 walk_end = 100,
620                 run_start = 75,
621                 run_end = 100,
622         },
623         textures = {
624                 {"mobs_horse.png"},
625                 {"mobs_horsepeg.png"},
626                 {"mobs_horseara.png"}
627         },
628         fear_height = 3,
629         runaway = true,
630         fly = false,
631         walk_chance = 60,
632         view_range = 5,
633         follow = {"farming:wheat"},
634         passive = true,
635         hp_min = 12,
636         hp_max = 16,
637         armor = 200,
638         lava_damage = 5,
639         fall_damage = 5,
640         water_damage = 1,
641         makes_footstep_sound = true,
642         drops = {
643                 {name = "mobs:meat_raw", chance = 1, min = 2, max = 3}
644         },
645         sounds = {
646                 random = "horse_neigh.ogg",
647                 damage = "horse_whinney.ogg",
648         },
650         do_custom = function(self, dtime)
652                 -- set needed values if not already present
653                 if not self.v2 then
654                         self.v2 = 0
655                         self.max_speed_forward = 6
656                         self.max_speed_reverse = 2
657                         self.accel = 6
658                         self.terrain_type = 3
659                         self.driver_attach_at = {x = 0, y = 20, z = -2}
660                         self.driver_eye_offset = {x = 0, y = 3, z = 0}
661                         self.driver_scale = {x = 1, y = 1}
662                 end
664                 -- if driver present allow control of horse
665                 if self.driver then
667               , "walk", "stand", false, dtime)
669                         return false -- skip rest of mob functions
670                 end
672                 return true
673         end,
675         on_die = function(self, pos)
677                 -- drop saddle when horse is killed while riding
678                 -- also detach from horse properly
679                 if self.driver then
680                         minetest.add_item(pos, "mobs:saddle")
681                         mobs.detach(self.driver, {x = 1, y = 0, z = 1})
682                 end
684         end,
686         on_rightclick = function(self, clicker)
688                 -- make sure player is clicking
689                 if not clicker or not clicker:is_player() then
690                         return
691                 end
693                 -- feed, tame or heal horse
694                 if mobs:feed_tame(self, clicker, 10, true, true) then
695                         return
696                 end
698                 -- make sure tamed horse is being clicked by owner only
699                 if self.tamed and self.owner == clicker:get_player_name() then
701                         local inv = clicker:get_inventory()
703                         -- detatch player already riding horse
704                         if self.driver and clicker == self.driver then
706                                 mobs.detach(clicker, {x = 1, y = 0, z = 1})
708                                 -- add saddle back to inventory
709                                 if inv:room_for_item("main", "mobs:saddle") then
710                                         inv:add_item("main", "mobs:saddle")
711                                 else
712                                         minetest.add_item(clicker.getpos(), "mobs:saddle")
713                                 end
715                         -- attach player to horse
716                         elseif not self.driver
717                         and clicker:get_wielded_item():get_name() == "mobs:saddle" then
719                                 self.object:set_properties({stepheight = 1.1})
720                                 mobs.attach(self, clicker)
722                                 -- take saddle from inventory
723                                 inv:remove_item("main", "mobs:saddle")
724                         end
725                 end
727                 -- used to capture horse with magic lasso
728                 mobs:capture_mob(self, clicker, 0, 0, 80, false, nil)
729         end