Referencia del SDK del servidor de Amazon GameLift para Unreal Engine: Tipos de datos

Esta referencia del servidor de Amazon GameLift puede ayudarle a preparar los proyectos de juego de Unreal Engine para utilizarlos con Amazon GameLift. Para obtener más información sobre el proceso de integración, consulte Añade Amazon GameLift a tu servidor de juegos.

Esta API se define en GameLiftServerSDK.h y GameLiftServerSDKModels.h.

Para configurar el complemento Unreal Engine y ver ejemplos de código, consulte Integre Amazon GameLift en un proyecto de Unreal Engine.

• Acciones

• Tipos de datos

FDescribePlayerSessionsRequest

Este tipo de datos se utiliza para especificar qué sesión o sesiones de jugador recuperar. Puede utilizarlo para las siguientes tareas:

• Proporcionar un PlayerSessionId para solicitar una sesión de jugador específica.

• Proporcionar un GameSessionId para solicitar todas las sesiones de jugador de la sesión de juego especificada.

• Proporcionar un PlayerId para solicitar todas las sesiones de jugador del jugador especificado.

Para grandes conjuntos de sesiones de jugador, utilice los parámetros de paginación para recuperar los resultados en bloques consecutivos.

Contenido

GameSessionId

Identificador único de la sesión de juego. Use este parámetro para solicitar todas las sesiones de jugador de la sesión de juego especificada. El formato de ID de la sesión de juego es el siguiente: arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>. El valor de la <cadena de ID> es una cadena de ID personalizada o (si se especificó una cuando se creó la sesión de juego) una cadena generada.

Tipo: String

Requerido: No

Límite

Número máximo de resultados a devolver. Use este parámetro con NextToken para obtener resultados en un conjunto de páginas secuenciales. Si se especifica un ID de sesión de jugador, este parámetro se ignora.

Tipo: entero

Obligatorio: no

NextToken

Token que indica el inicio de la siguiente página de resultados secuencial. Utilice el token devuelto con una llamada anterior a esta acción. Para especificar el inicio del conjunto de resultados, no indique ningún valor. Si se especifica un ID de sesión de jugador, este parámetro se ignora.

Tipo: String

Requerido: No

PlayerId

Identificador único de un jugador. Los ID de jugador los define el desarrollador. Consulte Generación de ID de jugador.

Tipo: String

Requerido: No

PlayerSessionId

Identificador único de una sesión de jugador.

Tipo: String

Requerido: No

PlayerSessionStatusFilter

Estado de la sesión de juego para filtrar los resultados. Los posibles estados de sesión de jugador son:

• RESERVED: se ha recibido la solicitud de sesión de jugador, pero el jugador aún no se ha conectado al proceso del servidor o aún no se ha validado.

• ACTIVE: el proceso del servidor ha validado el jugador y actualmente está conectado.

• COMPLETED: ha caído la conexión del jugador.

• TIMEDOUT: se ha recibido una solicitud de sesión de jugador, pero el jugador no se ha conectado y/o no se ha validado en el plazo de tiempo de espera (60 segundos).

Tipo: String

Requerido: No

FProcessParameters

Este tipo de datos contiene el conjunto de parámetros enviado a un servicio de Amazon GameLift en una llamada a ProcessReady().

Contenido

puerto

Es el número de puerto al que escucha el proceso del servidor para conexiones de jugador nuevas. El valor debe estar en el rango de puertos configurado para cualquier flota que implemente esa compilación de servidor de juegos. Este número de puerto se incluye en los objetos de sesión de juego y de jugador, que las sesiones de juego utilizan a la hora de conectarse a un proceso del servidor.

Tipo: entero

Obligatorio: sí

logParameters

Objeto con una lista de rutas de directorio a archivos de log de la sesión de juego.

Tipo: TArray<FString>

Obligatorio: no

onStartGameSession

Nombre de la función de devolución de llamada que el servicio de Amazon GameLift invoca para activar una nueva sesión de juego. Amazon GameLift llama a esta función como respuesta a la solicitud de cliente CreateGameSession. La función de devolución de llamada toma un objeto GameSession (definido en la Referencia de la API del servicio de Amazon GameLift).

