Tutorial:Callback Functions (日本語)

LÖVE においてコールバック関数は全てオプションであり様々な作業を実行するために love.run から呼び出されます。とはいえ、恐らく完全な機能のあるゲーム体験ではほぼ全てを利用するため、それらがなにかを熟知するのは賢明です。

プログラミング未経験または用語に見覚えがない方々への説明として、コールバックとはある意味で逆方向に動作する受け身のような関数です。一方、 love.graphics.draw または Lua の math.floor といった攻めに相当する一般的な関数では、それを呼び出すと LÖVE または Lua が呼び出した関数の処理を行います。他方ではコールバックは開発者が処理内容を記述する関数であり、ある条件を満たすと LÖVE が自動的に呼び出します。これによりコードの組織化と最適化の維持を容易にします。例えば、 love.load はゲームが最初に開始された時に一度だけ呼び出されるため (他の全てのコールバックの前に)、ゲーム・コンテンツの読み込みおよびその他何らかの準備を行うコードを置くには適している場所です。

love.load

function love.load()
   image = love.graphics.newImage("cake.jpg")
   love.graphics.setNewFont(12)
   love.graphics.setColor(0,0,0)
   love.graphics.setBackgroundColor(255,255,255)
end

この関数はゲーム開始時に一度だけ呼び出されます。通常はリソースの読み込み、変数の初期化および特定の設定を行うために使用する場所です。それらはすべて love.load 以外でもできますが、ここで一度だけ行うことはシステム・リソースの大幅な節約になるという意味があります。

love.update

function love.update(dt)
   if love.keyboard.isDown("up") then
      num = num + 100 * dt -- これは num を 1 秒ごとに 100 加算します。
   end
end

この関数は継続的に呼び出されます。よって、恐らくほとんどのあなたの計算を済ませる場所になります。 'dt' は"デルタ・タイムの意味でありこの関数が以前に呼び出された時からの経過時間を秒数にて表しています （通常は 0.025714 のような小さな値です）。

love.draw

function love.draw()
   love.graphics.draw(image, imgx, imgy)
   love.graphics.print("Click and drag the cake around or use the arrow keys", 10, 10)
end

love.draw は全ての描画処理を集中的に行うための場所であり(まだ十分にそれが明白ではないならば)、この関数の外部で love.graphics.draw 族の関数を呼び出した場合は効果は一切ありません。この関数についても継続的に呼び出されるため、関数の終わりでフォント・配色・モード(方式)などを変更する場合に関数の始まりのものに影響することに留意してください。例えば:

function love.load()
   love.graphics.setColor(0,0,0)
end

function love.draw()
   love.graphics.print("This text is not black because of the line below", 100, 100)
   love.graphics.setColor(255,0,0)
   love.graphics.print("This text is red", 100, 200)
end

love.mousepressed

LÖVE 0.10.0 から使用可能

この異形は以前のバージョンでは非対応です。

function love.mousepressed(x, y, button, istouch)
   if button == 1 then
      imgx = x -- クリックされた場所へ画像を移動します。
      imgy = y
   end
end

この関数はマウスのボタンが押されてボタンおよび押された場所の座標を受信する場合は常に呼び出されます。 button は押された任意のボタンの索引でありえます。この関数は love.mousereleased との併用でも非常に上手く動作します。

love.mousereleased

LÖVE 0.10.0 から使用可能

この異形は以前のバージョンでは非対応です。

function love.mousereleased(x, y, button, istouch)
   if button == 1 then
      fireSlingshot(x,y) -- この全くもって素晴らしいカスタム関数は他の所へ定義されます。
   end
end

この関数はマウスのボタンが離されてボタンおよび離された場所の座標を受信する場合は常に呼び出されます。この関数は love.mousepressed と併用または独立して扱うこともできますが、それはいかなるの方法であっても接続されていません。

love.keypressed

function love.keypressed(key)
   if key == 'b' then
      text = "The B key was pressed."
   elseif key == 'a' then
      a_down = true
   end
end

