Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# SDK del servidor (Unreal) para Amazon GameLift Servers: acciones
<a name="integration-server-sdk-unreal-ref-actions"></a>

Utilice el SDK del servidor para Unreal como ayuda para integrar su juego multijugador para el alojamiento con Amazon GameLift Servers. Para obtener ayuda con el proceso de integración, consulte [Adición de Amazon GameLift Servers al servidor de juegos con el SDK del servidor](gamelift-sdk-server-api.md).

**nota**  
Esta referencia es para una versión anterior del SDK del servidor de Amazon GameLift Servers. Para obtener la última versión, consulte [SDK 5.x del servidor de C\+\+ (Unreal) para Amazon GameLift Servers: acciones](integration-server-sdk5-unreal-actions.md).

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

Para configurar el complemento Unreal Engine y ver ejemplos de código, consulte [Integración de Amazon GameLift Servers en un proyecto de Unreal Engine](integration-engines-setup-unreal.md).

[SDK del servidor (Unreal) para Amazon GameLift Servers: tipos de datos](integration-server-sdk-unreal-ref-datatypes.md)

**Topics**
+ [SDK del servidor (Unreal) para Amazon GameLift Servers: tipos de datos](integration-server-sdk-unreal-ref-datatypes.md)
+ [AcceptPlayerSession()](#integration-server-sdk-unreal-ref-acceptplayersession)
+ [ActivateGameSession()](#integration-server-sdk-unreal-ref-activategamesession)
+ [DescribePlayerSessions()](#integration-server-sdk-unreal-ref-describeplayersessions)
+ [GetGameSessionId()](#integration-server-sdk-unreal-ref-getgamesessionid)
+ [GetInstanceCertificate()](#integration-server-sdk-unreal-ref-getinstancecertificate)
+ [GetSdkVersion()](#integration-server-sdk-unreal-ref-getsdk)
+ [InitSDK()](#integration-server-sdk-unreal-ref-initsdk)
+ [ProcessEnding()](#integration-server-sdk-unreal-ref-processending)
+ [ProcessReady()](#integration-server-sdk-unreal-ref-processready)
+ [RemovePlayerSession()](#integration-server-sdk-unreal-ref-removeplayersession)
+ [StartMatchBackfill()](#integration-server-sdk-unreal-ref-startmatchbackfill)
+ [StopMatchBackfill()](#integration-server-sdk-unreal-ref-stopmatchbackfill)
+ [TerminateGameSession()](#integration-server-sdk-unreal-ref-terminategamesession)
+ [UpdatePlayerSessionCreationPolicy()](#integration-server-sdk-unreal-ref-updateplayersessioncreationpolicy)

## AcceptPlayerSession()
<a name="integration-server-sdk-unreal-ref-acceptplayersession"></a>

Informa al servicio Amazon GameLift Servers de que un jugador con el ID de sesión de jugador especificado se ha conectado al proceso del servidor y requiere validación. Amazon GameLift Servers verifica que el ID de sesión del jugador es válido; es decir, que el ID de jugador ha reservado un espacio de jugador en la sesión de juego. Una vez completada la validación, Amazon GameLift Servers cambia el estado de la ranura de jugador de RESERVADO a ACTIVO. 

### Sintaxis
<a name="integration-server-sdk-unreal-ref-acceptplayersession-syntax"></a>

```
FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)
```

### Parameters
<a name="integration-server-sdk-unreal-ref-acceptplayersession-parameter"></a>

**playerSessionId**  
ID único emitido por el Amazon GameLift Servers servicio en respuesta a una llamada a la acción de la Amazon GameLift Servers API del AWS SDK [CreatePlayerSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html). El cliente de juego hace referencia a este ID cuando se conecta al proceso del servidor.  
Tipo: FString  
Obligatorio: sí

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-acceptplayersession-return"></a>

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

## ActivateGameSession()
<a name="integration-server-sdk-unreal-ref-activategamesession"></a>

Notifica al servicio Amazon GameLift Servers que el proceso del servidor ha activado una sesión de juego y que 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
<a name="integration-server-sdk-unreal-ref-activategamesession-syntax"></a>

```
FGameLiftGenericOutcome ActivateGameSession()
```

### Parameters
<a name="integration-server-sdk-unreal-ref-activategamesession-parameter"></a>

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-activategamesession-return"></a>

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

## DescribePlayerSessions()
<a name="integration-server-sdk-unreal-ref-describeplayersessions"></a>

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
<a name="integration-server-sdk-unreal-ref-describeplayersessions-syntax"></a>

```
FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)
```

### Parameters
<a name="integration-server-sdk-unreal-ref-describeplayersessions-parameter"></a>

**describePlayerSessionsSolicitud**  
Es un objeto [FDescribePlayerSessionsRequest](integration-server-sdk-unreal-ref-datatypes.md#integration-server-sdk-unreal-ref-dataypes-playersessions) que describe las sesiones de jugador a recuperar.  
Obligatorio: sí

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-describeplayersessions-return"></a>

Si funciona correctamente, devuelve un objeto [FDescribePlayerSessionsRequest](integration-server-sdk-unreal-ref-datatypes.md#integration-server-sdk-unreal-ref-dataypes-playersessions) 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 al tipo de [PlayerSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_PlayerSession.html)datos de la Amazon GameLift Servers API del AWS SDK.

## GetGameSessionId()
<a name="integration-server-sdk-unreal-ref-getgamesessionid"></a>

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

### Sintaxis
<a name="integration-server-sdk-unreal-ref-getgamesessionid-syntax"></a>

```
FGameLiftStringOutcome GetGameSessionId()
```

### Parameters
<a name="integration-server-sdk-unreal-ref-getgamesessionid-parameter"></a>

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-getgamesessionid-return"></a>

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

## GetInstanceCertificate()
<a name="integration-server-sdk-unreal-ref-getinstancecertificate"></a>

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
<a name="integration-server-sdk-unreal-ref-getinstancecertificate-syntax"></a>

```
FGameLiftGetInstanceCertificateOutcome GetInstanceCertificate()
```

### Parameters
<a name="integration-server-sdk-unreal-ref-getinstancecertificate-parameter"></a>

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-getinstancecertificate-return"></a>

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](https://docs.aws.amazon.com/acm/latest/APIReference/API_GetCertificate.html#API_GetCertificate_ResponseElements) en la referencia de la AWS Certificate Manager API.

## GetSdkVersion()
<a name="integration-server-sdk-unreal-ref-getsdk"></a>

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

### Sintaxis
<a name="integration-server-sdk-unreal-ref-getsdk-syntax"></a>

```
FGameLiftStringOutcome GetSdkVersion();
```

### Parameters
<a name="integration-server-sdk-unreal-ref-getsdk-parameter"></a>

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-getsdk-return"></a>

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
<a name="integration-server-sdk-unreal-ref-getsdk-example"></a>

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

## InitSDK()
<a name="integration-server-sdk-unreal-ref-initsdk"></a>

Inicializa el SDK de Amazon GameLift Servers. Este método debe llamarse en el momento del lanzamiento, antes de cualquier otra inicialización relacionada con Amazon GameLift Servers.

### Sintaxis
<a name="integration-server-sdk-unreal-ref-initsdk-syntax"></a>

```
FGameLiftGenericOutcome InitSDK()
```

### Parameters
<a name="integration-server-sdk-unreal-ref-initsdk-parameter"></a>

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-initsdk-return"></a>

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

## ProcessEnding()
<a name="integration-server-sdk-unreal-ref-processending"></a>

Notifica al servicio Amazon GameLift Servers que el proceso del servidor se va a detener. 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
<a name="integration-server-sdk-unreal-ref-processending-syntax"></a>

```
FGameLiftGenericOutcome ProcessEnding()
```

### Parameters
<a name="integration-server-sdk-unreal-ref-processending-parameter"></a>

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-processending-return"></a>

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

## ProcessReady()
<a name="integration-server-sdk-unreal-ref-processready"></a>

Notifica al servicio Amazon GameLift Servers que el proceso del servidor está listo para alojar sesiones de juego. Llame a este método después de invocar correctamente a [InitSDK()](#integration-server-sdk-unreal-ref-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
<a name="integration-server-sdk-unreal-ref-processready-syntax"></a>

```
FGameLiftGenericOutcome ProcessReady(FProcessParameters &processParameters)
```

### Parameters
<a name="integration-server-sdk-unreal-ref-processready-parameter"></a>

**FProcessParámetros**  
Es un objeto [FProcessParámetros](integration-server-sdk-unreal-ref-datatypes.md#integration-server-sdk-unreal-ref-dataypes-process) que comunica la siguiente información acerca del proceso del servidor:  
+ Nombres de métodos de devolución de llamada, implementados en el código de servidor de juegos, que el servicio Amazon GameLift Servers 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 desea que Amazon GameLift Servers capture y almacene.
Obligatorio: sí

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-processready-return"></a>

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

### Ejemplo
<a name="integration-server-sdk-unreal-ref-processready-example"></a>

Consulte el código de ejemplo en [Using the Unreal Engine Plugin](integration-engines-setup-unreal.md#integration-engines-setup-unreal-code).

## RemovePlayerSession()
<a name="integration-server-sdk-unreal-ref-removeplayersession"></a>

Notifica al servicio Amazon GameLift Servers que un jugador con el ID de sesión de jugador especificado se ha desconectado del proceso del servidor. En respuesta, Amazon GameLift Servers cambia el estado de la ranura de jugador a disponible, por lo que se le puede asignar un jugador nuevo. 

### Sintaxis
<a name="integration-server-sdk-unreal-ref-removeplayersession-syntax"></a>

```
FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)
```

### Parameters
<a name="integration-server-sdk-unreal-ref-removeplayersession-parameter"></a>

**playerSessionId**  
ID único emitido por el Amazon GameLift Servers servicio en respuesta a una llamada a la acción de la Amazon GameLift Servers API del AWS SDK [CreatePlayerSession](https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html). El cliente de juego hace referencia a este ID cuando se conecta al proceso del servidor.  
Tipo: FString  
Obligatorio: sí

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-removeplayersession-return"></a>

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

## StartMatchBackfill()
<a name="integration-server-sdk-unreal-ref-startmatchbackfill"></a>

Envía una solicitud para encontrar nuevos jugadores para ranuras abiertas en una sesión de juego creada con FlexMatch. Consulte también la acción del AWS SDK [StartMatchBackfill()](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html). 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. Obtenga más información sobre la [característica de reposición de FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html).

Esta acción es asíncrona. Si se emparejan correctamente nuevos jugadores, el servicio Amazon GameLift Servers ofrece datos actualizados del emparejador por medio de 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()](#integration-server-sdk-unreal-ref-stopmatchbackfill) para cancelar la solicitud original.

### Sintaxis
<a name="integration-server-sdk-unreal-ref-startmatchbackfill-syntax"></a>

```
FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);
```

### Parameters
<a name="integration-server-sdk-unreal-ref-startmatchbackfill-parameter"></a>

**FStartMatchBackfillRequest**  
Un objeto [FStartMatchBackfillRequest](integration-server-sdk-unreal-ref-datatypes.md#integration-server-sdk-unreal-ref-dataypes-startmatchbackfillrequest) 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 ningún ID, Amazon GameLift Servers lo generará 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
<a name="integration-server-sdk-unreal-ref-startmatchbackfill-return"></a>

Si funciona correctamente, devuelve el ticket de reposición de emparejamiento como un objeto `FGameLiftStringOutcome`. Si no funciona, devuelve un mensaje de error. Se puede realizar un seguimiento del estado de los tickets mediante la acción del AWS SDK [DescribeMatchmaking()](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeMatchmaking.html).

## StopMatchBackfill()
<a name="integration-server-sdk-unreal-ref-stopmatchbackfill"></a>

Cancela una solicitud de reposición de emparejamiento activa que se creó con [StartMatchBackfill()](#integration-server-sdk-unreal-ref-startmatchbackfill). Consulte también la acción del AWS SDK [StopMatchmaking()](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopMatchmaking.html). Obtenga más información sobre la [característica de reposición de FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html).

### Sintaxis
<a name="integration-server-sdk-unreal-ref-stopmatchbackfill-syntax"></a>

```
FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);
```

### Parameters
<a name="integration-server-sdk-unreal-ref-stopmatchbackfill-parameter"></a>

**StopMatchBackfillRequest**  
Un objeto [FStopMatchBackfillRequest](integration-server-sdk-unreal-ref-datatypes.md#integration-server-sdk-unreal-ref-dataypes-stopmatchbackfillrequest) 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
<a name="integration-server-sdk-unreal-ref-stopmatchbackfill-return"></a>

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

## TerminateGameSession()
<a name="integration-server-sdk-unreal-ref-terminategamesession"></a>

**Este método está obsoleto con la versión 4.0.1. En su lugar, el proceso del servidor debería llamar a [ProcessEnding()](#integration-server-sdk-unreal-ref-processending) una vez finalizada la sesión de juego.**

Informa al servicio de Amazon GameLift Servers 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 debe llamarse una vez finalizado el procedimiento de finalización de la sesión de juego, ya que indica a Amazon GameLift Servers que el proceso del servidor está disponible inmediatamente para alojar 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()](#integration-server-sdk-unreal-ref-processending) para indicar que tanto la sesión de juego como el proceso del servidor están finalizando. 

### Sintaxis
<a name="integration-server-sdk-unreal-ref-terminategamesession-syntax"></a>

```
FGameLiftGenericOutcome TerminateGameSession()
```

### Parameters
<a name="integration-server-sdk-unreal-ref-terminategamesession-parameter"></a>

Esta acción no tiene parámetros.

### Valor devuelto
<a name="integration-server-sdk-unreal-ref-terminategamesession-return"></a>

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

## UpdatePlayerSessionCreationPolicy()
<a name="integration-server-sdk-unreal-ref-updateplayersessioncreationpolicy"></a>

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. (Consulte también la acción [https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) en la *Referencia de la API del servicio Amazon GameLift Servers*).

### Sintaxis
<a name="integration-server-sdk-unreal-ref-updateplayersessioncreationpolicy-syntax"></a>

```
FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)
```

### Parameters
<a name="integration-server-sdk-unreal-ref-updateplayersessioncreationpolicy-parameter"></a>

**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
<a name="integration-server-sdk-unreal-ref-updateplayersessioncreationpolicy-return"></a>

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