Tipo: FOnStartGameSession

Obligatorio: sí

onProcessTerminate

Nombre de la función de devolución de llamada que el servicio de Amazon GameLift invoca para forzar el cierre del proceso de servidor. Después de llamar a esta función, Amazon GameLift espera cinco minutos hasta que el proceso de servidor se cierre y responde con una llamada a ProcessEnding() antes de cerrar el proceso de servidor.

Tipo: FSimpleDelegate

Obligatorio: no

onHealthCheck

Nombre de la función de devolución de llamada que invoca el servicio de Amazon GameLift para solicitar un informe de estado del proceso de servidor. Amazon GameLift llama a esta función cada 60 segundos. Después de llamar a esta función, Amazon GameLift espera una respuesta durante 60 segundos y si no recibe ninguna, registra el proceso del servidor como en mal estado.

Tipo: FOnHealthCheck

Obligatorio: no

onUpdateGameSession

Nombre de la función de devolución de llamada que el servicio de Amazon GameLift invoca para pasar un objeto de sesión de juego actualizado al proceso de servidor. Amazon GameLift llama a esta función cuando se ha procesado una solicitud de reposición de emparejamiento para proporcionar datos actualizados de los emparejadores. Pasa un objeto GameSession, una actualización de estado (updateReason) y el ID del ticket de reposición de emparejamiento.

Tipo: FOnUpdateGameSession

Obligatorio: no

FStartMatchBackfillRequest

Este tipo de datos se utiliza para enviar una solicitud de reposición de emparejamiento. La información se comunicará al servicio de Amazon GameLift en una llamada a StartMatchBackfill().

Contenido

GameSessionArn

Identificador único de la sesión de juego. La acción de la API GetGameSessionId() devuelve el identificador en formato de ARN.

Tipo: FString

Obligatorio: sí

MatchmakingConfigurationArn

Identificador único, en forma de un ARN, que el creador de emparejamientos utiliza para esta solicitud. Para encontrar el creador de emparejamientos que se usó para crear la sesión de juego original, busque en el objeto de sesión de juego, en la propiedad de datos del creador de emparejamientos. Puede obtener más información sobre los datos del emparejador en Trabajo con datos del emparejador.

Tipo: FString

Obligatorio: sí

Players

Un conjunto de datos que representa a todos los jugadores que están actualmente en la sesión de juego. El creador de emparejamientos utiliza esta información para buscar nuevos jugadores que son idóneos para los jugadores actuales. Para obtener una descripción del formato del objeto Player, consulte Guía de referencia de la API de Amazon GameLift. Para encontrar los atributos, ID y asignaciones de equipo del jugador, busque en el objeto de sesión de juego, en la propiedad de datos del creador de emparejamientos. Si el creador de emparejamientos utiliza latencia, recopile la latencia actualizada para la región actual e inclúyala en los datos de cada jugador.

Tipo: TArray<FPlayer>

Obligatorio: sí

TicketId

Identificador único para un ticket de solicitud de emparejamiento o reposición de emparejamiento. Si no se proporciona ningún valor aquí, Amazon GameLift generará uno en forma de UUID. Use este identificador para realizar un seguimiento del estado del ticket de reposición de emparejamiento o cancelar la solicitud si es necesario.

Tipo: FString

Obligatorio: no

FStopMatchBackfillRequest

Este tipo de datos se utiliza para cancelar una solicitud de reposición de emparejamiento. La información se comunicará al servicio de Amazon GameLift en una llamada a StopMatchBackfill().

Contenido

GameSessionArn

Identificador único de sesión de juego asociado a la solicitud que se va a cancelar.

Tipo: FString

Obligatorio: sí

MatchmakingConfigurationArn

Identificador único del creador de emparejamientos al que se envió esta solicitud.

Tipo: FString

Obligatorio: sí

TicketId

Identificador único del ticket de solicitud de reposición que se va a cancelar.

Tipo: FString

Obligatorio: sí