Skip to content

Commit 2959a6c

Browse files
Site changes [skip-ci]
1 parent 64811d5 commit 2959a6c

File tree

3 files changed

+14840
-14782
lines changed

3 files changed

+14840
-14782
lines changed

manuals/physics-messages.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,45 @@
22
layout: manual
33
language: en
44
github: https://github.com/defold/doc
5-
toc: ["Collision messages","Collision response","Trigger response"]
5+
toc: ["Collision messages","Event filtering","Collision response","Trigger response"]
66
title: Collision messages in Defold
7-
brief: When two objects collide, the engine will broadcast messages to all components in both objects.
7+
brief: When two objects collide, the engine may call the event listener or broad cast messages.
88
---
99

1010
# Collision messages
1111

12-
When two objects collide, the engine will broadcast messages to both objects:
12+
When two objects collide, the engine will may send an event to the event callback, or broadcast messages to both objects.
13+
14+
## Event filtering
15+
16+
The types of events generated may be controlled using the flags for each object:
17+
18+
* "Generate Collision Events"
19+
* "Generate Contact Events"
20+
* "Generate Trigger Events"
21+
22+
These are all `true` by default.
23+
When two collision objects interact, we check if we should send a message to the user, given these checkboxes.
24+
25+
E.g. given the "Generate Contact Events" checkboxes:
26+
27+
When using `physics.set_listener()`:
28+
29+
| Component A | Component B | Send Message |
30+
|-------------|-------------|--------------|
31+
| ✅︎ | ✅︎ | Yes |
32+
|| ✅︎ | Yes |
33+
| ✅︎ || Yes |
34+
||| No |
35+
36+
When using the default message handler:
37+
38+
| Component A | Component B | Send Message(s) |
39+
|-------------|-------------|-------------------|
40+
| ✅︎ | ✅︎ | Yes (A,B) + (B,A) |
41+
|| ✅︎ | Yes (B,A) |
42+
| ✅︎ || Yes (A,B) |
43+
||| No |
1344

1445
## Collision response
1546

manuals/physics-objects.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,15 @@ Group
9696
Mask
9797
: The other _groups_ this object should collide with. You can name one group or specify multiple groups in a comma separated list. If you leave the Mask field empty, the object will not collide with anything. [Learn more about collision groups](/manuals/physics-groups).
9898

99+
Generate Collision Events
100+
: If enabled, will allow this object to send collision events
101+
102+
Generate Contact Events
103+
: If enabled, will allow this object to send contact events
104+
105+
Generate Trigger Events
106+
: If enabled, will allow this object to send trigger events
107+
99108

100109
## Runtime properties
101110

0 commit comments

Comments
 (0)