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.
Referencia GameLift del servidor Amazon SDK (Unreal): tipos de datos
Puedes usar esta SDK referencia del servidor Amazon GameLift Unreal como ayuda para preparar tu juego multijugador para usarlo 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 y para obtener información sobre el uso del complemento de SDK servidor Unreal, consulte. Integre Amazon GameLift en un proyecto de Unreal Engine
Tipos de datos
- FProcessParameters
- UpdateGameSession
- GameSession
- FServerParameters
- FStartMatchBackfillRequest
- FPlayer
- FGameLiftDescribePlayerSessionsRequest
- FStopMatchBackfillRequest
- FAttributeValue
- FGameLiftGetFleetRoleCredentialsRequest
- FGameLiftLongOutcome
- FGameLiftStringOutcome
- FGameLiftDescribePlayerSessionsOutcome
- FGameLiftDescribePlayerSessionsResult
- FGenericOutcome
- FGameLiftPlayerSession
- FGameLiftGetComputeCertificateOutcome
- FGameLiftGetComputeCertificateResult
- FGameLiftGetFleetRoleCredentialsOutcome
- FGetFleetRoleCredentialsResult
- FGameLiftError
- Enums
nota
En este tema se describe Amazon GameLift C++ API que puede usar al compilar para Unreal Engine. En concreto, esta documentación se aplica al código que se compila con la opción -DBUILD_FOR_UNREAL=1
.
FProcessParameters
Este tipo de datos contiene el conjunto de parámetros enviados a Amazon GameLift en unProcessReady().
Propiedades |
Descripción |
LogParameters | Un objeto con rutas de directorio a los archivos que se generan durante una sesión de juego. Amazon GameLift copia y almacena los archivos para acceder a ellos en el futuro. Tipo: Obligatorio: no |
OnHealthCheck | La función de devolución de llamada que Amazon GameLift invoca para solicitar un informe de estado de salud al proceso del servidor. Amazon GameLift llama a esta función cada 60 segundos y espera 60 segundos para recibir una respuesta. El proceso del servidor devuelve TRUE si está en buen estado y FALSE si no. Si no se devuelve ninguna respuesta, Amazon GameLift registra el proceso del servidor como incorrecto. Esta propiedad es una función de delegación definida como Tipo: Obligatorio: no |
OnProcessTerminate | La función de devolución de llamada que Amazon GameLift invoca para forzar el cierre del proceso del servidor. Tras llamar a esta función, Amazon GameLift espera 5 minutos a que se cierre el proceso del servidor y responde con una ProcessEnding() llamada antes de cerrar el proceso del servidor. Tipo: Obligatorio: sí |
OnStartGameSession | La función de devolución de llamada que Amazon GameLift invoca para activar una nueva sesión de juego. Amazon GameLift llama a esta función en respuesta a una solicitud de un cliente CreateGameSession. La función callback pasa un GameSession objeto. Esta propiedad es una función de delegación definida como Tipo: Obligatorio: sí |
OnUpdateGameSession | La función de devolución de llamada que Amazon GameLift invoca para pasar un objeto de sesión de juego actualizado al proceso del servidor. Amazon GameLift llama a esta función cuando se ha procesado una solicitud de relleno de partidas para proporcionar datos actualizados de los emparejadores. Transmite un GameSession objeto, una actualización de estado (updateReason ) y el identificador del ticket de relleno del partido. Esta propiedad es una función de delegación definida como Tipo: Obligatorio: no |
Puerto | El número de puerto en el que escucha el proceso del servidor para recibir 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: Obligatorio: sí |
UpdateGameSession
Este tipo de datos se actualiza a un objeto de sesión de juego, que incluye el motivo por el que se actualizó la sesión de juego y el ID del ticket de reposición correspondiente si la reposición se utiliza para reponer las sesiones de los jugadores en la sesión de juego.
Propiedades | Descripción |
---|---|
GameSession | Un objeto GameSession. El objeto GameSession contiene propiedades que describen una sesión de juego. Tipo: Obligatorio: no |
UpdateReason | El motivo por el que se actualiza la sesión de juego. Tipo:
Obligatorio: no |
BackfillTicketId | El ID de ticket de reposición que intenta actualizar la sesión de juego. Tipo: Obligatorio: no |
GameSession
Este tipo de datos proporciona detalles de una sesión de juego.
Propiedades | Descripción |
---|---|
GameSessionId |
Un identificador único de la sesión de juego. Una sesión de juego ARN tiene el siguiente formato: Tipo: Obligatorio: no |
Nombre |
Una etiqueta descriptiva de la sesión de juego. Tipo: Obligatorio: no |
FleetId |
Un identificador único para la flota en la que se ejecuta la sesión de juego. Tipo: Obligatorio: no |
MaximumPlayerSessionCount |
El número máximo de conexiones de jugadores a la sesión de juego. Tipo: Obligatorio: no |
Puerto |
El número de puerto de la sesión de juego. Para conectarse a un servidor de GameLift juegos de Amazon, una aplicación necesita tanto la dirección IP como el número de puerto. Tipo: Obligatorio: no |
IpAddress |
La dirección IP del servidor de la sesión de juego. Para conectarse a un servidor de GameLift juegos de Amazon, una aplicación necesita tanto la dirección IP como el número de puerto. Tipo: Obligatorio: no |
GameSessionData |
Un conjunto de propiedades de sesión de juego personalizadas, formateadas como un valor de una sola cadena. Tipo: Obligatorio: no |
MatchmakerData |
Información sobre el proceso de emparejamiento que se utilizó para crear la sesión de juego, en JSON sintaxis, formateada como una cadena. Además de la configuración de emparejamiento utilizada, contiene datos sobre todos los jugadores asignados al emparejamiento, incluidos los atributos de los jugadores y las asignaciones de los equipos. Tipo: Obligatorio: no |
GameProperties |
Un conjunto de propiedades personalizadas de una sesión de juego, con formato como pares clave-valor. Estas propiedades se pasan a una solicitud de iniciar una nueva sesión de juego. Tipo: Obligatorio: no |
DnsName |
El DNS identificador asignado a la instancia que ejecuta la sesión de juego. Los valores tienen formato siguiente:
Cuando te conectes a una sesión de juego que se ejecute en una flota TLS habilitada, debes usar el DNS nombre, no la dirección IP. Tipo: Obligatorio: no |
FServerParameters
Información utilizada para mantener la conexión entre un GameLift Anywhere servidor de Amazon y el GameLift servicio de Amazon. Esta información se utiliza al inicializar nuevos procesos de servidor con InitSDK(). Para los servidores alojados en EC2 instancias GameLift gestionadas por Amazon, usa un objeto vacío.
Propiedades | Descripción |
---|---|
webSocketUrl |
Tipo: Obligatorio: sí |
processId |
Un identificador único registrado en el proceso del servidor que aloja el juego. Tipo: Obligatorio: sí |
hostId | El HostID es el ComputeName utilizado cuando registró el recurso informático. Para obtener más información, consulte, RegisterCompute.Tipo: Obligatorio: sí |
fleetId | El identificador único de la flota en la que está registrado el recurso informático. Para obtener más información, consulte, RegisterCompute. Tipo: Obligatorio: sí |
authToken | El token de autenticación generado por Amazon GameLift que autentica tu servidor en Amazon GameLift. Para obtener más información, consulte, GetComputeAuthToken. Tipo: Obligatorio: sí |
FStartMatchBackfillRequest
Información utilizada para crear una solicitud de reposición de emparejamiento. El servidor del juego comunica esta información a Amazon GameLift en una StartMatchBackfill() llamada.
Propiedades | Descripción |
---|---|
GameSessionArn |
Un identificador único de la sesión de juegos. La API operación Tipo: Obligatorio: sí |
MatchmakingConfigurationArn |
Un identificador único, en forma deARN, para que el emparejador lo utilice en esta solicitud. El emparejador de la sesión ARN de juego original se encuentra en el objeto de sesión de juego de la propiedad de datos del emparejador. Puede obtener más información sobre los datos del emparejador en Trabajo con datos del emparejador. Tipo: Obligatorio: sí |
Players |
Un conjunto de datos que representa a todos los jugadores que están 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. Tipo: Obligatorio: sí |
TicketId |
Un identificador único para un ticket de solicitud de emparejamiento o reposición de emparejamiento. Si no proporcionas un valor, Amazon GameLift generará uno. Use este identificador para realizar un seguimiento del estado del ticket de reposición de emparejamiento o cancelar la solicitud si es necesario. Tipo: Obligatorio: no |
FPlayer
Este tipo de datos representa a un jugador en el sistema de emparejamiento. Al iniciar una solicitud de emparejamiento, un jugador tiene un ID de jugador, atributos y, posiblemente, datos de latencia. Amazon GameLift añade la información del equipo después de que se haya disputado un partido.
Propiedades | Descripción |
---|---|
LatencyInMS |
Un conjunto de valores expresados en milisegundos que indican la cantidad de latencia que experimenta un jugador cuando se conecta a una ubicación. Si se utiliza esta propiedad, el jugador solo se empareja con las ubicaciones que aparecen. Si un creador de emparejamientos tiene una regla que evalúa la latencia de los jugadores, estos deben informar de la latencia para ser emparejados. Tipo: Obligatorio: no |
PlayerAttributes |
Una colección de pares de clave-valor que contienen información del jugador para su uso en el emparejamiento. Las claves de atributos del jugador deben coincidir con las PlayerAttributes utilizadas en un conjunto de reglas de emparejamiento. Para obtener más información sobre los atributos de los jugadores, consulte AttributeValue. Tipo: Obligatorio: no |
PlayerId |
Un identificador único de un jugador. Tipo: Obligatorio: no |
Equipo |
El nombre del equipo al que está asignado el jugador en un emparejamiento. Defina el nombre del equipo se define en el conjunto de reglas de emparejamiento. Tipo: Obligatorio: no |
FGameLiftDescribePlayerSessionsRequest
Un objeto que especifica las sesiones de jugador que recuperar. El proceso del servidor proporciona esta información con una DescribePlayerSessions() llamada a Amazon GameLift.
Propiedades | Descripción |
---|---|
GameSessionId |
Un identificador único de la sesión de juegos. Use este parámetro para solicitar todas las sesiones de jugador de la sesión de juego especificada. El formato de ID de sesión de juego es Tipo: Obligatorio: no |
PlayerSessionId |
El identificador único de una sesión de jugador. Utilice este parámetro para solicitar una sesión de jugador específica. Tipo: Obligatorio: no |
PlayerId |
El identificador único de un jugador. Utilice este parámetro para solicitar todas las sesiones de jugador para un jugador específico. Consulte Generación de ID de jugador. Tipo: Obligatorio: no |
PlayerSessionStatusFilter |
El estado de la sesión de jugador para filtrar los resultados. Los posibles estados de sesión de jugador son los siguientes:
Tipo: Obligatorio: no |
NextToken |
El token que indica el inicio de la siguiente página de resultados. 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: Obligatorio: no |
Límite |
El número máximo de resultados que devolver. Si se especifica un ID de sesión de jugador, este parámetro se ignora. Tipo: Obligatorio: no |
FStopMatchBackfillRequest
Información utilizada para cancelar una solicitud de reposición de emparejamiento. El servidor del juego comunica esta información al GameLift servicio de Amazon en una StopMatchBackfill() llamada.
Propiedades | Descripción |
---|---|
GameSessionArn |
Un identificador único de sesión de juego de la solicitud que se va a cancelar. Tipo: Obligatorio: sí |
MatchmakingConfigurationArn |
Un identificador único del emparejador al que se envió esta solicitud. Tipo: Obligatorio: sí |
TicketId |
Un identificador único del ticket de solicitud de reposición que se va a cancelar. Tipo: Obligatorio: sí |
FAttributeValue
Utilice estos valores en pares de clave-valor de atributo FPlayer. Este objeto le permite especificar un valor de atributo mediante cualquiera de los tipos de datos válidos: cadena, número, matriz de cadenas o mapa de datos. Cada objeto AttributeValue
puede utilizar solo una de las propiedades disponibles.
Propiedades | Descripción |
---|---|
attrType |
Especifica el tipo de valor del atributo. Tipo: un valor de enum de Obligatorio: no |
S |
Representa un valor de atributo de cadena. Tipo: Obligatorio: no |
N |
Representa un valor de atributo numérico. Tipo: Obligatorio: no |
SL |
Representa una matriz de valores de atributos de cadena. Tipo: Obligatorio: no |
SDM |
Representa un diccionario de claves de cadena y valores dobles. Tipo: Obligatorio: no |
FGameLiftGetFleetRoleCredentialsRequest
Este tipo de datos proporciona credenciales de rol que amplían el acceso limitado a sus recursos de AWS al servidor de juegos. Para obtener más información, consulte Configurar un rol de servicio de IAM para Amazon GameLift.
Propiedades | Descripción |
---|---|
RoleArn | El nombre del recurso de Amazon (ARN) de la función de servicio que amplía el acceso limitado a sus AWS recursos. Tipo: Obligatorio: no |
RoleSessionName | El nombre de la sesión que describe el uso de las credenciales del rol. Tipo: Obligatorio: no |
FGameLiftLongOutcome
Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:
Propiedades | Descripción |
---|---|
Resultado |
El resultado de la acción. Tipo: Obligatorio: no |
ResultWithOwnership |
El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto. Tipo: Obligatorio: no |
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: FGameLiftError Obligatorio: no |
FGameLiftStringOutcome
Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:
Propiedades | Descripción |
---|---|
Resultado |
El resultado de la acción. Tipo: Obligatorio: no |
ResultWithOwnership |
El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto. Tipo: Obligatorio: no |
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: FGameLiftError Obligatorio: no |
FGameLiftDescribePlayerSessionsOutcome
Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:
Propiedades | Descripción |
---|---|
Resultado |
El resultado de la acción. Tipo: FGameLiftDescribePlayerSessionsResult Obligatorio: no |
ResultWithOwnership |
El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto. Tipo: Obligatorio: no |
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: FGameLiftError Obligatorio: no |
FGameLiftDescribePlayerSessionsResult
Propiedades | Descripción |
---|---|
PlayerSessions |
Tipo: Obligatorio: sí |
NextToken |
El token que indica el inicio de la siguiente página de resultados. 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: Obligatorio: no |
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: FGameLiftError Obligatorio: no |
FGenericOutcome
Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:
Propiedades | Descripción |
---|---|
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: FGameLiftError Obligatorio: no |
FGameLiftPlayerSession
Propiedades | Descripción |
---|---|
CreationTime |
Tipo: Obligatorio: sí |
FleetId |
Tipo: Obligatorio: sí |
GameSessionId |
Tipo: Obligatorio: sí |
IpAddress |
Tipo: Obligatorio: sí |
PlayerData |
Tipo: Obligatorio: sí |
PlayerId |
Tipo: Obligatorio: sí |
PlayerSessionId |
Tipo: Obligatorio: sí |
Puerto |
Tipo: Obligatorio: sí |
Status |
Tipo: una enumeración de Obligatorio: sí |
TerminationTime |
Tipo: Obligatorio: sí |
DnsName |
Tipo: Obligatorio: sí |
FGameLiftGetComputeCertificateOutcome
Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:
Propiedades | Descripción |
---|---|
Resultado |
El resultado de la acción. Tipo: FGameLiftGetComputeCertificateResult Obligatorio: no |
ResultWithOwnership |
El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto. Tipo: Obligatorio: no |
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: FGameLiftError Obligatorio: no |
FGameLiftGetComputeCertificateResult
La ruta al TLS certificado del equipo y el nombre de host del equipo.
Propiedades | Descripción |
---|---|
CertificatePath |
Tipo: Obligatorio: sí |
ComputeName |
Tipo: Obligatorio: sí |
FGameLiftGetFleetRoleCredentialsOutcome
Este tipo de datos es el resultado de una acción y produce un objeto con las siguientes propiedades:
Propiedades | Descripción |
---|---|
Resultado |
El resultado de la acción. Tipo: FGetFleetRoleCredentialsResult Obligatorio: no |
ResultWithOwnership |
El resultado de la acción, expresado como un valor r, para que el código de llamada pueda tomar posesión del objeto. Tipo: Obligatorio: no |
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: FGameLiftError Obligatorio: no |
FGetFleetRoleCredentialsResult
Propiedades | Descripción |
---|---|
AccessKeyId |
El ID de la clave de acceso para autenticar y proporcionar acceso a los recursos de AWS . Tipo: Obligatorio: no |
AssumedRoleId |
El ID del usuario al que pertenece el rol de servicio. Tipo: Obligatorio: no |
AssumedRoleUserArn |
El nombre del recurso de Amazon (ARN) del usuario al que pertenece la función de servicio. Tipo: Obligatorio: no |
Expiration |
El tiempo que queda hasta que caduquen las credenciales de la sesión. Tipo: Obligatorio: no |
SecretAccessKey |
El ID de clave de acceso secreta para la autenticación. Tipo: Obligatorio: no |
SessionToken |
Un token para identificar la sesión activa actual que interactúa con sus AWS recursos. Tipo: Obligatorio: no |
Success |
Si la acción se realizó correctamente o no. Tipo: Obligatorio: sí |
Error |
El error que se genera si la acción no se ha realizado correctamente. Tipo: GameLiftError Obligatorio: no |
FGameLiftError
Propiedades | Descripción |
---|---|
ErrorType |
Tipo de error. Tipo: una enumeración de Obligatorio: no |
ErrorName |
El nombre del error. Tipo: Obligatorio: no |
ErrorMessage |
Mensaje de error. Tipo: Obligatorio: no |
Enums
Las enumeraciones definidas para el GameLift servidor Amazon SDK (Unreal) se definen de la siguiente manera:
- FAttributeType
-
NONE
STRING
DOUBLE
STRING_LIST
STRING_DOUBLE_MAP
- GameLiftErrorType
-
Valor de cadena que indica el tipo de error. Los valores válidos son:
-
SERVICE_ CALL _ FAILED — Falló una llamada a un AWS servicio.
-
LOCAL_ CONNECTION _ FAILED — Se ha producido un GameLift error en la conexión local con Amazon.
-
NETWORK_ NOT _ INITIALIZED — La red no se ha inicializado.
-
GAMESESSION_ID_ NOT _ SET — No se ha establecido el ID de sesión del juego.
-
BAD_REQUEST_EXCEPTION
-
INTERNAL_SERVICE_EXCEPTION
-
ALREADY_ INITIALIZED — El GameLift servidor o cliente de Amazon ya se ha inicializado con Initialize ().
-
FLEET_ MISMATCH — La flota objetivo no coincide con la flota de un gameSession o. playerSession
-
GAMELIFT_ CLIENT _ NOT _ INITIALIZED — El GameLift cliente de Amazon no se ha inicializado.
-
GAMELIFT_ SERVER _ NOT _ INITIALIZED — El GameLift servidor de Amazon no se ha inicializado.
-
GAME_ SESSION _ ENDED _ FAILED — El GameLift servidor de Amazon no SDK pudo contactar con el servicio para informar que la sesión de juego había finalizado.
-
GAME_ SESSION _ NOT _ READY — No se activó la sesión de juego de Amazon GameLift Server.
-
GAME_ SESSION _ READY _ FAILED — El GameLift servidor de Amazon no ha SDK podido contactar con el servicio para informar que la sesión de juego está lista.
-
INITIALIZATION_ MISMATCH — Se llamó a un método de cliente después de Server: :Initialize () o viceversa.
-
NOT_ INITIALIZED — El GameLift servidor o cliente de Amazon no se ha inicializado con Initialize ().
-
NO_ _ TARGET ALIASID _ SET — No se aliasId ha establecido un objetivo.
-
NO_ TARGET _ FLEET _ SET — No se ha establecido una flota objetivo.
-
PROCESS_ ENDING _ FAILED — El GameLift servidor de Amazon no ha SDK podido contactar con el servicio para informar que el proceso está finalizando.
-
PROCESS_ NOT _ ACTIVE — El proceso del servidor aún no está activo, no está vinculado a un GameSession y no puede aceptarlo ni procesarlo PlayerSessions.
-
PROCESS_ NOT _ READY — El proceso del servidor aún no está listo para activarse.
-
PROCESS_ READY _ FAILED — El GameLift servidor de Amazon no ha SDK podido contactar con el servicio para informar que el proceso está listo.
-
SDK_ _ VERSION DETECTION _ FAILED — falló SDK la detección de la versión.
-
STX_ CALL _ FAILED — Falló una llamada al componente de backend del XStx servidor.
-
STX_ INITIALIZATION _ FAILED — No se pudo inicializar el componente de backend del XStx servidor.
-
UNEXPECTED_ PLAYER _ SESSION — El servidor encontró una sesión de jugador no registrada.
-
WEBSOCKET_CONNECT_FAILURE
-
WEBSOCKET_CONNECT_FAILURE_FORBIDDEN
-
WEBSOCKET_CONNECT_FAILURE_INVALID_URL
-
WEBSOCKET_CONNECT_FAILURE_TIMEOUT
-
WEBSOCKET_ RETRIABLE _ SEND _ MESSAGE _ FAILURE — Error recuperable al enviar un mensaje al GameLift Servicio. WebSocket
-
WEBSOCKET_ SEND _ MESSAGE _ FAILURE — No se pudo enviar un mensaje al GameLift Servicio WebSocket.
-
MATCH_ BACKFILL _ REQUEST _ VALIDATION — Falló la validación de la solicitud.
-
PLAYER_ SESSION _ REQUEST _ VALIDATION — Falló la validación de la solicitud.
-
- EPlayerSessionCreationPolicy
-
Valor de cadena que indica si la sesión de juego acepta jugadores nuevos. Los valores válidos son:
-
ACCEPT_ ALL — Acepta todas las sesiones de jugadores nuevos.
-
DENY_ ALL — Denegar todas las sesiones de jugadores nuevos.
-
NOT_ SET — La sesión de juego no está configurada para aceptar o denegar sesiones de nuevos jugadores.
-
- EPlayerSessionStatus
-
ACTIVE
COMPLETED
NOT_SET
RESERVED
TIMEDOUT