Skip to content

Commit 079bc79

Browse files
authored
Clarity around the sender/receiver in ShouldDeliverCallback.
1 parent 515c0b0 commit 079bc79

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

content/en-us/reference/engine/classes/TextChannel.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -293,17 +293,21 @@ callbacks:
293293
returns anything else (including `nil`), the message won't be delivered to
294294
that client, although the sender will see the message regardless.
295295
296-
The sender can be referenced by `Class.TextChatMessage.TextSource`.
296+
The sender can be referenced by `Class.TextChatMessage.TextSource`. The
297+
receiver is the `textSource` argument. Note that the sender and receiver
298+
can be the same, as the callback iterates through all possible receivers.
299+
In Roblox Studio, you will be the only sender and recipient of a message
300+
while in Play Solo mode.
297301
code_samples: []
298302
parameters:
299303
- name: message
300304
type: TextChatMessage
301305
default:
302-
summary: ''
306+
summary: 'The message being sent, which also contains the sender of the message.'
303307
- name: textSource
304308
type: TextSource
305309
default:
306-
summary: ''
310+
summary: 'The `Class.TextSource` of the user who will be receiving the message.'
307311
returns:
308312
- type: Tuple
309313
summary: ''

0 commit comments

Comments
 (0)