SteamGameServer - stingray.SteamGameServer オブジェクト リファレンス - Stingray Lua API リファレンス
説明
Steam ゲームのサーバ ノードを表します。
サーバ ノードはサーバ ブラウザに表示されます。
サーバ ノードには専用サーバだけでなく、自身のゲームをサーバ ブラウザで公開することを希望している一般プレイヤーも含まれます。
作成されたゲーム サーバはマスター サーバに接続されていないため、サーバの状態を追跡し、サーバが稼働中であることをサーバ マネージャに通知できるようにする必要があります。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
app_id ( ) : integer サーバで実行されているゲームの Steam アプリケーション ID を返します。
|
| この関数はパラメータを受け入れません。 |
integer |
アプリケーション ID を返します。 |
| |
data ( self, key ) : stringサーバに対して設定されたデータから 1 つの文字列値を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | 値のキーを指定します。 |
string |
指定したキーの保存されている文字列キーです。 |
| |
members ( self ) : string[]ゲーム サーバ上のすべてのメンバーのピア ID を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string[] |
サーバ上のすべてのメンバーの ID をリストしたテーブルを返します。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
| |
name ( self, peer ) : stringサーバ上のピアの名前を返し、ピアが不明な場合は空の文字列を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer : | string | 名前を取得するピアの ID を指定します。 |
string |
ピアの名前を返します。 |
| |
remove_member ( self, player )サーバ リストからメンバーを除去します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
player : | string | 除去するピアの ID を指定します。 |
| この関数は値を返しません。 |
| |
run_callbacks ( self, callback_object )ゲーム サーバのイベントをチェックし、指定されたコールバック オブジェクトの関数を呼び出すことにより警告を発行します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
callback_object : | table | このフレームで発生したイベントの警告を発行するために関数を呼び出すオブジェクトを指定します。 |
| この関数は値を返しません。 |
コールバック オブジェクトに対しては次の呼び出しを行えます。
- server_member_added(peer): 新しいメンバーがサーバに参加すると呼び出されます。
| |
set_data ( self, key, value )サーバに対してキーと値のペアを 1 組設定します。このペアは、サーバ ブラウザで取得できます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
key : | string | データのキー名を指定します。 |
value : | string | 指定されたキーに対応する値を指定します。 |
| この関数は値を返しません。 |
| |
set_data ( self, value )サーバに関するデータを設定します。このデータは、サーバ ブラウザで取得できます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
value : | table | すべて文字列からなるキーと値のペアのテーブルを指定します。 |
| この関数は値を返しません。 |
| |
set_game_tags ( self, tags )プレイヤーがサーバ ブラウザでサーバを探すときに使用できる、サーバのゲーム タグを設定します。
|
| |
set_map ( self, map )サーバ上のマップの名前を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
map : | string | マップの名前を指定します。 |
| この関数は値を返しません。 |
| |
set_score ( self, peer, score )サーバ上の指定されたピアのスコアを設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
peer : | string | スコアを設定するピアを指定します。 |
score : | integer | 指定されたピアに対して設定するスコアを指定します。 |
| この関数は値を返しません。 |
スコアは各プレイヤーの名前とともに Steam サーバ ブラウザで表示される整数値です。
| |
set_server_name ( self, name )サーバ名を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
name : | string | サーバの名前を指定します。 |
| この関数は値を返しません。 |
| |
state ( self ) : integerマスター サーバとの接続の状態を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
接続状態定数グループに含まれるいずれかの値によって示される接続状態を返します。 |
接続状態定数
マスター ゲーム サーバとの接続状態を示す定数です。
 |
CONNECTED : integer サーバがマスター サーバに接続されていることを示します。
|
| |
CONNECTING : integerサーバがマスター サーバとの接続を試行中であることを示します。
|
| |
DISCONNECTED : integerサーバがマスター サーバとの接触を失っていることを示します。
|