Steamworks Belgeleri
ISteamGameCoordinator Arayüzü
Oyun Koordinatörü'nden mesaj almak ve göndermek için işlevler.

Bu çoğunlukla kullanımdan kaldırıldı ve sadece hâlâ bunu kullanan birkaç oyun için varlığını sürdürmektedir.

İşlevler


NOT: ISteamGameCoordinator genel bir erişici işlevi göstermez. ISteamClient::GetISteamGenericInterface ile erişmelisiniz.

IsMessageAvailable

bool IsMessageAvailable( uint32 *pcubMsgSize );
AdTürAçıklama
pcubMsgSizeuint32 *Mesaj boyutunu bayt olarak döndürür.

Oyun koordinatöründen gelen bir mesaj olup olmadığını kontrol eder.

Dönüşler: bool
true mesaj varsa; yoksa false.

RetrieveMessage

EGCResults RetrieveMessage( uint32 *punMsgType, void *pubDest, uint32 cubDest, uint32 *pcubMsgSize );
AdTürAçıklama
punMsgTypeuint32 *
pubDestvoid *
cubDestuint32
pcubMsgSizeuint32 *

Kuyruktaki ilk mesajı verilen arabelleğe yükler ve k_EGCResultOK dödürür ya da bekleyen mesaj yoksa k_EGCResultNoMessage döndürür. pcubMsgSize mesaj boyutuyla yüklüdür.

Verilen arabellek mesajın tamamını sığdıracak kadar geniş değilse k_EGCResultBufferTooSmall döndürülür ve mesaj kuyruğun ilk sırasında kalır.

Dönüşler: EGCResults

SendMessage

EGCResults SendMessage( uint32 unMsgType, const void *pubData, uint32 cubData );
AdTürAçıklama
unMsgTypeuint32
pubDataconst void *
cubDatauint32

Oyun koordinatörüne bir mesaj gönder.

Dönüşler: EGCResults

Geri Çağrılar

Bunlar, SteamAPI_RunCallbacks'e çağrı yaparak etkinleştirilebilecek geri çağrılardır. Bunların birçoğu, direkt ISteamGameCoordinator üye işlevlerine cevaben oluşacaktır.

GCMessageAvailable_t

geri çağrılar
geri çağrı bildirimi - Mesaj kuyruğunda yeni bir mesaj var

AdTürAçıklama
m_nMessageSizeuint32

GCMessageFailed_t

geri çağrı bildirimi - Bir mesaj oyun koordinatörüne ulaşamadı. Geçici olarak devre dışı olabilir

Bu geri çağrıya ait alan bulunmamaktadır.

Numaralandırmalar

Bunlar ISteamGameCoordinator ile kullanım için tanımlanmış numaralandırmalardır.

EGCResults

ISteamGameCoordinator API'dan alınabilecek muhtemel döndürme değerlerinin bir listesi.

AdDeğerAçıklama
k_EGCResultOK0İşte bu kadar.
k_EGCResultNoMessage1Kuyrukta mesaj yok.
k_EGCResultBufferTooSmall2Arabellek istenen mesaj için çok küçük.
k_EGCResultNotLoggedOn3İstemci Steam'e giriş yapmamış.
k_EGCResultInvalidMessage4SendMessage ile mesaj gönderilirken bir hata oluştu.

Sabitler

Bunlar ISteamGameCoordinator ile kullanım için tanımlanmış sabitlerdir.

AdTürDeğerAçıklama
STEAMGAMECOORDINATOR_INTERFACE_VERSIONconst char *"SteamGameCoordinator001"