Session Manangement Scripting

The AWS GameLift provides Script Canvas nodes that make requests against Amazon GameLift to create, search, join, and leave game sessions.

There are synchronous and asynchronous versions for each action. Asynchronous nodes perform their operation in the AZ JobFunction and finish at some point in the future. These operations communicate over the network through either AWS HTTPS requests or TCP/UDP packets. Each asynchronous node has a corresponding notification handler node.

ConfigureGameLiftClient

To make requests against GameLift, you must create a proper GameLift client using the ConfigureGameLiftClient node. With this node, you can specify the AWS Region where your GameLift fleets are created and reside.

Note that you must specify the AWS Region in the correct format. For example, for the US East (N. Virginia) Region, specify us-east-1. For a list of supported Regions, refer to Amazon GameLift endpoints and quotas in the AWS General Reference.

ConfigureGameLiftClient sample graph

ConfigureGameLiftClient sample graph

CreateSession

Create a session by using the CreateSession node. Configure the session by using either the AWSGameLiftCreateSessionRequest node or the AWSGameLiftCreateSessionOnQueueRequest node. It is recommended to create a session behind a queue asynchronously. See Best practices for GameLift game session queues . After successfully creating a session, other instances of your game can discover it using the SearchSessions node, and then join it using the JoinSession node.

CreateSession sample graph

CreateSession sample graph

CreateSessionAsync sample graph

CreateSessionAsync sample graph

AWSGameLiftCreateSessionOnQueue sample graph

AWSGameLiftCreateSessionOnQueue sample graph

AWSGameLiftCreateSessionOnQueueAsync sample graph

AWSGameLiftCreateSessionOnQueueAsync sample graph

SearchSessions

Get a list of game sessions that are currently active and joinable by using the SearchSessions node. You can specify your search criteria by using the AWSGameLiftSearchSessionsRequest node.

On success, the SearchSessions node returns a list of SearchSessionsResponse objects, which provide details of the sessions found that meet your search criteria.

SearchSessions sample graph

SearchSessions sample graph

SearchSessionsAsync sample graph

SearchSessionsAsync sample graph

JoinSession

After searching for a session, you can join a session using the JoinSession node. Specify the session using its game session id, which you retrieved from SearchSession. If the game successfully connects to the server, you will automatically travel to the server’s map and join the gameplay.

With this node, you can pass in the properties game session id and player id through AWSGameLiftJoinSessionRequest.

JoinSession sample graph

JoinSession sample graph

JoinSessionAsync sample graph

JoinSessionAsync sample graph

LeaveSession

To disconnect from a joined session, use the LeaveSession node.

LeaveSession sample graph

LeaveSession sample graph

LeaveSessionAsync sample graph

LeaveSessionAsync sample graph


Previous topic: AWS GameLift Gem C++ API

Next topic: FlexMatch support


Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.