この関数はキーボードのキーが押されて押されたキーを受信する場合は常に呼び出されます。key は 定数 のいずれかです。この関数は love.keyreleased との併用で非常に上手く動作します。

love.keyreleased

function love.keyreleased(key)
   if key == 'b' then
      text = "The B key was released."
   elseif key == 'a' then
      a_down = false
   end
end

この関数はキーボードのキーが離されて離されたキーを受信する場合は常に呼び出されます。この関数は love.keypressed との併用または独立して扱うこともできますが、それはいかなるの方法であっても接続されません。

love.focus

function love.focus(f)
  if not f then
    print("LOST FOCUS")
  else
    print("GAINED FOCUS")
  end
end

この関数は利用者が LÖVE のウィンドウおよびその外をクリックしたときに呼び出されます。例えば、ウィンドウ表示のゲームで遊んでいるときに、利用者がインターネット・ブラウザーをクリックした場合に、それがゲームへ通知されゲームは自動的に一時停止することができます。

function love.focus(f) gameIsPaused = not f end

function love.update(dt)
	if gameIsPaused then return end

	-- ここへあなたの love.update のコードを記載してください。
end

love.quit

function love.quit()
  print("Thanks for playing! Come back soon!")
end

この関数はウィンドウの閉じるボタン(大抵は×)が利用者によりクリックされたときに呼び出されます。例えば、遊技者がゲームを終了したいと決めたとき、閉じるボタンをクリックできます。その後、閉じる前に、そのゲームの状態を保存することができます。

それらはコールバック関数およびそれらの基本的な使用方法です。

まとめ

• love.load は起動直後の初期化処理に使用します。
• love.update は座標やスコアなどゲームの内部処理や各種情報の更新するために使用します。
• love.draw はグラフィックス描画処理で使用します。 LOVE にはオブジェクトの描画順序を決める Z (奥行・重なり)軸関連の関数がないため Tutorial:Drawing Order (日本語) を使用します。
• love.mousepressed はマウスボタンが押されたときの処理を行います。
• love.mousereleased はマウスボタンが離されたされた処理を行います。

……

タイトル、ステージ、レベルといったゲーム全体のシーン、画面およびオブジェクトの挙動処理の切り替えにはゲームステート (State)を使用します。コールバック以外に、これらを理解することが LOVE のプログラミングセオリーや基本構造を理解する早道です。

ゲームステートの用例

GamesSates = { Opening = 0, Title = 1, Scoreboard = 2, Option = 3, Gameover = 4, Credit = 5,
			Stage 1 = 100, Stage2 = 200, Stage = 300, Stage4 = 400, Stage5 = 500, Stage6 = 600,
			Boss1 = ...
}


state = GamesSates.Opening

function love.draw()

	if state = GamesSates.Opening then
		drawOpening()
	elseif state = GamesSates.Title then
		drawTitle()
	....
	end

end

function love.keypressed(key)

	if state = GamesSates.Opening then
		keypressdOpening()
	elseif state = GamesSates.Title then
		keypressdTitle()
	....
	end
end

-- 
-- つまり、コールバックごとにゲームステートを定義します。
-- しかし、if～then～elseif～else～end では記述方法としては、あまり明瞭ではなく保守性はあまりよろしくありません。
-- より簡潔かつ明瞭で美しい方法に関して、dofile/require、 メタテーブル(setmetatable)やクラスを使用するのがセオリーです。
-- 慣れてきたら if 以外の方法を使用しましょう(ゲームステート管理用のライブラリを使うのも一手です)。

関連

• コールバック関数 (callback function)とは｜「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典

• ゲームステートに関して
  • Separate state files - LÖVE
  • FSMの実装方法とより良い使い方 – Lancarse Blog
  • lua-users wiki: Finite State Machine
  • Game States : love2d - Reddit
  • An Introduction to Game States in Love2D - Andres Alvarez
  • lua - Game state management (Game, Menu, Titlescreen, etc) - Game Development Stack Exchange

そのほかの言語

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info