LÖVE CÖNNECTION (日本語)
LÖVE CÖNNECTION は Nicholas Scott (ニコラス・スコット) により開発および保守されているネットワーキング・モジュールです。
require() でモジュールが読み込まれたときに関数一覧テーブルが返されるため、 require で設定されたものは Net～ と等価であると想定します。
Contents
関数
- Net:connectedUsers() -- 現在接続されている利用者の一覧を返します。
- Net:kickUser( id, reason ) -- 指定された id により利用者を追い出してから現在の画面に理由を表示します。
- Net:isServer() -- サーバーが現在実行中ならば true を返します。
- Net:isClient() -- クライアントが現在実行中ならば true を返します。
- Net:setMaxPing( ping ) -- クライアントに呼び出された場合は再びサーバーへ Ping を送信する前に Ping 時間の設定を行い、サーバー実行中に呼び出された場合はクライアントに対してタイムアウトになる前に最大 Ping (ミリ秒) 値を設定します。
- Net:init( state ) -- ネットワークを開始します。サーバとして、またはクライアントとしての実行、クライアントからの実行のいずれかのサーバ状態が必要です。
- Net:update( dt ) -- 全ての ACTIVE を love.update() へ追加して、love.update からデルタタイムを引き渡してください!! 重要!!!
- Net:connect( ip, port ) -- サーバから呼び出だされる場合は、 IP へ nil を、そして port へ接続待機を行うポート番号を設定する必要があります。デフォルトのポート番号は 20024 です。クライアントから呼び出だされる場合は IPアドレスおよびポートが必要です。そして、明らかなことですがポートはサーバと同じにする必要があります。 :D
- Net:disconnect() -- クライアントからソケットの出力がすべて nil となったかサーバーに切断パケットが送信された場合は、オンラインから切断します。
- Net:registerCMD( cmd, function ) -- ネットワークに対してコマンドを登録します。 cmd は登録したい文字列形式のコマンド名です。 function は指定されたコマンドを受信したときにクライアント(またはサーバ)で実行される関数です。詳細は後述します :D
- Net:send( table, cmd, param, id ) -- id はサーバ実行中にのみ指定します。 table は送信したいデータの格納されているテーブルです。 cmd はコマンドであり通信先で実行されますが、登録されている必要があります。 param はコマンドの引数です。 id は送信をしたいクライアントの ID です (クライアントの場合はサーバーを nil にする場合に限ります)。
- Net:encode( table ) -- ネットワークを経由して送信する文字列データを有するテーブルをエンコードします。
- Net:decode( string ) -- 受信時に文字列データのテーブルをデコードします。
イベント
これらは love.update () 関数を呼び出すのと同じ方法で呼び出されます。つまり、 Net.event.server.userConnected( id ) ～ end です。
クライアント・イベント
- Net.event.client.connect( ip, port) -- net:connect() によりクライアントからサーバへ接続されたときに呼び出されます。 IP はサーバの IP アドレス、および port はサーバのポートです。
- Net.event.client.receive( table, dt, cmd, param ) -- クライアントがパケットを受信したときに呼び出されます。 table はクライアントから送信されたテーブルです。 id はクライアントの ID です。 dt は net:update() のデルタタイムです。 cmd はクライアントから送信されたコマンドです。 param はクライアントの引数です。
- Net.event.client.disconnect() -- net:disconnect() によりサーバから切断されたときに呼び出されます。
- Net.event.client.cmdRegistered( cmd, functionS ) -- コマンド登録されたときに呼び出されます。 cmd は登録されたコマンドであり、 function は cmd により呼び出だされる関数です。
- Net.event.client.send( table, cmd, param ) -- サーバへパケットを送信するときに呼び出されます。 table は送信するテーブルです。 cmd はコマンドです。 param は引数です。
- Net.event.client.kickedFromServer( reason ) -- 利用者がサーバーから強制的に退場させられた時に呼び出されます(クライアント)。 reason は利用者が退場させられた理由です。
サーバー・イベント
- Net.event.server.userConnected( id ) -- 利用者がサーバーへ接続する時に呼び出されます。
- Net.event.server.userDisconnected( id ) -- 利用者がサーバーから切断された時に呼び出されます。
- Net.event.server.userTimedOut( id ) -- 利用者がサーバーからタイムアウトになった時に呼び出されます。
- Net.event.server.userKicked( id, reason ) -- 利用者が強制的に退場させられた時に呼び出されます。 reason は利用者が退場させられた理由です。
- Net.event.server.receive( table, dt, id, cmd, param ) -- パケットを受信したときに呼び出されます。 table はクライアントから送信されたテーブルです。 id はクライアントの ID です。 dt は net:update() のデルタタイムです。 cmd はクライアントから送信されたコマンドです。 param はクライアントの引数です。
- Net.event.server.connect( port ) -- ポートへ接続されたときに呼び出されます。 port は接続先のポートです。
- Net.event.server.disconnect() -- ポートからの切断およびパケットの受信待機停止状態になったときに呼び出されます。
- Net.event.server.cmdRegistered( cmd, functionS) -- コマンド登録されたときに呼び出されます。 cmd は登録されたコマンドであり、 function は cmd により呼び出だされる関数です。
- Net.event.server.send( table, cmd, param, id ) -- クライアントへパケットを送信するときに呼び出されます。 table は送信するテーブルです。 cmd は送信するコマンドです。 param は送信する引数です。 id はクライアントが送信する ID です。
変数・テーブル
- Net.client = table -- 現在接続されているサーバの IPアドレスとポートを保持しており、未接続の場合は IPアドレスとポートは nil となります。
- Net.server = table -- ポートが現在接続待機状態であるかを保持しており、接続待機状態でなければ nil となります。
- Net.commands = table -- コマンド = 関数の形式で現在登録されている全てのコマンドを保持しています。コマンド編集用の関数は近いうちに公開予定です!
- Net.users = table -- ID = PLAYERTABLE の形式で現在登録されている全ての遊戯者を保持しています。遊戯者テーブル編集用の関数は近いうちに公開予定です!
- Net.maxPing = integer -- サーバー、あるいはクライアントにおける現在の最大 Ping 値です。
- Net.connected = boolean -- サーバへ接続しているかポートが接続待機状態ならば true であり、それ以外は false です。
チュートリアル
サーバーの設定
その 1: モジュールを変数として定義します。
Net = require( "net" )
その 2: ネットワークを初期化します。
Net:init( "Server" )
その 3: パケットの受信待機をするためにポートへ接続します。
Net:connect( nil, 25045 )
その 4: 受信されたパケットに対してあるコマンドの登録を行います。 table は利用者によりエンコードされ、送信されたテーブルです。 :D このようにすると便利です
Net:registerCMD( "updateStatsOfPlayer", function( table, parameters, id, dt ) Net.users[id].name = table.name Net.users[id].color = table.color end )
その 5: クライアントへあるパケットを送信します！ :D これはサーバのコンソールから各クライアントへ "Hello There Mr. Client!" を表示します。
for id,playerdata in pairs( Net.users ) do
Net:send( {}, "print", "Hello There Mr. Client!", id )
end
クライアントの設定
その 1: モジュールを変数として定義します。
Net = require( "net" )
その 2: ネットワークを初期化します。
Net:init( "Client" )
その 3: サーバへの接続を行います。これは接続機能の初期化も行い net:send() を使用可能にします。
Net:connect( "127.0.0.1", 25045 )
その 4: 受信されたパケットに対してあるコマンドの登録を行います。 table は利用者によりエンコードされ、送信されたテーブルです。 :D このようにすると便利です
Net:registerCMD( "updateStatsOfBattlefield", function( table, parameters, id, dt )Tank.x = table.x Tank.y = table.y Tank.name = table.name end )
その 5: サーバへあるパケットを送信します！ :D これはサーバのコンソールへ "Hello There Mr. Server!" を表示します。 {} は空のテーブルですが、 NIL は必要なものであり除去してはいけません。
Net:send( {}, "print", "Hello There Mr. Server!" )
