Lumberyard
Guía del usuario (Version 1.21)

Referencia de Lua de Twitch ChatPlay

Pude utilizar funciones de script de Lua para añadir características Twitch ChatPlay al proyecto de juego.

Para obtener más información acerca de los buses de eventos que utiliza Lumberyard, consulte Trabajo con el sistema de bus de eventos (EBus).

ChatPlayRequestBus

Use ChatPlayRequestBus.Broadcast.MethodName(parameters) para realizar solicitudes en este EBus.

Política de direcciones: única

Política de controlador: única

CreateChannel

Crea un canal de chat con el valor especificado para channelName. Devuelve true si el canal de chat se crea correctamente. Devuelve false si el canal de chat no se crea.

Parámetros

string channelName

Tipo de retorno

Booleano

DestroyChannel

Destruye el canal de chat para el nombre del canal especificado.

Parámetros

string channelName

Tipo de retorno

Vacío

DisconnectAll

Desconecta todos los canales de chat.

Parámetros

Ninguno

Tipo de retorno

Vacío

RegisterCredentials

Registra el par de token de autenticación y nombre de usuario especificados con Twitch ChatPlay. Este par se utiliza al enviar susurros.

Parámetros

string username, string oauthToken

Tipo de retorno

Vacío

UnregisterCredentials

Anula el registro de las credenciales para el nombre de usuario especificado.

Parámetros

string username

Tipo de retorno

Vacío

UnregisterAllCredentials

Anula el registro de todas las credenciales almacenadas.

Parámetros

Ninguno

Tipo de retorno

Vacío

SendWhisper

Envía un susurro que incluye un mensaje especificado desde un remitente especificado al destinatario especificado. Debe registrar las credenciales del remitente antes de usar este método. Consulte RegisterCredentials.

Devuelve un token que se comprueba con el token que se transfiere a la devolución de llamada OnWhisperSent. Consulte ChatPlayNotificationBus.

Parámetros

string sender, string recipient, string message

Tipo de retorno

Número

CreateVote

Crea una funcionalidad de voto de Twitch ChatPlay para el ID de voto especificado. Puede utilizar cualquier cadena única para el ID de voto. Devuelve true si la funcionalidad de voto se crea correctamente. Devuelve false si la funcionalidad de voto no se crea.

Parámetros

string voteID

Tipo de retorno

Booleano

DestroyVote

Destruye la funcionalidad de voto de Twitch ChatPlay para el ID de voto especificado.

Parámetros

string voteID

Tipo de retorno

Vacío

ChatPlayNotificationBus

Use ChatPlayNotificationBus.Connect(self) para conectar el controlador e implementar uno o varios métodos en el script de Lua.

Política de direcciones: única

Política de controlador: múltiple

OnWhisperSent

Se llama cuando se envía un susurro correctamente. El token sentToken se asocia con el susurro que se ha enviado.

Parámetros

number sentToken

Tipo de retorno

Vacío

A continuación se muestra un ejemplo de OnWhisperSent:

function MyLuaScript:OnWhisperSent(sentToken) if (sentToken == myWhisperToken) then -- My Whisper was sent successfully! end end

ChatPlayChannelRequestBus

Use ChatPlayChannelRequestBus.Event.MethodName(channelName, parameters) para realizar solicitudes en este EBus.

Política de direcciones: por ID (nombre de canal de Twitch)

Política de controlador: múltiple

Conexión

Se conecta al chat de canal de Twitch.

Parámetros

Ninguno

Tipo de retorno

Vacío

Desconectar

Desconecta el canal de chat especificado del chat de Twitch.

Parámetros

Ninguno

Tipo de retorno

Vacío

GetConnectionState

Devuelve el estado de conexión del canal de chat especificado. Consulte ConnectionState.

Parámetros

Ninguno

Tipo de retorno

ConnectionState

A continuación se muestra un ejemplo de GetConnectionState:

connectionState = ChatPlayChannelRequestBus.Event.GetConnectionState(self.Properties.Channel); if (connectionState == ConnectionState.Disconnected) then Debug.Log("Disconnected"); elseif (connectionState == ConnectionState.Connecting) then Debug.Log("Connecting"); elseif (connectionState == ConnectionState.Connected) then Debug.Log("Connected"); elseif (connectionState == ConnectionState.Error) then Debug.Log("Error"); elseif (connectionState == ConnectionState.Failed) then Debug.Log("Failed"); end

