TextSource
Represents a speaker in a TextChannel.
Memory category | Instances |
---|
Member index 3
Description
Represents a speaker in a TextChannel.
TextSources provide details on permissions users have in TextChannels. There may be multiple TextSources for a user if that user belongs in multiple TextChannels.
Create TextSources with TextChannel:AddUserAsync(), which adds a TextSource to the TextChannel as a descendant.
Remove TextSources by calling TextSource.Destroy.
Name of a TextSource is the Player.DisplayName of the user associated with the TextSource via TextSource.UserId.
To learn more about using TextSources, see In-Experience Text Chat.
History 9
- 553 Add
- 553 Change Default of UserId from to 0
- 553 Change Default of CanSend from to true
- 533 Change Tags of TextSource from [NotCreatable, NotBrowsable] to [NotCreatable]
- 514 Change Tags of TextSource from [NotCreatable] to [NotCreatable, NotBrowsable]
- 500 Add UserId
- 500 Add CanSend
- 500 Change Tags of TextSource from [] to [NotCreatable]
- 496 Add TextSource
Members 3
CanSend
Type | Default | |
---|---|---|
bool | true |
Determines whether the user can send messages to the TextChannel.
If false
, user can only read messages in the TextChannel.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |
UserId
Type | Default | |
---|---|---|
int64 | 0 |
UserId of the user represented by the TextSource.
Support for non-user entities may be added in the future via passing in negative numbers for this property.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |