builtin/init.lua

@@ -45,6 +45,8 @@ elseif INIT == "mainmenu" then
 	end
 elseif INIT == "async" then
 	dofile(asyncpath .. "init.lua")
+elseif INIT == "local_player_physics" then
+	dofile(scriptdir .. "local_player_physics" .. DIR_DELIM .. "init.lua")
 else
 	error(("Unrecognized builtin initialization type %s!"):format(tostring(INIT)))
 end

builtin/local_player_physics/init.lua

@@ -0,0 +1,13 @@
+-- minetest/builtin/local_player_physics/init.lua
+
+local scriptpath = core.get_builtin_path()..DIR_DELIM
+local commonpath = scriptpath.."common"..DIR_DELIM
+dofile(commonpath.."vector.lua")
+
+function core.set_local_player_physics(def)
+	core.log("core.set_local_player_physics")
+	core.registered_local_player_physics_apply_control = def and def.apply_control
+	core.registered_local_player_physics_move = def and def.move
+	core.registered_local_player_physics_camera_up_vector = def and def.camera_up_vector
+	core.registered_local_player_physics_on_message = def and def.on_message
+end

doc/lua_api.txt

@@ -2813,6 +2813,12 @@ This is basically a reference to a C++ `ServerActiveObject`
         * `sneak`: whether player can sneak (default: `true`)
         * `sneak_glitch`: whether player can use the sneak glitch (default: `true`)
 * `get_physics_override()`: returns the table given to set_physics_override
+* `set_physics_script(script_content, handlers)`
+    * `script_content`: A Lua script. See player_physics_api.txt.
+    * `handlers´: `{on_message=function(message)}`
+        * `message´: string from client-side send_local_player_physics_message()
+* `send_physics_script_message(message)`
+    * `message´: string (Hint: use minetest.serialize() for tables)
 * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
    number on success
 * `hud_remove(id)`: remove the HUD element of the specified id
@@ -4137,3 +4143,4 @@ The Biome API is still in an experimental phase and subject to change.
      -- ^ HTTP status code
         data = "response"
     }
+

doc/player_physics_api.txt

@@ -0,0 +1,62 @@
+Minetest Lua Modding API Reference 0.4.14: Player Physics API
+=============================================================
+
+* `minetest.set_local_player_physics(handlers)`
+    handlers = {
+        apply_control = function(dtime, control, player_params) -> player_params or nil,
+        move = function(dtime, control, player_params, pos_max_d) -> player_params or nil, -- Called more often if velocity is high
+        camera_up_vector = function() -> vector or nil,
+        get_collision_box = function(), -- TODO
+        get_eye_offset = function(), -- TODO
+        on_message = function(message),
+            * message: string from server-side player:send_physics_script_message()
+    })
+
+* `minetest.collision_move_simple(pos_max_d, box, stepheight, dtime, pos,
+        speed, accel)` -> result
+    * `pos_max_d`: maximum movement distance
+    * `box`: collision box {minx, miny, minz, maxx, maxy, maxz}
+    * `stepheight`: Maximum node height difference to step over
+    * `dtime`: Time step length in seconds
+    * `pos`: Position vector {x=, y=, z=}
+    * `speed`: Speed vector
+    * `accel`: Acceleration vector
+    * `result`: {pos, speed}
+
+* `minetest.send_local_player_physics_message(message)`
+    * message: string (Hint: use minetest.serialize() for tables)
+
+### control format
+
+    {
+        right = false,
+        aux1 = false,
+        sneak = false,
+        down = false,
+        left = false,
+        up = false,
+        jump = false
+        LMB = false,
+        RMB = false,
+        yaw = 3.5694076447901,
+        pitch = 1.5620696805349,
+        sidew_move_joystick_axis = 0,
+        forw_move_joystick_axis = 0,
+    }
+
+### player_params format
+
+    {
+        position = {
+            y = -626.39599609375,
+            x = -3668.8452148438,
+            z = 4305.4926757812
+        },
+        velocity = {
+            y = -87.501235961914,
+            x = 0.62141418457031,
+            z = -1.3628302812576
+        },
+        yaw = 606.75519234034,
+        pitch = 604.74785916978
+    }

games/minimal/mods/physics_script_test/init.lua

@@ -0,0 +1,77 @@
+local airplane_players = {}
+local mod_base_path = core.get_modpath(core.get_current_modname())
+
+local function read_file_content(fpath)
+	local f, errmsg = io.open(fpath, 'rb')
+	if f then
+		local content = f:read "*a"
+		f:close()
+		return content
+	else
+		minetest.log("error", "failed to open "..fpath)
+	end
+end
+
+local function activate_airplane_mode(player)
+	print("Calling player:set_physics_script")
+
+	local state = {
+		player = player,
+	}
+
+	airplane_players[player:get_player_name()] = state
+
+	state.hud_id_engine_text = player:hud_add({
+		hud_elem_type = "text",
+		position = {x=0.05, y=0.85},
+        alignment = {x=1, y=0},
+		number = 0xffffff,
+		text = "Engine: OFF (press space to toggle)",
+	})
+
+	state.hud_id_speed_text = player:hud_add({
+		hud_elem_type = "text",
+		position = {x=0.05, y=0.9},
+        alignment = {x=1, y=0},
+		number = 0xffffff,
+		text = "Speed: 0",
+	})
+
+	local script = read_file_content(mod_base_path.."/local_player_physics.lua")
+
+	player:set_physics_script(script, {
+		on_message = function(serialized_message)
+			local message = minetest.deserialize(serialized_message)
+			if message.name == "throttle_status" then
+				if message.status then
+					player:hud_change(state.hud_id_engine_text, "text", "Engine: ON")
+				else
+					player:hud_change(state.hud_id_engine_text, "text", "Engine: OFF")
+				end
+			else
+				print("player:set_physics_script on_message unknown: "..dump(message))
+			end
+		end,
+	})
+end
+
+local dt_accu = 0.0
+minetest.register_globalstep(function(dtime)
+	dt_accu = dt_accu + dtime
+	if dt_accu < 1.0 then
+		return
+	end
+	dt_accu = 0.0
+	for name, state in pairs(airplane_players) do
+		state.player:hud_change(state.hud_id_speed_text, "text", "Speed: "..
+				(math.floor(vector.length(state.player:get_player_velocity())*10)/10).." m/s")
+		--state.player:send_physics_script_message("test message")
+	end
+end)
+
+minetest.register_on_joinplayer(function(player)
+	-- TODO: Activate by using an item or something maybe
+	minetest.after(2, function()
+		activate_airplane_mode(player)
+	end)
+end)