Merge branch 'master' of https://github.com/defold/defold.github.io

Author: britzl

_data/examplesindex.json

@@ -1134,6 +1134,19 @@
         "title": "Box2D Mouse Joint",
         "twitter_image": "https://www.defold.com/examples/physics/box2d_mouse_joint/thumbnail.webp"
     },
+    {
+        "author": "Defold Foundation",
+        "brief": "Create a motorized Box2D prismatic joint with translation limits from script using Box2D.",
+        "category": "physics",
+        "layout": "example",
+        "opengraph_image": "https://www.defold.com/examples/physics/box2d_prismatic_joint/thumbnail.webp",
+        "path": "physics/box2d_prismatic_joint",
+        "scripts": "box2d_prismatic_joint.script",
+        "tags": "physics, box2d",
+        "thumbnail": "thumbnail.webp",
+        "title": "Box2D Prismatic Joint",
+        "twitter_image": "https://www.defold.com/examples/physics/box2d_prismatic_joint/thumbnail.webp"
+    },
     {
         "author": "Defold Foundation",
         "brief": "This example shows how to use Box2D world overlap and raycast queries.",
@@ -1160,6 +1173,19 @@
         "title": "Box2D Revolute Bridge",
         "twitter_image": "https://www.defold.com/examples/physics/box2d_revolute_bridge/thumbnail.webp"
     },
