Skip to content

Clarity around the sender/receiver in ShouldDeliverCallback. #1050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 14, 2025
Merged

Clarity around the sender/receiver in ShouldDeliverCallback. #1050

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
079bc79
Clarity around the sender/receiver in ShouldDeliverCallback.
MaximumADHD Mar 13, 2025
bee6564
Apply suggestions from code review
IgnisRBX Mar 14, 2025
a29dbd3
Merge branch 'main' into patch-2
IgnisRBX Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions content/en-us/reference/engine/classes/TextChannel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,17 +293,23 @@ callbacks:
returns anything else (including `nil`), the message won't be delivered to
that client, although the sender will see the message regardless.

The sender can be referenced by `Class.TextChatMessage.TextSource`.
The sender can be referenced by `Class.TextChatMessage.TextSource`,
while the receiver is the `textSource` argument. Note that the sender
and receiver can be the same, as the callback iterates through all possible
receivers. In Roblox Studio, you will be the only sender and recipient of a
message while in solo **Play** mode.
code_samples: []
parameters:
- name: message
type: TextChatMessage
default:
summary: ''
summary: |
The message being sent, which also contains the sender of the message.
- name: textSource
type: TextSource
default:
summary: ''
summary: |
The `Class.TextSource` of the user who will be receiving the message.
returns:
- type: Tuple
summary: ''
Expand Down