love (日本語)
I/Oボトルネックの原因となるため love.load() およびサブスレッド以外ではフォント、画像ファイルなど大容量ファイルの読み込み処理はなるべく避けてください。メモリーリークやフレームレート低下など動作遅延・障害の原因になる場合があります。必ずコールバックの用途を理解して適切に使用してください。 |
LÖVE でゲームを開発するとき、最も重要な API はコールバックです: love.load はゲームの一括設定、 love.update はゲームのフレームからフレームへの状態管理に、 そしてlove.draw はゲームの状態を画面に表示します。
インタラクティブなゲームでは、利用者からの入力処理を扱うために追加のコールバックへのオーバーライドを行うことで、完全に機能するゲームの様相にします。
LÖVE ではコールバックのプレースホルダー (雛形、中身が空の仮定義関数) を提供しています。これらは LÖVE のコールバックと同名関数の作成することにより自作コードでコールバックの処理内容をオーバーライド (上書き) できます (訳注: コールバックの詳しい処理内容に関しては LÖVE のソースコードパッケージに収録されている boot.lua をお読みください):
-- 長方形の標準値を読み込みます。
function love.load()
x, y, w, h = 20, 20, 60, 20
end
-- フレーム毎に長方形の寸法を大きくします。
function love.update(dt)
w = w + 1
h = h + 1
end
-- 色付きの長方形を描画します。
function love.draw()
love.graphics.setColor(0, 0.4, 0.4)
love.graphics.rectangle("fill", x, y, w, h)
end
Contents
モジュール
love.audio (日本語) | 音声の再生、または録音用のオーディオインタフェースです。 | ||
love.data (日本語) | データの作成と変換機能を提供します。 | 11.0 | |
love.event (日本語) | キーの押し下げなどのイベント (事象) を管理します。 | ||
love.filesystem (日本語) | 利用者のファイルシステムへのインターフェースを提供します。 | ||
love.font (日本語) | フォントを使用する作業ができるようにします。 | 0.7.0 | |
love.graphics (日本語) | 図形および画像の描画、画面配置の管理。 | ||
love.image (日本語) | 復号・符号化された画像データへのインタフェースを提供します。 | ||
love.joystick (日本語) | 接続されたジョイスティックに対してのインタフェースを提供します。 | 0.5.0 | |
love.keyboard (日本語) | 利用者のキーボードに関するインタフェースです。 | ||
love.math (日本語) | システムに依存しない数学関数を提供します。 | 0.9.0 | |
love.mouse (日本語) | 利用者のマウスへのインタフェースを提供します。 | ||
love.physics (日本語) | 物理法則に基づき、二次元空間で剛体力学のシミュレーションを行います。 | 0.4.0 | |
love.sound (日本語) | このモジュールは 音声ファイルの復号化を担います。 | ||
love.system (日本語) | 利用者のシステムに関する情報へのアクセス手段を提供します。 | 0.9.0 | |
love.thread (日本語) | スレッドを使用して処理を分担できるようにします。 | 0.7.0 | |
love.timer (日本語) | 高分解能による時間測定機能を提供します。 | ||
love.touch (日本語) | タッチスクリーンへのタッチに関するインタフェースを提供します。 | 0.10.0 | |
love.video (日本語) | このモジュールは復号化、制御、および動画ファイルのストリーミングを提供します。 | 0.10.0 | |
love.window (日本語) | プログラムのウィンドウに関するインターフェースを提供します。 | 0.9.0 |
サードパーティー製のモジュール
lua-enet (日本語) | 多人数同時対戦ゲーム用のネットワーク化モジュールです。 | 0.9.0 | |
socket (日本語) | HTTP, TCP, および UDP ネットワーキング用のモジュールです。 | 0.5.0 | |
utf8 (日本語) | このライブラリは UTF-8 文字コード形式による文字列を扱うための基本機能を提供します。 | 0.9.2 |
関数
love.getVersion (日本語) | 現在実行中の LÖVE のバーションを取得します。 | 0.9.1 | |
love.hasDeprecationOutput (日本語) | 廃止予定機能を用いた場合に LÖVE で警告表示をするかどうか取得します。 | 11.0 | |
love.isVersionCompatible (日本語) | 現在実行中の LÖVE バージョンとの指定されたバージョンに互換性があるかを取得します。 | 0.10.0 | |
love.setDeprecationOutput (日本語) | 廃止予定機能を用いた場合に LÖVE で警告表示をするかどうか設定します。 | 11.0 |
型
Data (日本語) | 全てのデータにおける上位クラスです。 | ||
Object (日本語) | 全ての LÖVE の型における上位クラスです。 | ||
Variant (日本語) | love.thread および love.event で対応している型。 |
コールバック
コールバックはすべてメインスレッドからのみ呼び出されます。
一般
Config Files (日本語) | ゲームのシステム構成を設定します。 | ||
love.draw (日本語) | フレームごとに画面へ描画するために使用されるコールバック関数です。 | ||
love.errhand (日本語) | エラーメッセージの表示に使用されるエラーハンドラです。 | 11.0 | |
love.errorhandler (日本語) | エラーメッセージの表示に使用されるエラーハンドラです。 | 11.0 | |
love.load (日本語) | ゲームの開始時にきっかりと一度だけ呼ばれます。 | ||
love.lowmemory (日本語) | 携帯機器でシステム実行中にメモリ不足になった時に発生するコールバック関数です。 | 0.10.0 | |
love.quit (日本語) | ゲームの終了時に呼び出されるコールバック関数です。 | 0.7.0 | |
love.run (日本語) | メインループを構成するメイン関数です。省略時は該当するデフォルト関数を使用します。 | ||
love.threaderror (日本語) | Thread でエラーが起きたときに起動するコールバック関数です。 | 0.9.0 | |
love.update (日本語) | ゲームにおいて、各フレームの状態更新時に用いるコールバック関数です。 |
ウィンドウ
love.directorydropped (日本語) | ディレクトリがウィンドウにドラッグ・アンド・ドロップされる時に発生するコールバック関数です。 | 0.10.0 | |
love.displayrotated (日本語) | ディスプレイの表示方向が変更されたときに発生するコールバック関数です。 | 11.3 | |
love.filedropped (日本語) | ファイルがウィンドウにドラッグ・アンド・ドロップされる時に発生するコールバック関数です。 | 0.10.0 | |
love.focus (日本語) | ウィンドウのフォーカスを得たときか失ったときに発生するコールバック関数です。 | 0.7.0 | |
love.mousefocus (日本語) | ウィンドウがマウスのフォーカスを受け取るか失ったときに発生するコールバック関数です。 | 0.9.0 | |
love.resize (日本語) | ウィンドウの大きさが変更されたときに呼び出されます。 | 0.9.0 | |
love.visible (日本語) | 利用者によりウィンドウが表示・非表示にされたときに発生するコールバック関数です。 | 0.9.0 |
キーボード
love.keypressed (日本語) | キーが押されたときに発生するコールバック関数です。 | ||
love.keyreleased (日本語) | キーが離されたときに発生するコールバック関数です。 | ||
love.textedited (日本語) | IME (Input Method Editor) で候補テキストが変更された時に呼ばれます。 | 0.10.0 | |
love.textinput (日本語) | 利用者によりテキストが入力されたときに呼ばれます。 | 0.9.0 |
マウス
love.mousemoved (日本語) | マウスが移動されたときに発生するコールバック関数です。 | 0.9.2 | |
love.mousepressed (日本語) | マウスのボタンが押されたときに発生するコールバック関数です。 | ||
love.mousereleased (日本語) | マウスのボタンが離されると発生するコールバック関数です。 | ||
love.wheelmoved (日本語) | マウスホィールが動かされると発生するコールバック関数です。 | 0.10.0 |
ジョイスティック
love.gamepadaxis (日本語) | ジョイスティックとして割り当てられている仮想ゲームパッドの軸が動かされたときに呼ばれます。 | 0.9.0 | |
love.gamepadpressed (日本語) | ジョイスティックとして割り当てられている仮想ゲームパッドのボタンが押されたときに呼ばれます。 | 0.9.0 | |
love.gamepadreleased (日本語) | ジョイスティックとして割り当てた仮想ゲームパッドのボタンが離されたときに呼ばれます。 | 0.9.0 | |
love.joystickadded (日本語) | Joystick が接続されたときに呼ばれます。 | 0.9.0 | |
love.joystickaxis (日本語) | ジョイスティックの軸が動かされたときに呼ばれます。 | 0.9.0 | |
love.joystickhat (日本語) | ジョイスティックのハットの方向が変化したときに呼ばれます。 | 0.9.0 | |
love.joystickpressed (日本語) | ジョイスティックのボタンが押されたときに呼ばれます。 | ||
love.joystickreleased (日本語) | ジョイスティックのボタンが離されたときに呼ばれます。 | ||
love.joystickremoved (日本語) | Joystick が切断されたときに呼ばれます。 | 0.9.0 |
タッチ
love.touchmoved (日本語) | タッチスクリーンの内側でタッチ打鍵を移動した時に発動するコールバック関数です。 | 0.10.0 | |
love.touchpressed (日本語) | タッチ画面でタッチされた時に発動するコールバック関数です。 | 0.10.0 | |
love.touchreleased (日本語) | タッチスクリーンからタッチが離れた時に発動するコールバック関数です。 | 0.10.0 |