TextChatCommand

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Représente une commande de chat texte. Peut être utilisée pour créer des commandes de chat texte personnalisées lorsqu'elle est parentée à TextChatService.

Les commandes personnalisées peuvent avoir jusqu'à deux alias, et l'événement déclenché se déclenche lorsqu'un utilisateur tape "/PrimaryAlias" ou "/SecondaryAlias" dans le chat.Pour un exemple de commandes personnalisées, voir commandes de chat texte personnalisées .

Pour en savoir plus sur l'utilisation de TextChatService, voir chat de texte en expérience.

Résumé

Propriétés

Évènements

Propriétés

AutocompleteVisible

Lecture parallèle

Enabled

Lecture parallèle

Détermine si le TextChatCommand est activé.

Lorsqu'il est désactivé, les messages correspondant à "/PrimaryAlias" ou "/SecondaryAlias" ne sont pas enfouis et sont envoyés à d'autres utilisateurs.

Utilisez ceci pour désactiver les commandes par défaut sur une base cas par cas.

PrimaryAlias

Lecture parallèle

Un alias principal utilisé pour déclencher le TextChatCommand.

Si un utilisateur envoie un message avec TextChannel:SendAsync() qui correspond à "/`Class.TextChatCommand.PrimaryAlias`", le message n'est pas envoyé et au lieu de cela TextChatCommand.Triggered est déclenché.

SecondaryAlias

Lecture parallèle

Un alias secondaire utilisé pour déclencher le TextChatCommand.

Méthodes

Évènements

Triggered

Un événement auquel les développeurs peuvent se lier pour exécuter des commandes.

Lorsqu'un utilisateur envoie un message au serveur via TextChannel:SendAsync(), le message est intercepté par le TextChatCommand et n'est pas répliqué à d'autres utilisateurs si le contenu du message correspond à "/`Class.TextChatCommand.PrimaryAlias`" ou "/`Class.TextChatCommand.SecondaryAlias`".

Par exemple, pour un TextChatCommand avec TextChatCommand.PrimaryAlias comme "mettre en sourdine", si un utilisateur envoie "/mute SomeUserName", alors le TextChatCommand pertinent pour le silence tirera son TextChatCommand.Triggered .Le message "/mute SomeUserName" n'est pas répliqué vers d'autres utilisateurs.

Paramètres

originTextSource: TextSource

Une référence à la TextSource responsable du déclenchement de la commande via TextChannel:SendAsync() .

unfilteredText: string

Le texte complet et non filtré utilisé pour déclencher la commande qui peut être utilisé pour disséquer les paramètres du message de commande.