Skip to content

Commit 2ee32fb

Browse files
sameropIgnisRBX
andauthored
Update StarterGui.yaml (#1080)
Add warning for MakeChatSystemMessage regarding TextChatService incompatibility; Using MakeChatSystemMessage on modern TextChatService does not work ## Changes I added a warning to `MakeChatSystemMessage` method about LegacyChatService requirement. This clarifies that this method only works with the deprecated LegacyChatService and points users to the TextChatService alternative 'DisplaySystemMessage'. By submitting your pull request for review, you agree to the following: - [✅] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [✅] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [✅] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: IgnisRBX <[email protected]>
1 parent d74aa9c commit 2ee32fb

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,8 +340,10 @@ methods:
340340
</table>
341341
342342
##### ChatMakeSystemMessage
343-
344-
Display a formatted message in the chat.
343+
Display a formatted message in the chat. Using this method requires the experience's
344+
`Class.TextChatService.ChatVersion` to be set to `Enum.ChatVersion|LegacyChatService`, although
345+
legacy chat is **deprecated** and usage is discouraged. For experiences using the current
346+
`Class.TextChatService`, refer to `Class.TextChannel:DisplaySystemMessage()`.
345347
346348
<table size="small">
347349
<thead>

0 commit comments

Comments
 (0)