SDK de servidor (Unreal) para Amazon GameLift Servers -- Acciones

Usa el SDK del servidor de Unreal para integrar tu juego multijugador y alojarlo en él Amazon GameLift Servers. Para obtener información sobre el proceso de integración, consulteAdd (Suma) Amazon GameLift Servers a tu servidor de juegos.

nota

Esta referencia es para una versión anterior del SDK del servidor para Amazon GameLift Servers. Para obtener la versión más reciente, consulteSDK 5.x de servidor C++ (Unreal) para Amazon GameLift Servers -- Acciones.

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

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

SDK de servidor (Unreal) para Amazon GameLift Servers -- Tipos de datos

AcceptPlayerSession()

Notifica al Amazon GameLift Servers servicio de que un jugador con el identificador de sesión de jugador especificado se ha conectado al proceso del servidor y necesita ser validado. Amazon GameLift Servers verifica que el identificador de sesión del jugador sea válido, es decir, que el identificador de jugador haya reservado un espacio de jugador en la sesión de juego. Una vez validado, Amazon GameLift Servers cambia el estado de la ranura del jugador de RESERVADO a ACTIVO.

Sintaxis

FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)

Parámetros

playerSessionId

ID único emitido por el Amazon GameLift Servers servicio en respuesta a una llamada al AWS SDK Amazon GameLift Servers Acción de API CreatePlayerSession. El cliente de juego hace referencia a este ID cuando se conecta al proceso del servidor.

Tipo:  FString

Obligatorio: sí

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

ActivateGameSession()

Notifica al Amazon GameLift Servers servicio de que el proceso del servidor ha activado una sesión de juego y ahora está listo para recibir las conexiones de los jugadores. Esta acción debe llamarse como parte de la función de devolución de llamada onStartGameSession(), después de completar la inicialización de todas las sesiones de juego.

Sintaxis

FGameLiftGenericOutcome ActivateGameSession()

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

DescribePlayerSessions()

Recupera datos de sesión de jugador, incluida la configuración, los metadatos de la sesión y los datos de jugador. Utilice esta acción para obtener información para una única sesión de jugador, para todas las sesiones de jugador de una sesión de juego o para todas las sesiones de jugador asociadas a un solo ID de jugador.

Sintaxis

FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)

Parámetros

describePlayerSessionsSolicitud

Es un objeto FDescribePlayerSessionsRequest que describe las sesiones de jugador a recuperar.

Obligatorio: sí

Valor devuelto

Si funciona correctamente, devuelve un objeto FDescribePlayerSessionsRequest que contiene un conjunto de objetos de sesión de jugador que se ajusta a los parámetros de la solicitud. Los objetos de sesión del jugador tienen una estructura idéntica a la del AWS SDK Amazon GameLift Servers Tipo de PlayerSessiondatos de la API.

GetGameSessionId()

Recupera el ID de la sesión de juego alojada actualmente por el proceso del servidor, siempre que esté activo.

Sintaxis

FGameLiftStringOutcome GetGameSessionId()

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si funciona correctamente, devuelve el ID de sesión del juego como objeto FGameLiftStringOutcome. Si no funciona, devuelve un mensaje de error.

GetInstanceCertificate()

Recupera la ubicación del archivo de un certificado TLS codificado con pem que está asociado a la flota y sus instancias. AWS Certificate Manager genera este certificado al crear una nueva flota con la configuración del certificado establecida en GENERATED. Utilice este certificado para establecer una conexión segura con un cliente de juego y para cifrar la comunicación cliente/servidor.

Sintaxis

FGameLiftGetInstanceCertificateOutcome GetInstanceCertificate()

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si se ejecuta correctamente, devuelve un objeto GetInstanceCertificateOutcome que contiene la ubicación del archivo de certificado TLS y la cadena de certificados de la flota, que se almacena en la instancia. En la instancia también se almacena un archivo de certificado raíz extraído de la cadena de certificados. Si no funciona, devuelve un mensaje de error.

Para obtener más información sobre el certificado y los datos de la cadena de certificados, consulte los elementos de GetCertificate respuesta en la referencia de la AWS Certificate Manager API.

GetSdkVersion()

Devuelve el número de versión actual del SDK integrado en el proceso del servidor.

Sintaxis

FGameLiftStringOutcome GetSdkVersion();

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Si funciona correctamente, devuelve la versión del SDK actual como objeto FGameLiftStringOutcome. La cadena devuelta solo incluye el número de versión (por ejemplo, («3.1.5»). Si no funciona, devuelve un mensaje de error.

Ejemplo

Aws::GameLift::AwsStringOutcome SdkVersionOutcome = 
    Aws::GameLift::Server::GetSdkVersion(); 

InitSDK()

Inicializa el Amazon GameLift Servers SDK. Este método debe invocarse en el momento del lanzamiento, antes que cualquier otro Amazon GameLift ServersSe produce una inicialización relacionada.

Sintaxis

FGameLiftGenericOutcome InitSDK()

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

ProcessEnding()

Notifica al Amazon GameLift Servers servicio de que el proceso del servidor se está cerrando. Este método debe llamarse después de realizar las demás tareas de limpieza, incluido el cierre de todas las sesiones de juego activas. Se debe salir de este método con un código de salida de 0; un código de salida que no sea 0 provoca un mensaje de evento que afirma que no se ha salido del proceso correctamente.

Sintaxis

FGameLiftGenericOutcome ProcessEnding()

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

ProcessReady()

Notifica al Amazon GameLift Servers servicio de que el proceso del servidor está listo para albergar sesiones de juego. Llame a este método después de invocar correctamente a InitSDK() y completar las tareas de configuración necesarias antes de que el proceso del servidor pueda alojar una sesión de juego. Se debe llamar a este método solo una vez por proceso.

Sintaxis

FGameLiftGenericOutcome ProcessReady(FProcessParameters &processParameters)

Parámetros

FProcessParámetros

Es un objeto FProcessParámetros que comunica la siguiente información acerca del proceso del servidor:

• Nombres de los métodos de devolución de llamada, implementados en el código del servidor del juego, que Amazon GameLift Servers el servicio invoca para comunicarse con el proceso del servidor.

• Número de puerto de escucha del servidor de proceso.

• Ruta a cualquier archivo específico de la sesión de juego que desees Amazon GameLift Servers para capturar y almacenar.

Obligatorio: sí

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

Ejemplo

Consulte el código de ejemplo en Using the Unreal Engine Plugin.

RemovePlayerSession()

Notifica al Amazon GameLift Servers servicio de que un jugador con el identificador de sesión de jugador especificado se ha desconectado del proceso del servidor. En respuesta, Amazon GameLift Servers cambia el espacio del jugador a uno disponible, lo que permite asignarlo a un nuevo jugador.

Sintaxis

FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)

