mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
83 lines
2.4 KiB
YAML
83 lines
2.4 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: TextSource
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Represents a speaker in a `Class.TextChannel`.
|
|
description: |
|
|
Represents a speaker in a `Class.TextChannel`.
|
|
|
|
`Class.TextSource|TextSources` provide details on permissions users have in
|
|
`Class.TextChannel|TextChannels`. There may be multiple
|
|
`Class.TextSource|TextSources` for a user if that user belongs in multiple
|
|
`Class.TextChannel|TextChannels`.
|
|
|
|
Create `Class.TextSource|TextSources` with `Class.TextChannel:AddUserAsync()`,
|
|
which adds a `Class.TextSource` to the `Class.TextChannel` as a descendant.
|
|
|
|
Remove `Class.TextSource|TextSources` by calling `Class.TextSource.Destroy`.
|
|
|
|
Name of a `Class.TextSource` is the `Class.Player.DisplayName` of the user
|
|
associated with the `Class.TextSource` via `Class.TextSource.UserId`.
|
|
|
|
To learn more about using TextSources, see
|
|
[In-Experience Text Chat](../../../chat/in-experience-text-chat.md).
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags:
|
|
- NotCreatable
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: TextSource.CanSend
|
|
summary: |
|
|
Determines whether the user can send messages to the `Class.TextChannel`.
|
|
description: |
|
|
Determines whether the user can send messages to the `Class.TextChannel`.
|
|
|
|
If `false`, user can only read messages in the `Class.TextChannel`.
|
|
code_samples: []
|
|
type: boolean
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Chat
|
|
- name: TextSource.UserId
|
|
summary: |
|
|
UserId of the user represented by the `Class.TextSource`.
|
|
description: |
|
|
UserId of the user represented by the `Class.TextSource`.
|
|
|
|
Support for non-user entities may be added in the future via passing in
|
|
negative numbers for this property.
|
|
code_samples: []
|
|
type: int64
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: false
|
|
can_save: false
|
|
capabilities:
|
|
- Chat
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|