+    {
+        "author": "Defold Foundation",
+        "brief": "Create Box2D sensors from static collision shapes.",
+        "category": "physics",
+        "layout": "example",
+        "opengraph_image": "https://www.defold.com/examples/physics/box2d_sensor_toggle/thumbnail.webp",
+        "path": "physics/box2d_sensor_toggle",
+        "scripts": "sensor_box2d_v3.script, sensor_box2d_v2.script, spawn.script",
+        "tags": "physics, box2d",
+        "thumbnail": "thumbnail.webp",
+        "title": "Box2D Sensors",
+        "twitter_image": "https://www.defold.com/examples/physics/box2d_sensor_toggle/thumbnail.webp"
+    },
     {
         "brief": "This example shows a simple setup with dynamic physics objects.",
         "category": "physics",

_includes/examples/physics/box2d_prismatic_joint/box2d_prismatic_joint_script.md

@@ -0,0 +1,95 @@
+-- Unit vector for a 45 degree rail. This is the same direction as the rail sprite.
+local AXIS = vmath.vector3(0.70710678, 0.70710678, 0)
+
+-- Prismatic translation is measured along `local_axis_a`, in project units.
+-- Define farthest limits on both ends:
+local LOWER_TRANSLATION = -110
+local UPPER_TRANSLATION = 110
+
+-- Define motor speed that will be used to move the slider
+local MOTOR_SPEED = 50
+
+-- Some maximum motor force allows to apply a force on the slider to push it
+local MAX_MOTOR_FORCE = 1200
+
+function init(self)
+	-- This will be storing a current direction of the slider
+	self.direction = 1
+
+	-- Acquire input focus to handle inputs
+	msg.post(".", "acquire_input_focus")
+
+	-- `b2d.get_body()` returns the native Box2D body created by the given collision object.
+	local slider = b2d.get_body("/slider#collisionobject")
+	local anchor = b2d.get_body("/rail#collisionobject")
+
+	-- This creates a prismatic joint in runtime between the 2 bodies - an anchor and a slider.
+	-- The joint axis matches the visible diagonal rail in the collection.
+	self.joint = b2d.joint.create_prismatic(anchor, slider, {
+		-- Both bodies start at the same position, so zero local anchors share the same joint origin.
+		local_anchor_a = vmath.vector3(),
+		local_anchor_b = vmath.vector3(),
+
+		-- The axis is local to body A, the static anchor.
+		local_axis_a = AXIS,
+
+		-- Limits keep the dynamic body between the two ends of the rail.
+		enable_limit = true,
+		lower_translation = LOWER_TRANSLATION,
+		upper_translation = UPPER_TRANSLATION,
+
+		-- The motor pushes the slider along the axis without extra forces in update().
+		enable_motor = true,
+		max_motor_force = MAX_MOTOR_FORCE,
+		motor_speed = self.direction * MOTOR_SPEED,
+
+		-- The connected bodies do not need to collide with each other in this example.
+		collide_connected = false,
+	})
+end
+
+-- Helper function to reverse the motor direction
+local function reverse_motor(self)
+	-- Assign a negative direction to the current direction variable
+	self.direction = -self.direction
+
+	-- Positive and negative speed move the slider in opposite directions along the axis.
+	b2d.joint.set_motor_speed(self.joint, self.direction * MOTOR_SPEED)
+end
+
+function update(self, dt)
+	-- The function returns a translation on the defined joint in project units
+	local translation = b2d.joint.get_joint_translation(self.joint)
+
+	-- Reverse automatically when the slider reaches either translation limit.
+	if self.direction > 0 and translation > UPPER_TRANSLATION then
+		reverse_motor(self)
+	elseif self.direction < 0 and translation < LOWER_TRANSLATION then
+		reverse_motor(self)
+	end
+
+	-- Create a string describing the current direction
+	local direction_string = self.direction > 0 and "up-right" or "down-left"
+
+	-- Update the information on the label
+	label.set_text("#label", string.format("Motor: %s\nTranslation: %.0f", direction_string, translation))
+end
+
+function on_input(self, action_id, action)
+	-- The built-in touch action also covers mouse clicks in the built-in all.input_binding.
+	if action_id == hash("touch") and action.pressed then
+		-- When click or touch is pressed we reverse the motor direction
+		reverse_motor(self)
+	end
+end
+
+function final(self)
+	-- Joints created through b2d.joint should be explicitly destroyed.
+	if self.joint then
+		b2d.joint.destroy(self.joint)
+		self.joint = nil
+	end
+
+	-- Release input focus
+	msg.post(".", "release_input_focus")
+end

_includes/examples/physics/box2d_sensor_toggle/sensor_box2d_v2_script.md

@@ -0,0 +1,62 @@
+-- Helper function to convert a collision object to a sensor (trigger) for scripting
+local function enable_sensor_fixture()
+	-- `b2d.get_body()` returns the native Box2D body created by this collision object.
+	local body = b2d.get_body("#collisionobject")
+
+	-- In Box2D V2, collision geometry and material data live in fixtures.
+	-- The collection-authored fixture starts solid, so the ball would collide with it.
+	local fixture = b2d.body.get_fixtures(body)[1]
+
+	-- Turning the fixture into a sensor disables physical collision response.
+	-- Box2D still reports trigger-style enter/exit interactions for overlaps.
+	b2d.fixture.set_sensor(body, fixture.index, true)
+end
+
+function init(self)
+	-- This script uses the Box2D V2 fixture API.
+	self.active = b2d.get_version().major == 2
+
+	-- If Box2D V2 is not used, skip further processing
+	if not self.active then
+		return
+	end
+
+	enable_sensor_fixture()
+	self.overlaps = {}
+end
+
+local NORMAL_SCALE = vmath.vector3(1.0)
+local LARGER_SCALE = vmath.vector3(1.1)
+
+function on_message(self, message_id, message, sender)
+	-- If Box2D V2 is not used, skip further processing
+	if not self.active then
+		return
+	end
+
+	-- Defold sends `trigger_response` when a sensor fixture starts or stops
+	-- overlapping another collision object allowed by the collision mask.
+	if message_id == hash("trigger_response") then
+
+		-- Store overlaps in a table or clear those that exited the sensor
+		if message.enter then
+			self.overlaps[message.other_id] = true
+		else
+			self.overlaps[message.other_id] = nil
+		end
+
+		-- Count overlaps
+		local count = 0
+		for i,v in pairs(self.overlaps) do count = count + 1 end
+
+		-- Set the sprite scale to indicate the overlapping visually
+		if count > 0 then
+			go.set("#sprite", "scale", LARGER_SCALE)
+		else
+			go.set("#sprite", "scale", NORMAL_SCALE)
+		end
+
+		-- Update the label text to show the amount of overlaps
+		label.set_text("#label", "Overlaps: " .. count)
+	end
+end

_includes/examples/physics/box2d_sensor_toggle/sensor_box2d_v3_script.md

@@ -0,0 +1,64 @@
+-- Helper function to create a sensor from the collision object for scripting
+local function create_sensor_shape()
+	-- `b2d.get_body()` returns the native Box2D body created by this collision object.
+	local body = b2d.get_body("#collisionobject")
+
+	-- In Box2D V3, collision geometry is attached to a body as shapes.
+	-- Read the first editor-authored shape so the runtime sensor keeps the same size.
+	local shape = b2d.body.get_shapes(body)[1]
+	local shape_definition = b2d.shape.get_shape(body, shape.index)
+
+	-- The editor-authored shape is solid, so it would block the falling ball.
+	-- Remove it before creating the replacement sensor shape.
+	b2d.body.destroy_shape(body, shape.index)
+
+	-- A sensor shape reports overlaps without producing collision response.
+	-- The ball can pass through it, but Box2D still tracks which shapes overlap it.
+	local sensor = b2d.body.create_shape(body, {
+		shape = shape_definition,
+		friction = 0.0,
+		restitution = 0.0,
+		sensor = true,
+	})
+
+	-- V3 sensor overlap polling is opt-in. Without this call,
+	-- `get_sensor_overlaps()` would not return the current overlap list.
+	b2d.shape.enable_sensor_events(sensor.shape_id, true)
+	return sensor.shape_id
+end
+
+function init(self)
+	-- This script uses the Box2D V3 shape API.
+	self.active = b2d.get_version().major == 3
+
+	-- If Box2D V3 is not used, skip further processing
+	if not self.active then
+		return
+	end
+
+	self.sensor_shape = create_sensor_shape()
+	self.overlaps = {}
+end
+
+local NORMAL_SCALE = vmath.vector3(1.0)
+local LARGER_SCALE = vmath.vector3(1.1)
+
+function update(self, dt)
+	-- If Box2D V3 is not used, skip further processing
+	if not self.active then
+		return
+	end
+
+	-- V3 returns the shapes currently overlapping this sensor shape.
+	self.overlaps = b2d.shape.get_sensor_overlaps(self.sensor_shape)
+
+	-- Set the sprite scale to indicate the overlapping visually
+	if #self.overlaps > 0 then
+		go.set("#sprite", "scale", LARGER_SCALE)
+	else
+		go.set("#sprite", "scale", NORMAL_SCALE)
+	end
+
+	-- Update the label text to show the amount of overlaps
+	label.set_text("#label", "Overlaps: " .. #self.overlaps)
+end

_includes/examples/physics/box2d_sensor_toggle/spawn_script.md

@@ -0,0 +1,22 @@
+-- Helper function to spawn a ball at random position on top and remove it after a moment
+local function spawn_ball()
+	-- X position is random between 200-600
+	local x = 400 + math.random(-200, 200)
+
+	-- Spawn the ball from the ball_factory, assign the random position
+	-- and store the created instance's id
+	local id = factory.create("#ball_factory", vmath.vector3(x, 600, 0.0))
+
+	-- After a moment remove the spawned ball
+	timer.delay(1.2, false, function()
+		go.delete(id)
+	end)
+end
+
+function init(self)
+	-- Initialize random number generator
+	math.randomseed(os.time())
+
+	-- Use the above helper function to spawn the ball every 0.5 second
+	timer.delay(0.2, true, spawn_ball)
+end

examples/animation/3d_animations/archive/archive_files.json

@@ -1 +1 @@
-{"content":[{"name":"game.projectc","size":4800,"pieces":[{"name":"game0.projectc","offset":0}]},{"name":"game.arci","size":3168,"pieces":[{"name":"game0.arci","offset":0}]},{"name":"game.arcd","size":1444544,"pieces":[{"name":"game0.arcd","offset":0}]},{"name":"game.dmanifest","size":3303,"pieces":[{"name":"game0.dmanifest","offset":0}]}],"total_size":1455815}
+{"content":[{"name":"game.projectc","size":4826,"pieces":[{"name":"game0.projectc","offset":0}]},{"name":"game.arci","size":3168,"pieces":[{"name":"game0.arci","offset":0}]},{"name":"game.arcd","size":1444544,"pieces":[{"name":"game0.arcd","offset":0}]},{"name":"game.dmanifest","size":3303,"pieces":[{"name":"game0.dmanifest","offset":0}]}],"total_size":1455841}

examples/animation/3d_animations/archive/game0.arcd

@@ -7,6 +7,7 @@ write_log = 0
 write_log_file = 0
 minimum_log_level = 1
 compress_archive = 1
+dependencies_metadata = 0
 title_as_file_name = Defoldexamples
 
 [display]