Parámetros

playerSessionId

ID único emitido por el Amazon GameLift Servers servicio en respuesta a una llamada al AWS SDK Amazon GameLift Servers Acción de API CreatePlayerSession. El cliente de juego hace referencia a este ID cuando se conecta al proceso del servidor.

Tipo:  FString

Obligatorio: sí

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

StartMatchBackfill()

Envía una solicitud para encontrar nuevos jugadores en las tragaperras abiertas en una sesión de juego creada con FlexMatch. Consulte también la acción del AWS SDK StartMatchBackfill(). Con esta acción, un proceso del servidor de juegos que aloja la sesión de juego puede iniciar solicitudes de reposición de emparejamiento. Más información sobre el FlexMatch función de relleno.

Esta acción es asíncrona. Si los nuevos jugadores se emparejan correctamente, el Amazon GameLift Servers el servicio proporciona datos actualizados de los emparejadores mediante la función de devolución de llamada. OnUpdateGameSession()

Un proceso del servidor solo puede tener una solicitud de reposición de emparejamiento activa a la vez. Para enviar una nueva solicitud, en primer lugar llame a StopMatchBackfill() para cancelar la solicitud original.

Sintaxis

FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);

Parámetros

FStartMatchBackfillRequest

Un objeto FStartMatchBackfillRequest que comunica la siguiente información:

• Un ID de ticket que se asignará a la solicitud de reposición. Esta información es opcional; si no se proporciona ninguna identificación, Amazon GameLift Servers generará uno automáticamente.

• El creador de emparejamientos al que se enviará la solicitud. El ARN de configuración completo es obligatorio. Este valor se puede obtener de los datos del creador de emparejamientos de la sesión de juego.

• El ID de la sesión de juego que está en fase de reposición.

• Datos de emparejamiento disponibles para los jugadores actuales de la sesión de juego.

Obligatorio: sí

Valor devuelto

Si funciona correctamente, devuelve el ticket de reposición de emparejamiento como un objeto FGameLiftStringOutcome. Si no funciona, devuelve un mensaje de error. El estado del ticket se puede rastrear mediante la acción del AWS SDK DescribeMatchmaking().

StopMatchBackfill()

Cancela una solicitud de reposición de emparejamiento activa que se creó con StartMatchBackfill(). Consulte también la acción del AWS SDK StopMatchmaking(). Más información sobre el FlexMatch función de relleno.

Sintaxis

FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);

Parámetros

StopMatchBackfillRequest

Un objeto FStopMatchBackfillRequest que identifica el ticket de emparejamiento que se va a cancelar:

• ID del ticket asignado a la solicitud de reposición que se va a cancelar

• el creador de emparejamientos al que se envió la solicitud de reposición

• sesión de juego asociada a la solicitud de reposición

Obligatorio: sí

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

TerminateGameSession()

Este método está obsoleto con la versión 4.0.1. En su lugar, el proceso del servidor debería llamar a ProcessEnding() una vez finalizada la sesión de juego.

Notifica al Amazon GameLift Servers servicio de que el proceso del servidor ha finalizado la sesión de juego actual. Se llama a esta acción cuando el proceso del servidor permanece activo y listo para alojar una nueva sesión de juego. Solo debes llamarlo una vez finalizado el procedimiento de finalización de la sesión de juego, ya que indica que Amazon GameLift Servers que el proceso del servidor está disponible inmediatamente para albergar una nueva sesión de juego.

No se llamará a esta acción si el proceso del servidor se interrumpe una vez finalizada la sesión de juego. En su lugar, se llamará a ProcessEnding() para indicar que tanto la sesión de juego como el proceso del servidor están finalizando.

Sintaxis

FGameLiftGenericOutcome TerminateGameSession()

Parámetros

Esta acción no tiene parámetros.

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.

UpdatePlayerSessionCreationPolicy()

Actualiza la capacidad de la sesión de juego actual para aceptar sesiones de jugador nuevas. Una sesión de juego se puede configurar para que acepte o deniegue todas las sesiones nuevas de los jugadores. (Véase también la UpdateGameSession()acción en la Amazon GameLift Servers Referencia de la API de servicio).

Sintaxis

FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)

Parámetros

Política

Valor que indica si la sesión de juego acepta jugadores nuevos.

Tipo: EPlayerSessionCreationPolicy enum. Los valores válidos son:

• ACCEPT_ALL: se aceptan todas las sesiones de jugador nuevas.

• DENY_ALL: se rechazan todas las sesiones de jugador nuevas.

Obligatorio: sí

Valor devuelto

Devuelve un resultado genérico correcto o erróneo con un mensaje de error.