Referensi SDK GameLift server Amazon untuk Unreal Engine: Tindakan

Referensi Amazon GameLift Server SDK ini dapat membantu Anda mempersiapkan proyek game Unreal Engine Anda untuk digunakan dengan Amazon. GameLift Untuk informasi detail tentang proses integrasi, lihat Tambahkan Amazon GameLift ke server game Anda.

API ini didefinisikan dalam GameLiftServerSDK.h dan GameLiftServerSDKModels.h.

Untuk menyiapkan plugin Unreal Engine dan melihat contoh kode Integrasikan Amazon GameLift ke dalam proyek Unreal Engine.

• Tindakan

• Tipe data

AcceptPlayerSession()

Memberitahu GameLift layanan Amazon bahwa pemain dengan ID sesi pemain tertentu telah terhubung ke proses server dan memerlukan validasi. Amazon GameLift memverifikasi bahwa ID sesi pemain valid—yaitu, ID pemain telah memesan slot pemain dalam sesi permainan. Setelah divalidasi, Amazon GameLift mengubah status slot pemain dari RESERVED menjadi AKTIF.

Sintaks

FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)

Parameter

playerSessionId

ID unik yang dikeluarkan oleh GameLift layanan Amazon sebagai respons terhadap panggilan ke tindakan AWS CreatePlayerSessionSDK Amazon GameLift API. Client game mereferensi ID ini saat menghubungkan ke proses server.

Jenis: String

Wajib: Ya

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

ActivateGameSession()

Memberitahu GameLift layanan Amazon bahwa proses server telah mengaktifkan sesi permainan dan sekarang siap untuk menerima koneksi pemain. Tindakan ini harus dipanggil sebagai bagian dari fungsi callback onStartGameSession(), setelah semua inisialisasi sesi game selesai.

Sintaks

FGameLiftGenericOutcome ActivateGameSession()

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

DescribePlayerSessions()

Mengambil data sesi pemain, termasuk pengaturan, metadata sesi, dan data pemain. Gunakan tindakan ini untuk mendapatkan informasi untuk satu sesi pemain, untuk semua sesi pemain dalam sesi game, atau untuk semua sesi pemain yang terkait dengan ID pemain tunggal.

Sintaks

FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)

Parameter

describePlayerSessionsPermintaan

Sebuah objek F DescribePlayerSessionsRequest yang menjelaskan sesi pemain mana yang diambil.

Wajib: Ya

Nilai kembali

Jika berhasil, ini mengembalikan objek F DescribePlayerSessionsRequest yang berisi satu set objek sesi pemain yang sesuai dengan parameter permintaan. Objek sesi pemain memiliki struktur yang identik dengan tipe PlayerSessiondata AWS SDK Amazon GameLift API.

GetGameSessionId()

Mengambil ID dari sesi game yang saat ini sedang di-host oleh proses server, jika proses server aktif.

Sintaks

FGameLiftStringOutcome GetGameSessionId()

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Jika berhasil, ini mengembalikan ID sesi game sebagai objek FGameLiftStringOutcome. Jika tidak berhasil, ini mengembalikan pesan kesalahan.

GetInstanceCertificate()

Mengambil lokasi file sertifikat TLS yang dikodekan pem-yang dikaitkan dengan armada dan instansinya. AWS Certificate Managermenghasilkan sertifikat ini ketika Anda membuat armada baru dengan konfigurasi sertifikat diatur ke GENERATED. Gunakan sertifikat ini untuk membuat koneksi yang aman dengan client game dan untuk mengenkripsi komunikasi client/server.

Sintaks

FGameLiftGetInstanceCertificateOutcome GetInstanceCertificate()

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Jika berhasil, mengembalikan GetInstanceCertificateOutcome objek yang berisi lokasi file sertifikat TLS armada dan rantai sertifikat, yang disimpan pada instance. File sertifikat root, yang diekstrak dari rantai sertifikat, juga disimpan pada instance. Jika tidak berhasil, ini mengembalikan pesan kesalahan.

Untuk informasi selengkapnya tentang data sertifikat dan rantai sertifikat, lihat Elemen GetCertificate Respons di Referensi AWS Certificate Manager API.

GetSdkVersion()

Mengembalikan nomor versi SDK saat ini yang dibangun ke dalam proses server.

Sintaks

FGameLiftStringOutcome GetSdkVersion();

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Jika berhasil, ini mengembalikan versi SDK saat ini sebagai objek FGameLiftStringOutcome. String yang dikembalikan mencakup nomor versi saja (mis. "3.1.5"). Jika tidak berhasil, ini mengembalikan pesan kesalahan.

Contoh

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

InitSDK()

Menginisialisasi Amazon GameLift SDK. Metode ini harus dipanggil pada peluncuran, sebelum inisialisasi GameLift terkait Amazon lainnya terjadi.

Sintaks

FGameLiftGenericOutcome InitSDK()

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

ProcessEnding()

Memberitahu GameLift layanan Amazon bahwa proses server dimatikan. Metode ini harus dipanggil setelah semua tugas pembersihan lainnya, termasuk mematikan semua sesi game aktif. Metode ini harus keluar dengan kode keluar 0; sebuah kode non-nol menghasilkan pesan kejadian bahwa proses tidak keluar dengan bersih.

Sintaks

FGameLiftGenericOutcome ProcessEnding()

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

ProcessReady()

Memberitahu GameLift layanan Amazon bahwa proses server siap untuk menyelenggarakan sesi game. Panggil metode ini setelah berhasil meminta InitSDK() dan menyelesaikan tugas penyiapan yang diperlukan sebelum proses server dapat menjadi host sesi game. Metode ini harus dipanggil hanya satu kali per proses.

