1 -- Minetest 0.4 mod: player
2 -- See README.txt for licensing and other information.
9 default.player_register_model(name, def)
10 ^ Register a new model to be used by players.
11 ^ <name> is the model filename such as "character.x", "foo.b3d", etc.
12 ^ See Model Definition below for format of <def>.
14 default.registered_player_models[name]
15 ^ See Model Definition below for format.
17 default.player_set_model(player, model_name)
18 ^ <player> is a PlayerRef.
19 ^ <model_name> is a model registered with player_register_model.
21 default.player_set_animation(player, anim_name [, speed])
22 ^ <player> is a PlayerRef.
23 ^ <anim_name> is the name of the animation.
24 ^ <speed> is in frames per second. If nil, default from the model is used
26 default.player_set_textures(player, textures)
27 ^ <player> is a PlayerRef.
28 ^ <textures> is an array of textures
29 ^ If <textures> is nil, the default textures from the model def are used
31 default.player_get_animation(player)
32 ^ <player> is a PlayerRef.
33 ^ Returns a table containing fields "model", "textures" and "animation".
34 ^ Any of the fields of the returned table may be nil.
40 animation_speed = 30, -- Default animation speed, in FPS.
41 textures = {"character.png", }, -- Default array of textures.
42 visual_size = {x=1, y=1,}, -- Used to scale the model.
44 -- <anim_name> = { x=<start_frame>, y=<end_frame>, },
45 foo = { x= 0, y=19, },
46 bar = { x=20, y=39, },
53 -- Player animation blending
54 -- Note: This is currently broken due to a bug in Irrlicht, leave at 0
55 local animation_blend = 0
57 default.registered_player_models = { }
60 local models = default.registered_player_models
62 function default.player_register_model(name, def)
66 -- Default player appearance
67 default.player_register_model("character.x", {
69 textures = {"character.png", },
71 -- Standard animations.
72 stand = { x= 0, y= 79, },
73 lay = { x=162, y=166, },
74 walk = { x=168, y=187, },
75 mine = { x=189, y=198, },
76 walk_mine = { x=200, y=219, },
77 -- Extra animations (not currently used by the game).
78 sit = { x= 81, y=160, },
82 -- Player stats and animations
83 local player_model = {}
84 local player_textures = {}
85 local player_anim = {}
86 local player_sneak = {}
88 function default.player_get_animation(player)
89 local name = player:get_player_name()
91 model = player_model[name],
92 textures = player_textures[name],
93 animation = player_anim[name],
97 -- Called when a player's appearance needs to be updated
98 function default.player_set_model(player, model_name)
99 local name = player:get_player_name()
100 local model = models[model_name]
102 if player_model[name] == model_name then
105 player:set_properties({
107 textures = player_textures[name] or model.textures,
109 visual_size = model.visual_size or {x=1, y=1},
111 default.player_set_animation(player, "stand")
113 player:set_properties({
114 textures = { "player.png", "player_back.png", },
115 visual = "upright_sprite",
118 player_model[name] = model_name
121 function default.player_set_textures(player, textures)
122 local name = player:get_player_name()
123 player_textures[name] = textures
124 player:set_properties({textures = textures,})
127 function default.player_set_animation(player, anim_name, speed)
128 local name = player:get_player_name()
129 if player_anim[name] == anim_name then
132 local model = player_model[name] and models[player_model[name]]
133 if not (model and model.animations[anim_name]) then
136 local anim = model.animations[anim_name]
137 player_anim[name] = anim_name
138 player:set_animation(anim, speed or model.animation_speed, animation_blend)
141 -- Update appearance when the player joins
142 minetest.register_on_joinplayer(function(player)
143 default.player_set_model(player, "character.x")
146 -- Localize for better performance.
147 local player_set_animation = default.player_set_animation
149 -- Check each player and apply animations
150 minetest.register_globalstep(function(dtime)
151 for _, player in pairs(minetest.get_connected_players()) do
152 local name = player:get_player_name()
153 local model_name = player_model[name]
154 local model = model_name and models[model_name]
156 local controls = player:get_player_control()
157 local walking = false
158 local animation_speed_mod = model.animation_speed or 30
160 -- Determine if the player is walking
161 if controls.up or controls.down or controls.left or controls.right then
165 -- Determine if the player is sneaking, and reduce animation speed if so
166 if controls.sneak then
167 animation_speed_mod = animation_speed_mod / 2
170 -- Apply animations based on what the player is doing
171 if player:get_hp() == 0 then
172 player_set_animation(player, "lay")
174 if player_sneak[name] ~= controls.sneak then
175 player_anim[name] = nil
176 player_sneak[name] = controls.sneak
179 player_set_animation(player, "walk_mine", animation_speed_mod)
181 player_set_animation(player, "walk", animation_speed_mod)
183 elseif controls.LMB then
184 player_set_animation(player, "mine")
186 player_set_animation(player, "stand", animation_speed_mod)