Lumberyard
Guía del usuario (Version 1.19)

Variables de la consola, clases y métodos de conexión de Twitch ChatPlay

Este tema contiene información sobre las variables de consola, las clases y los métodos de conexión de Twitch ChatPlay.

Variables de la consola

Twitch ChatPlay utiliza las siguientes variables de consola.

chatplay_Enabled

Habilita o deshabilita la característica Twitch ChatPlay.

Valor predeterminado: 1

Valores válidos: 0 = Deshabilitar | 1 = Habilitar

chatplay_UserName

Nombre de usuario predeterminado que se utiliza para iniciar sesión en la interfaz IRC de Twitch. El valor predeterminado es un usuario anónimo que pueden leer el chat, pero no publicar.

Valor predeterminado: justinfan12345

chatplay_Password

Contraseña predeterminada que se utiliza para iniciar sesión en la interfaz IRC de Twitch.

Valor predeterminado: blah

chatplay_ClientID

ID de cliente que genera desde Twitch.tv para hacer solicitudes de API. Consulte Generación y configuración de un ID de cliente de Twitch.

chatplay_ServerListEndpoint

Dirección básica que se utiliza para realizar solicitudes de API. Establezca el ID de cliente para que estas llamadas a la API se realicen correctamente.

Valor predeterminado: tmi.twitch.tv

Clases

El módulo Twitch ChatPlay se implementa como parte de CryAction y se puede obtener acceso a él desde el método GetChatPlay. La interfaz principal es el archivo ChatPlay.h.

Twitch ChatPlay utiliza las siguientes clases.

IChatChannel

Interfaz que representa un canal Twitch ChatPlay e incluye devoluciones de llamada de palabras clave y opciones para suscribirse al estado de conexión.

IChatPlay

Interfaz que representa el sistema básico desde el que se pueden obtener controladores para canales Twitch ChatPlay.

ConnectionState

Describe el estado de la conexión de un canal de chat.

  • Disconnected – Se ha desconectado correctamente del chat de Twitch del canal o no se ha intentado una conexión.

  • Connecting – Se está conectando con el chat de Twitch del canal.

  • Connected – Se ha conectado correctamente con el chat de Twitch del canal.

  • Error – Se ha producido un error que ha impedido o ha terminado de manera inesperada la conexión.

  • Failed – Todos los intentos de conexiones han fallado.

Métodos de conexión

Puede utilizar varios métodos y puertos para conectar Twitch ChatPlay al IRC de Twitch.

Twitch ChatPlay utiliza las siguientes variables de consola para configurar los métodos de conexión. Establezca estas variables de la consola con pares priority:port separados por comas. Los puertos con un número inferior tendrán una mayor prioridad. Los puertos con una prioridad de -1 se omitirán. Twitch ChatPlay intentará conectarse a la interfaz IRC de Twitch y, para ello, utilizará cada método y combinación de puertos por orden de prioridad, hasta que se establezca una conexión o todas las combinaciones disponibles den error.

chatplay_IRCPorts

Lista de los puertos y prioridades para conectarse a la interfaz IRC de Twitch.

Valor predeterminado: 1:6667;3:80

chatplay_IRCSSLPorts

Lista de los puertos y prioridades para conectarse a la interfaz IRC de Twitch a través de SSL.

Valor predeterminado: -1:6697;-1:443

chatplay_WebsocketPorts

Lista de los puertos y prioridades para conectarse a la interfaz IRC de Twitch a través de conectores web.

Valor predeterminado: 2:80

chatplay_WebsocketSSLPorts

Lista de los puertos y prioridades para conectarse a la interfaz IRC de Twitch a través de conectores web seguros.

Valor predeterminado: -1:443