ChatPlayChannelNotificationBus

Use ChatPlayChannelNotificationBus.Connect(self, channelName) para conectar el controlador e implementar uno o varios métodos en el script de Lua.

Política de direcciones: por ID (nombre de canal de Twitch)

Política de controlador: múltiple

OnConnectionStateChanged

Se llama cuando el estado de conexión del canal de chat cambia. Consulte ConnectionState.

Parámetros

ConnectionState state

Tipo de retorno

Vacío

OnKeywordMatched

Se llama cuando se encuentra una coincidencia con una palabra registrada.

  • keyword: palabra clave original registrada o expresiones regulares de las que se ha encontrado una coincidencia.

  • match: cadena coincidente real.

  • username: nombre del usuario que ha desencadenado la correspondencia.

Parámetros

string keyword, string match, string username

Tipo de retorno

Vacío

ChatPlayVoteRequestBus

Use ChatPlayVoteRequestBus.Event.MethodName(voteID, parameters) para realizar solicitudes en este EBus.

Política de direcciones: por ID (nombre/cadena de voto único)

Política de controlador: única

AddOption

Añade una opción de voto para la palabra clave (o regex) especificado al voto. Devuelve true si la opción de voto se añade correctamente. Devuelve false si la la opción de voto no se añade.

Parámetros

string keyword

Tipo de retorno

Booleano

RemoveOption

Elimina la opción de voto que tiene la palabra clave especificada.

Parámetros

string keyword

Tipo de retorno

Vacío

ConfigureOption

Configura la opción de voto con la palabra clave especificada y establece el recuento de votos y el estado habilitado.

Parámetros

string keyword, number count, bool enabled

Tipo de retorno

Vacío

OptionExists

Devuelve true si existe una opción de voto con la palabra clave especificada. Devuelve false si no existe una opción de voto con la palabra clave especificada.

Parámetros

string keyword

Tipo de retorno

Booleano

GetOptionCount

Devuelve el recuento de votos para la opción con la palabra clave especificada.

Parámetros

string keyword

Tipo de retorno

Número

SetOptionCount

Establece el recuento de votos para la opción con la palabra clave especificada.

Parámetros

string keyword, number count

Tipo de retorno

Vacío

GetOptionEnabled

Devuelve true si se habilita para el voto o las coincidencias una opción de voto con la palabra clave especificada. Devuelve false si se deshabilita para el voto o las coincidencias una opción de voto con la palabra clave especificada.

Parámetros

string keyword

Tipo de retorno

Booleano

SetOptionEnabled

Establece el estado habilitado para la opción con la palabra clave especificada.

Parámetros

string keyword, bool enabled

Tipo de retorno

Vacío

SetChannel

Establece el canal de Twitch asociado para ChatPlayVote en el nombre del canal especificado. Esto crea un canal de chat con el valor especificado para channelName, si no existe aún ningún canal de chat. Devuelve true si el canal de chat se crea correctamente. Devuelve false si el canal de chat no se crea.

Parámetros

string channelName

Tipo de retorno

Booleano

ClearChannel

Borra el canal de Twitch asociado del ChatPlayVote.

Parámetros

Ninguno

Tipo de retorno

Vacío

SetEnableStateAll

Establece el estado habilitado para todas las opciones en el ChatPlayVote.

Parámetros

bool enabled

Tipo de retorno

Vacío

SetCountAll

Establece el recuento de votos para todas las opciones en el ChatPlayVote.

Parámetros

number count

Tipo de retorno

Vacío

SetVoterLimiting

Establece la limitación de votantes. Si es true, solo se tiene en cuenta para la opción de recuento el primer voto de cada usuario. Si es false, todos los votos se tienen en cuenta para la opción de recuento.

Parámetros

bool limiting

Tipo de retorno

Vacío

ResetVotedList

Restablece la lista de usuarios que han votado. Permite volver a contar los votos de usuario.

Parámetros

Ninguno

Tipo de retorno

Vacío