From 079bc79c83daf96f844dc93074ec19fa3d4820ff Mon Sep 17 00:00:00 2001 From: Max Date: Thu, 13 Mar 2025 15:27:50 -0500 Subject: [PATCH 1/2] Clarity around the sender/receiver in ShouldDeliverCallback. --- .../en-us/reference/engine/classes/TextChannel.yaml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/content/en-us/reference/engine/classes/TextChannel.yaml b/content/en-us/reference/engine/classes/TextChannel.yaml index 4b0a88f35..af16583ac 100644 --- a/content/en-us/reference/engine/classes/TextChannel.yaml +++ b/content/en-us/reference/engine/classes/TextChannel.yaml @@ -293,17 +293,21 @@ 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`. 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 Play Solo 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: '' From bee65644b35dc638010ffbfd6336c3012355623f Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Fri, 14 Mar 2025 06:15:50 -1000 Subject: [PATCH 2/2] Apply suggestions from code review --- .../reference/engine/classes/TextChannel.yaml | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/content/en-us/reference/engine/classes/TextChannel.yaml b/content/en-us/reference/engine/classes/TextChannel.yaml index af16583ac..cab9ef913 100644 --- a/content/en-us/reference/engine/classes/TextChannel.yaml +++ b/content/en-us/reference/engine/classes/TextChannel.yaml @@ -293,21 +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 - 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 Play Solo mode. + 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: 'The message being sent, which also contains the sender of the message.' + summary: | + The message being sent, which also contains the sender of the message. - name: textSource type: TextSource default: - summary: 'The `Class.TextSource` of the user who will be receiving the message.' + summary: | + The `Class.TextSource` of the user who will be receiving the message. returns: - type: Tuple summary: ''