Sintaks

FGameLiftGenericOutcome ProcessReady(FProcessParameters &processParameters)

Parameter

F ProcessParameters

Sebuah objek F ProcessParameters yang mengomunikasikan informasi berikut tentang proses server:

• Nama metode callback, diimplementasikan dalam kode server game, yang dipanggil GameLift layanan Amazon untuk berkomunikasi dengan proses server.

• Nomor port yang didengarkan oleh proses server.

• Jalur ke file khusus sesi game apa pun yang Anda GameLift ingin Amazon tangkap dan simpan.

Wajib: Ya

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

Contoh

Lihat kode sampel di Menggunakan Plugin Unreal Engine.

RemovePlayerSession()

Memberitahu GameLift layanan Amazon bahwa pemain dengan ID sesi pemain tertentu telah terputus dari proses server. Sebagai tanggapan, Amazon GameLift mengubah slot pemain menjadi tersedia, yang memungkinkannya ditugaskan ke pemain baru.

Sintaks

FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)

Parameter

playerSessionId

ID unik yang dikeluarkan oleh GameLift layanan Amazon sebagai respons terhadap panggilan ke tindakan AWS CreatePlayerSessionSDK Amazon GameLift API. Client game mereferensi ID ini saat menghubungkan ke proses server.

Jenis: String

Wajib: Ya

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

StartMatchBackfill()

Mengirim permintaan untuk menemukan pemain baru untuk slot terbuka dalam sesi permainan yang dibuat denganFlexMatch. Lihat juga tindakan AWS SDK StartMatchBackfill(). Dengan tindakan ini, permintaan backfill match dapat dimulai dengan proses server game yang menjadi host sesi game. Pelajari lebih lanjut tentang fitur FlexMatch isi ulang.

Tindakan ini asinkron. Jika pemain baru berhasil dicocokkan, GameLift layanan Amazon mengirimkan data mak comblang yang diperbarui menggunakan fungsi callback. OnUpdateGameSession()

Proses server hanya dapat melakukan satu permintaan backfill match yang aktif dalam satu waktu. Untuk mengirim permintaan baru, panggil StopMatchBackfill() terlebih dahulu untuk membatalkan permintaan asli.

Sintaks

FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);

Parameter

F StartMatchBackfillRequest

Sebuah objek F StartMatchBackfillRequest yang mengkomunikasikan informasi berikut:

• ID tiket untuk ditetapkan ke permintaan backfill. Informasi ini bersifat opsional; jika tidak ada ID yang disediakan, Amazon GameLift akan membuat satu secara otomatis.

• Matchmaker untuk dikirimi permintaan. ARN konfigurasi penuh diperlukan. Nilai ini dapat diperoleh dari data matchmaker sesi game.

• ID dari sesi game yang sedang di-backfill.

• Data matchmaking yang tersedia untuk pemain sesi game saat ini.

Wajib: Ya

Nilai kembali

Jika berhasil, mengembalikan tiket backfill match sebagai objek FGameLiftStringOutcome. Jika tidak berhasil, ini mengembalikan pesan kesalahan. Status tiket dapat dilacak menggunakan tindakan AWS SDK DescribeMatchmaking().

StopMatchBackfill()

Membatalkan permintaan backfill match aktif yang dibuat dengan StartMatchBackfill(). Lihat juga tindakan AWS SDK StopMatchmaking(). Pelajari lebih lanjut tentang fitur FlexMatch isi ulang.

Sintaks

FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);

Parameter

StopMatchBackfillRequest

Sebuah objek F StopMatchBackfillRequest yang mengidentifikasi tiket matchmaking untuk membatalkan:

• ID tiket yang ditetapkan ke permintaan backfill yang dibatalkan

• matchmaker yang dikirimi permintaan backfill

• sesi game yang terkait dengan permintaan backfill

Wajib: Ya

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

TerminateGameSession()

Metode ini tidak lagi digunakan dengan versi 4.0.1. Sebagai gantinya, proses server harus menelepon ProcessEnding() setelah sesi permainan berakhir.

Memberitahu GameLift layanan Amazon bahwa proses server telah mengakhiri sesi game saat ini. Tindakan ini dipanggil ketika proses server akan tetap aktif dan siap untuk menjadi host sesi game baru. Ini harus dipanggil hanya setelah prosedur penghentian sesi permainan Anda selesai, karena sinyal ke Amazon GameLift bahwa proses server segera tersedia untuk menjadi tuan rumah sesi permainan baru.

Tindakan ini tidak dipanggil jika proses server akan dimatikan setelah sesi game berhenti. Sebagai gantinya, panggil ProcessEnding() untuk memberi tahu bahwa sesi game dan proses server akan berakhir.

Sintaks

FGameLiftGenericOutcome TerminateGameSession()

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.

UpdatePlayerSessionCreationPolicy()

Memperbarui kemampuan sesi game saat ini untuk menerima sesi pemain baru. Sesi game dapat diatur untuk menerima atau menolak semua sesi pemain baru. (Lihat juga UpdateGameSession()tindakan di Amazon GameLift Service API Reference).

Sintaks

FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)

Parameter

Kebijakan

Nilai yang menunjukkan apakah sesi game menerima pemain baru.

Jenis: Enum EPlayerSessionCreationPolicy. Nilai yang valid meliputi:

• ACCEPT_ALL — Menerima semua sesi pemain baru.

• DENY_ALL — Menolak semua sesi pemain baru.

Wajib: Ya

Nilai kembali

Mengembalikan hasil generik yang terdiri dari keberhasilan atau kegagalan dalam sebuah pesan kesalahan.