Referensi API klien Server Realtime (C #): Tindakan

Referensi API Klien C # Realtime ini dapat membantu Anda mempersiapkan game multipemain untuk digunakan dengan Server Realtime yang digunakan di armada Amazon. GameLift Untuk informasi detail tentang proses integrasi, lihat Siapkan server Realtime.

• Tindakan Sinkron

• Callback Asinkron

• Jenis Data

Client()

Menginisialisasi client baru untuk berkomunikasi dengan server Realtime dan mengidentifikasi jenis koneksi yang akan digunakan.

Sintaks

public Client(ClientConfiguration configuration)

Parameter

clientConfiguration

Detail konfigurasi yang menentukan jenis koneksi client/server. Anda dapat memilih untuk memanggil Client() tanpa parameter ini; namun, pendekatan ini secara default menghasilkan koneksi yang tidak aman.

Tipe: ClientConfiguration

Wajib: Tidak

Nilai kembali

Mengembalikan sebuah instans dari client Realtime untuk digunakan dengan berkomunikasi dengan server Realtime.

Connect()

Meminta koneksi ke proses server yang meng-host sesi game.

Sintaks

public ConnectionStatus Connect(string endpoint, int remoteTcpPort, int listenPort, ConnectionToken token)

Parameter

titik akhir

Nama DNS atau alamat IP sesi game yang akan disambungkan. Titik akhir ditentukan dalam GameSession objek, yang dikembalikan sebagai respons terhadap panggilan klien ke tindakan AWSSDK Amazon GameLift API StartGameSessionPlacement, CreateGameSession, atau. DescribeGameSessions

catatan

Jika server Realtime berjalan pada armada dengan sertifikat TLS, Anda harus menggunakan nama DNS.

Jenis: String

Wajib: Ya

remoteTcpPort

Nomor port untuk koneksi TCP yang ditetapkan ke sesi game. Informasi ini ditentukan dalam sebuah GameSession objek, yang dikembalikan dalam menanggapi StartGameSessionPlacementCreateGameSession, atau DescribeGameSessionpermintaan.

Tipe: Bilangan Bulat

Nilai Valid: 1900 hingga 2000.

Wajib: Ya

listenPort

Nomor port yang didengarkan client game pada pesan yang dikirim menggunakan saluran UDP.

Tipe: Bilangan Bulat

Nilai Valid: 33400 hingga 33500.

Wajib: Ya

token

Informasi opsional yang mengidentifikasi permintaan client game kepada proses server.

Tipe: ConnectionToken

Wajib: Ya

Nilai kembali

Mengembalikan nilai ConnectionStatusenum yang menunjukkan status koneksi klien.

Disconnect()

Memutuskan koneksi client game dari sesi game saat terhubung ke sesi game.

Sintaks

public void Disconnect()

Parameter

Tindakan ini tidak memiliki parameter.

Nilai kembali

Metode ini tidak mengembalikan apa pun.

NewMessage()

Membuat objek pesan baru dengan kode operasi tertentu. Setelah objek pesan dikembalikan, selesaikan isi pesan dengan menentukan target, memperbarui metode pengiriman, dan menambahkan muatan data sesuai kebutuhan. Setelah selesai, kirim pesan menggunakan SendMessage().

Sintaks

public RTMessage NewMessage(int opCode)

Parameter

opCode

Kode operasi yang didefinisikan developer yang mengidentifikasi kejadian atau tindakan game, seperti gerakan pemain atau notifikasi server.

Tipe: Bilangan Bulat

Wajib: Ya

Nilai kembali

Mengembalikan sebuah objek RTMessage yang berisi kode operasi tertentu dan metode pengiriman default. Secara default, parameter pengiriman yang diinginkan diatur ke FAST.

SendMessage()

Mengirim pesan ke pemain atau grup menggunakan metode pengiriman yang ditentukan.

Sintaks

public void SendMessage(RTMessage message)

Parameter

pesan

Objek pesan yang menentukan target penerima, metode pengiriman, dan isi pesan.

Tipe: RTMessage

Wajib: Ya

Nilai kembali

Metode ini tidak mengembalikan apa pun.

JoinGroup()

Menambahkan pemain ke keanggotaan grup tertentu. Grup dapat berisi salah satu pemain yang terhubung ke game. Setelah bergabung, pemain menerima semua pesan berikutnya yang dikirim ke grup dan dapat mengirim pesan ke seluruh grup.

Sintaks

public void JoinGroup(int targetGroup)

Parameter

targetGroup

ID unik yang mengidentifikasi grup sebagai cara menambahkan pemain ke dalamnya. ID grup didefinisikan developer.

Tipe: Bilangan Bulat

Wajib: Ya

Nilai kembali

Metode ini tidak mengembalikan apa pun. Karena permintaan ini dikirim menggunakan metode pengiriman yang andal (TCP), permintaan yang gagal akan memicu callback OnError().

LeaveGroup()

Menghapus pemain dari keanggotaan grup tertentu. Setelah tidak lagi berada dalam grup, pemain tidak menerima pesan yang dikirim ke grup dan tidak dapat mengirim pesan ke seluruh grup.

Sintaks

public void LeaveGroup(int targetGroup)

Parameter

targetGroup

ID unik mengidentifikasi grup untuk menghapus pemain dari dalamnya. ID grup didefinisikan developer.

Tipe: Bilangan Bulat

Wajib: Ya

Nilai kembali

Metode ini tidak mengembalikan apa pun. Karena permintaan ini dikirim menggunakan metode pengiriman yang andal (TCP), permintaan yang gagal akan memicu callback OnError().

RequestGroupMembership()

Meminta daftar pemain dalam grup tertentu dikirim ke client game. Setiap pemain dapat meminta informasi ini, terlepas dari apakah mereka adalah anggota grup atau tidak. Menanggapi permintaan ini, daftar keanggotaan dikirim ke client melalui callback OnGroupMembershipUpdated().

Sintaks

public void RequestGroupMembership(int targetGroup)

Parameter

targetGroup

ID unik yang mengidentifikasi grup untuk mendapatkan informasi keanggotaan. ID grup didefinisikan developer.

Tipe: Bilangan Bulat

Wajib: Ya

Nilai kembali

Metode ini tidak mengembalikan apa pun.