love

audio

event

filesystem

graphics

image

joystick

keyboard

math

mouse

physics

sound

system

thread

timer

touch

video

window

love

Types

Callbacks

Functions

love.getVersion

現在実行中の LÖVE のバーションを取得します。

major, minor, revision, codename = love.getVersion()

majornumberLÖVE の上位バージョン番号。つまり version 0.9.1 では 0 です。
minornumberLÖVE の下位バージョン番号。つまり version 0.9.1 では 9 です。
revisionnumberLÖVE の修正バージョン番号。つまり version 0.9.1 では 1 です。
codenamestring現在のバージョンの開発コード名。つまり version 0.9.1 では "Baby Inspector" です。

love.conf

If a file called conf.lua is present in your game folder (or .love file), it is run before the LÖVE modules are loaded. You can use this file to overwrite the love.conf function, which is later called by the LÖVE 'boot' script. Using the love.conf function, you can set some configuration options, and change things like the default size of the window, which modules are loaded, and other stuff.

love.conf( t )

ttableThe love.conf function takes one argument: a table filled with all the default values which you can overwrite to your liking. If you want to change the default window size, for instance, do: function love.conf(t) t.window.width = 1024 t.window.height = 768 end If you don't need the physics module or joystick module, do the following. function love.conf(t) t.modules.joystick = false t.modules.physics = false end Setting unused modules to false is encouraged when you release your game. It reduces startup time slightly (especially if the joystick module is disabled) and reduces memory usage (slightly). Note that you can't disable love.filesystem; it's mandatory. The same goes for the love module itself. love.graphics needs love.window to be enabled.
t.identity (nil)stringThis flag determines the name of the save directory for your game. Note that you can only specify the name, not the location where it will be created: t.identity = "gabe_HL3" -- Correct t.identity = "c:/Users/gabe/HL3" -- Incorrect Alternatively love.filesystem.setIdentity can be used to set the save directory outside of the config file.
t.version ("0.10.2")stringt.version should be a string, representing the version of LÖVE for which your game was made. It should be formatted as "X.Y.Z" where X is the major release number, Y the minor, and Z the patch level. It allows LÖVE to display a warning if it isn't compatible. Its default is the version of LÖVE running.
t.console (false)booleanDetermines whether a console should be opened alongside the game window (Windows only) or not. Note: On OSX you can get console output by running LÖVE through the terminal.
t.accelerometerjoystick (true)booleanSets whether the device accelerometer on iOS and Android should be exposed as a 3-axis Joystick. Disabling the accelerometer when it's not used may reduce CPU usage.
t.externalstorage (false)booleanSets whether files are saved in external storage (true) or internal storage (false) on Android.
t.gammacorrect (false)booleanDetermines whether gamma-correct rendering is enabled, when the system supports it.
t.windowtableIt is possible to defer window creation until love.window.setMode is first called in your code. To do so, set t.window = nil in love.conf (or t.screen = nil in older versions.) If this is done, LÖVE may crash if any function from love.graphics is called before the first love.window.setMode in your code. The t.window table was named t.screen in versions prior to 0.9.0. The t.screen table doesn't exist in love.conf in 0.9.0, and the t.window table doesn't exist in love.conf in 0.8.0. This means love.conf will fail to execute (therefore it will fall back to default values) if care is not taken to use the correct table for the LÖVE version being used.
t.modulestableModule options.

love.directorydropped

ディレクトリがウィンドウにドラッグ・アンド・ドロップされる時に発生するコールバック関数です。

love.directorydropped( path )

pathstringディレクトリのパスは完全にプラットフォームに依存します。それは love.filesystem で読み取りアクセス権を得るために love.filesystem.mount の引数として使用することができます。

love.draw

フレームごとに画面へ描画するために使用されるコールバック関数です。

love.draw()

love.errhand

エラーメッセージの表示に使用されるエラーハンドラです。

love.errhand( msg )

msgstringThe error message.

love.filedropped

ファイルがウィンドウにドラッグ・アンド・ドロップされる時に発生するコールバック関数です。

love.filedropped( file )

fileFileドロップされたファイルを表す未開封の File オブジェクト。

love.focus

ウィンドウのフォーカスを得たときか失ったときに発生するコールバック関数です。

love.focus( focus )

focusbooleanウィンドウのフォーカスを得た場合は true であり、失った場合は false です。

love.gamepadaxis

ジョイスティックとして割り当てられている仮想ゲームパッドの軸が動かされたときに呼ばれます。

love.gamepadaxis( joystick, axis )

joystickJoystickThe joystick object.
axisGamepadAxisThe virtual gamepad axis.

love.gamepadpressed

ジョイスティックとして割り当てられている仮想ゲームパッドのボタンが押されたときに呼ばれます。

love.gamepadpressed( joystick, button )

joystickJoystickjoystick オブジェクト。
buttonGamepadButton仮想ゲームパッドのボタン。

love.gamepadreleased

ジョイスティックとして割り当てられている仮想ゲームパッドのボタンが離されたときに呼ばれます。

love.gamepadreleased( joystick, button )

joystickJoystickjoystick オブジェクト。
buttonGamepadButton仮想ゲームパッドのボタン。

love.joystickadded

Joystick が接続されたときに呼ばれます。

love.joystickadded( joystick )

joystickJoystick新たに接続された Joystick オブジェクト。

love.joystickaxis

ジョイスティックの軸が動かされたときに呼ばれます。

love.joystickaxis( joystick, axis, value )

joystickJoystickJoystick オブジェクト。
axisnumber軸の番号。
valuenumber軸の新しい値。

love.joystickhat

ジョイスティックのハットの方向が変化したときに呼ばれます。

love.joystickhat( joystick, hat, direction )

joystickJoystickJoystick オブジェクト。
hatnumberハットの番号。
directionJoystickHatハットの新しい方向。

love.joystickpressed

ジョイスティックのボタンが押されたときに呼ばれます。

love.joystickpressed( joystick, button )

joysticknumberThe joystick number.
buttonnumberThe button number.

love.joystickreleased

ジョイスティックのボタンが離されたときに呼ばれます。

love.joystickreleased( joystick, button )

joysticknumberThe joystick number.
buttonnumberThe button number.

love.joystickremoved

Joystick が切断されたときに呼ばれます。

love.joystickremoved( joystick )

joystickJoystickいま切断された Joystick オブジェクト。

love.keypressed

キーが押されたときに発生するコールバック関数です。

love.keypressed( key, scancode, isrepeat )

keyKeyConstant押されたキーの文字。
scancodeScancode押されたキーを表すスキャンコード。
isrepeatbooleanこのキー押し下げイベントを繰り返すかどうか。キーを繰り返す間の遅延間隔は利用者のシステム設定に依存します。

love.keyreleased

キーが離されたときに発生するコールバック関数です。

love.keyreleased( key, scancode )

keyKeyConstant離されたキーの文字。
scancodeScancode離されたキーを表すスキャンコード。

love.load

ゲームの開始時にきっかりと一度だけ呼ばれます。

love.load( arg )

argtableゲームへ与えるコマンドライン引数。

love.lowmemory

携帯機器でシステム実行中にメモリ不足になった時に発生するコールバック関数です。

多くのメモリを使用する場合は携帯機器用のオペレーティング・システムはゲームを強制終了してしまうことがあるため、イベントが発生する時に(リソースを参照する全ての変数を nil に設定してから、 collectgarbage() を呼び出します)、可能ならば重要ではない資源は全て削除すべきです。特に音声と映像は最も多くのメモリを使用する傾向があります。

love.lowmemory()

love.mousefocus

ウィンドウがマウスのフォーカスを受け取るか失ったときに発生するコールバック関数です。

love.mousefocus( focus )

focusbooleanWhether the window has mouse focus or not.

love.mousemoved

マウスが移動されたときに発生するコールバック関数です。

love.mousemoved( x, y, dx, dy, istouch )

xnumberマウスの x 座標。
ynumberマウスの y 座標。
dxnumber前回の時に love.mousemoved が呼ばれてからの x-軸の移動量。
dynumber前回の時に love.mousemoved が呼ばれてからの y-軸の移動量。
istouchbooleantrue の場合はマウスボタンの押下によりタッチ画面のタッチ打鍵を発生させます。

love.mousepressed

マウスのボタンが押されたときに発生するコールバック関数です。

love.mousepressed( x, y, button, isTouch )

xnumberピクセル単位による、マウスの x 座標。
ynumberピクセル単位による、マウスの y 座標。
buttonnumber押されたボタンの索引。 1 は第一マウスボタンであり、 2 は第二マウスボタンおよび 3 は中央のボタンです。追加的なボタンはマウスの機種に依存します。
isTouchbooleantrue の場合はマウスボタンの押し下げをタッチ画面のタッチ打鍵から発生させます。

love.mousereleased

マウスのボタンが離されたときに発生するコールバック関数です。

love.mousereleased( x, y, button, isTouch )

xnumberMouse x position, in pixels.
ynumberMouse y position, in pixels.
buttonnumberThe button index that was released. 1 is the primary mouse button, 2 is the secondary mouse button and 3 is the middle button. Further buttons are mouse dependent.
isTouchbooleanTrue if the mouse button press originated from a touchscreen touch-release.

love.quit

ゲームが閉じられようとしたときに発生するコールバック関数です。

r = love.quit()

rbooleantrue ならば終了処理を中止しますが、それ以外はゲームを閉じます。

love.resize

ウィンドウの大きさが変更されたときに呼ばれますが、例えば、利用者がウィンドウの大きさを変更した、または love.window.setMode が呼ばれたときに非対応の幅または高さである場合は最も近い適切な大きさを選択します。

love.resize( w, h )

wnumberピクセル単位での、新規の幅。
hnumberピクセル単位での、新規の高さ。

love.run

メイン・ループを包括するメイン関数。省略時は認識可能な物を標準使用します。

love.run()

love.textedited

IME (Input Method Editor) で候補テキストが変更された時に呼ばれます。

候補テキストは利用者が最終的に選択するであろう確定テキストではありません。それを行うには love.textinput を使用してください。

love.textedited( text, start, length )

textstringUTF-8 で符号化された Unicode 候補テキスト。
startnumber選択された候補テキストのカーソル始点。
lengthnumber選択された候補テキストの長さ。 0 である場合があります。

love.textinput

利用者によりテキストが入力されたときに呼ばれます。例えば、米国英語配列のキーボードで [Shift]+[2] が押されたときに、"@" のテキストが生成されます。

love.textinput( text )

textstringThe UTF-8 encoded unicode text.

love.threaderror

Thread でエラーに遭遇したときに発生するコールバック関数です。

love.threaderror( thread, errorstr )

threadThreadエラーが発生したスレッド。
errorstrstringエラーメッセージ。

love.touchmoved

タッチ画面の内側でタッチ打鍵を移動した時に発生するコールバック関数です。

love.touchmoved( id, x, y, dx, dy, pressure )

idlight userdataタッチ打鍵の識別子
xnumberピクセル単位で、ウィンドウの内側のタッチにおける x-軸の位置。
ynumberピクセル単位で、ウィンドウの内側のタッチにおける y-軸の位置。
dxnumberピクセル単位で、ウィンドウの内側のタッチにおける x-軸の移動。
dynumberピクセル単位で、ウィンドウの内側のタッチにおける y-軸の移動。
pressurenumberかかっている筆圧量。ほとんどのタッチ画面では筆圧検知には対応していません。非対応の場合の筆圧は 1 になります。

love.touchpressed

タッチ画面がタッチされた時に発生するコールバック関数です。

love.touchpressed( id, x, y, dx, dy, pressure )

idlight userdataタッチ打鍵の識別子
xnumberピクセル単位で、ウィンドウの内側のタッチ打鍵における x-軸の位置。
ynumberピクセル単位で、ウィンドウの内側のタッチ打鍵における y-軸の位置。
dxnumberピクセル単位で、ウィンドウの内側のタッチ打鍵における x-軸の移動。これは常に 0 にすべきです。
dynumberピクセル単位で、ウィンドウの内側のタッチ打鍵における y-軸の移動。これは常に 0 にすべきです。
pressurenumberかかっている筆圧量。ほとんどのタッチ画面では筆圧検知には対応していません。非対応の場合の筆圧は 1 になります。

love.touchreleased

タッチ画面からタッチが離れた時に発生するコールバック関数です。

love.touchreleased( id, x, y, dx, dy, pressure )

idlight userdataタッチ打鍵の識別子
xnumberピクセル単位で、ウィンドウの内側のタッチにおける x-軸の位置。
ynumberピクセル単位で、ウィンドウの内側のタッチにおける y-軸の位置。
dxnumberピクセル単位で、ウィンドウの内側のタッチにおける x-軸の移動。
dynumberピクセル単位で、ウィンドウの内側のタッチにおける y-軸の移動。
pressurenumberかかっている筆圧量。ほとんどのタッチ画面では筆圧検知には対応していません。非対応の場合の筆圧は 1 になります。

love.update

ゲームの各フレームの状態を更新する時に使用されるコールバック関数です。

love.update( dt )

dtnumber秒単位による最終更新からの時間。

love.visible

利用者によりウィンドウが最小化・最大化または最小化解除されたときに発生するコールバック関数です。

love.visible( visible )

visiblebooleantrue ならばウィンドウを表示、 false ならば非表示にします。

love.wheelmoved

マウスホィールが動かされる時に発生するコールバック関数です。

love.wheelmoved( x, y )

xnumberマウスホイールの横方向への移動量。正値は右側への移動を意味します。
ynumberマウスホイールの縦方向への移動量。正値は上側への移動を意味します。

Data

全てのデータにおける上位クラスです。

Functions

Supertypes

Subtypes

Data:getPointer

Data のポインタを取得します。LuaJIT の FFI といったライブラリと一緒に使用できます。

pointer = Data:getPointer()

pointerlight userdataData の生ポインタ。

Data:getSize

Data の大きさをバイトで取得します。

size = Data:getSize()

sizenumberバイトでの Data の大きさ。

Data:getString

完全な Data を文字列形式で取得します。

data = Data:getString()

datastring生の Data

Drawable

画面へ描画可能な全てのものに対しての上位型です。この抽象型は直接の作成できません。

Supertypes

Subtypes

Object

全ての LÖVE 型における上位クラスです。

Functions

Subtypes

Object:type

オブジェクトの種類を文字列形式で取得します。

type = Object:type()

typestring種類を文字列形式で返します。

Object:typeOf

オブジェクトが特定の種類かどうか確認します。指定された名称のオブジェクトが階層に属している種類ならば、この関数は true を返します。

b = Object:typeOf( name )

bbooleanTrue ならばオブジェクトは指定された種類であり、それ以外は false です。
namestring種類を確認をしたいオブジェクトの名称。

love.audio

Types

Functions

Enums

love.audio.getDistanceModel

減衰距離モデルを返します。

model = love.audio.getDistanceModel()

modelDistanceModel現在の距離モデル。デフォルト値は 'inverseclamped' です。

love.audio.getDopplerScale

速度に基づいたドップラー効果に対する現在の大域基準化係数を取得します。

scale = love.audio.getDopplerScale()

scalenumber現在のドップラー基準化係数。

love.audio.getSourceCount

現在同時再生中の Source の本数を取得します。

numSources = love.audio.getSourceCount()

numSourcesnumber現在同時再生中の Source の本数。

love.audio.getOrientation

リスナーの方向を返します。

fx, fy, fz, ux, uy, uz = love.audio.getOrientation()

fxnumberThe X component of the forward vector of the listener orientation.
fynumberThe Y component of the forward vector of the listener orientation.
fznumberThe Z component of the forward vector of the listener orientation.
uxnumberThe X component of the up vector of the listener orientation.
uynumberThe Y component of the up vector of the listener orientation.
uznumberThe Z component of the up vector of the listener orientation.

love.audio.getPosition

リスナーの座標を返します。注意として音声の座標は モノラル (つまり、非・ステレオ) 音源のみ動作します。

x, y, z = love.audio.getPosition()

xnumberリスナーの X 座標。
ynumberリスナーの Y 座標。
znumberリスナーの Z 座標。

love.audio.getVelocity

リスナーの速度を返します。

x, y, z = love.audio.getVelocity()

xnumberリスナーの速度 X
ynumberリスナーの速度 Y
znumberリスナーの速度 Z

love.audio.getVolume

主音量を取得します。

volume = love.audio.getVolume()

volumenumber現在の主音量

love.audio.newSource

ファイルパス, File, Decoder または SoundData から Source を新規作成します。

SoundData から作成された Source は 常に static になります。

source = love.audio.newSource( file, type )

sourceSource指定された音声は再生可能な新しい Source として返されます。
filestring / File音声ファイルのファイルパス。
type ("stream")SourceTypeストリーミングまたはスタティックソースの指定。

source = love.audio.newSource( soundData )

sourceSource指定された音声は再生可能な新しい Source として返されます。
soundDataSoundData / FileDataSource を作成するための FileData を指定します。

love.audio.pause

指定または全ての Source を一時停止します。

love.audio.pause()

This function will pause all currently active Sources.

love.audio.pause( source )

This function will only pause the specified Source.

sourceSource再生を一時停止する Source を指定します。

love.audio.play

指定された Source を再生します。

love.audio.play( source )

sourceSource再生する Source を指定します。

love.audio.resume

音声の再生を全て再開します。

love.audio.resume()

love.audio.resume( source )

sourceSource再生を再開する Source を指定します。

love.audio.rewind

再生中の音声を全てを巻き戻します。

love.audio.rewind()

love.audio.rewind( source )

sourceSource巻き戻す Source を指定します。

love.audio.setDistanceModel

減衰距離モデルを設定します。

love.audio.setDistanceModel( model )

modelDistanceModel新しい距離モデル。

love.audio.setDopplerScale

速度に基づいたドップラー効果に対する大域基準化係数を設定します。標準基準値は 1 です。

love.audio.setDopplerScale( scale )

scalenumber新規のドップラー基準化係数。基準は 0 以上にする必要があります。

love.audio.setOrientation

リスナーの方向を設定します。

love.audio.setOrientation( fx, fy, fz, ux, uy, uz )

fxnumberThe X component of the forward vector of the listener orientation.
fynumberThe Y component of the forward vector of the listener orientation.
fznumberThe Z component of the forward vector of the listener orientation.
uxnumberThe X component of the up vector of the listener orientation.
uynumberThe Y component of the up vector of the listener orientation.
uznumberThe Z component of the up vector of the listener orientation.

love.audio.setPosition

どの様に音声を再生するか決定するために、リスナーの座標を設定します。

love.audio.setPosition( x, y, z )

xnumberリスナーの x 座標。
ynumberリスナーの y 座標。
znumberリスナーの z 座標。

love.audio.setVelocity

リスナーの速度を設定します。

love.audio.setVelocity( x, y, z )

xnumberリスナーの速度 X
ynumberリスナーの速度 Y
znumberリスナーの速度 Z

love.audio.setVolume

主音量を設定します。

love.audio.setVolume( volume )

volumenumber1.0 は最大であり 0.0 は消音です。

love.audio.stop

現在再生中の Source を停止します。

love.audio.stop()

This function will stop all currently active sources.

love.audio.stop( source )

This function will only stop the specified source.

sourceSource再生を停止する Source を指定します。

DistanceModel

none

Source の減衰を行いません。

inverse

逆の減衰距離。

inverseclamped

逆の減衰距離。利得は一定範囲内に抑えられます。これは version 0.9.2 およびそれ以前では '''inverse clamped''' と命名されていました。

linear

線形減衰。

linearclamped

線形減衰。利得は一定範囲内に抑えられます。これは version 0.9.2 およびそれ以前では '''linear clamped''' と命名されていました。

exponent

指数減衰。

exponentclamped

指数減衰。利得は一定範囲内に抑えられます。これは version 0.9.2 およびそれ以前では '''exponent clamped''' と命名されていました。

SourceType

static

音声を一括で完全復号化します。

stream

音声を連続で段階復号化します。

TimeUnit

seconds

通常の秒数。

samples

オーディオ・サンプル。

Source

Source は音声の再生を提供します。

Source は音量、音程、及びリスナーの相対的座標の設定といったような面白いことができます。 注意として音声の座標は モノラル (つまり、非・ステレオ) 音源のみ動作します。

Source の制御 (再生/一時停止/その他) は下記の状態一覧表にある動作と合致します。

Constructors

Functions

Supertypes

Source:clone

Source と同一の複製を停止状態に設定して作成します。

Static な Source を love.audio.newSource ではなく Source:clone を使用した場合は著しくメモリ使用量は少なくなり非常に少ない時間で作成できるため、同じ音を再生する複数の Source を作成するならば、この方法は好ましいです。

source = Source:clone()

sourceSourceこの Source の新規同一複製物。

Source:getAttenuationDistances

Source の基準及び最大減衰距離を取得します。値は、現在の DistanceModel との組み合わせにより、リスナーからの距離を基準とした Source 音量の減衰方法に影響します。

ref, max = Source:getAttenuationDistances()

refnumber現在の基準減衰距離。現在の DistanceModel が clamped ならば、これは Source の減衰が無くなる前に最小の距離になります。
maxnumber現在の最大減衰距離。

Source:getChannels

Source のチャンネル数を取得します。1-チャンネル (モノラル) Source のみ方向および座標エフェクトを使用できます。

channels = Source:getChannels()

channelsnumber1 はモノラル、 2 はステレオ です。

Source:getCone

Source の方向にある音量錐を取得します。 Source:setDirection と一緒に、錐角は Source の音量の方向により変化できるようにします。

innerAngle, outerAngle, outerVolume = Source:getCone()

innerAnglenumberラジアン単位での Source の方向からの内角。この角度により定義された錐の内側にリスナーが存在する場合は Source は通常音量で再生されます。
outerAnglenumberラジアン単位での Source の方向からの外角。内角および外角により定義された錐の間にリスナーが存在する場合は Source は通常及び外部音量の間で再生されます。
outerVolumenumberリスナーが内角及び外角の錐の両方から外れて外側に存在する場合の Source の音量になります。

Source:getDirection

Source の方向を取得します。

x, y, z = Source:getDirection()

xnumberX 側の方向ベクトル。
ynumberY 側の方向ベクトル。
znumberZ 側の方向ベクトル。

Source:getDuration

Source の継続時間を取得します。 ストリーミング型の Source において常にサンプルは不正確であるため、持続時間を全く測定できない場合は -1 を返します。

duration = Source:getDuration( unit )

durationnumberSource の継続時間、または -1 ならば測定不能です。
unit ("seconds")TimeUnit返値における単位の種類を指定します。

Source:getPitch

Source における現在の音程を取得します。

pitch = Source:getPitch()

pitchnumber音程を返します。なお、 1.0 で通常の音程になります。

Source:getPosition

Source の座標を取得します。

x, y, z = Source:getPosition()

xnumberSource の X 座標。
ynumberSource の Y 座標。
znumberSource の Z 座標。

Source:getRolloff

Source のロールオフ係数を返します。

rolloff = Source:getRolloff()

rolloffnumberロールオフ係数。

Source:getType

Source (static または stream) の種類を取得します。

sourcetype = Source:getType()

sourcetypeSourceTypeSource の種類。

Source:getVelocity

Source の速度を取得します。

x, y, z = Source:getVelocity()

xnumberX 側の速度ベクトル。
ynumberY 側の速度ベクトル。
znumberZ 側の速度ベクトル。

Source:getVolume

Source の現在の音量を取得します。

volume = Source:getVolume()

volumenumberSource の音量を返します。1.0 は標準音量です。

Source:getVolumeLimits

Source の音量制限を取得します。

min, max = Source:getVolumeLimits()

minnumber最小音量。
maxnumber最大音量。

Source:isLooping

Source がループ再生されているかどうか返します。

loop = Source:isLooping()

loopbooleanTrue if the Source will loop, false otherwise.

Source:isPaused

Source が一時停止中かどうか返します。

paused = Source:isPaused()

pausedbooleanTrue ならば Source は一時停止中であり、それ以外ならば False です。

Source:isPlaying

Source が再生中かどうか返します。

playing = Source:isPlaying()

playingbooleanTrue ならば Source は再生中であり、それ以外ならば False です。

Source:isStopped

Source が停止中かどうか返します。

stopped = Source:isStopped()

stoppedbooleanTrue ならば Source は停止中であり、それ以外ならば False です。

Source:pause

Source を一時停止します。

Source:pause()

Source:play

Source の再生を開始します。

success = Source:play()

successbooleanSource の再生を正常に開始できたかどうか。

Source:resume

一時停止を行った Source の再生を再開します。

Source:resume()

Source:rewind

Source を巻き戻します。

Source:rewind()

Source:seek

現在再生中の Source へ再生位置を設定します。

Source:seek( position, unit )

positionnumber再生位置を指定します。
unit ("seconds")TimeUnit位置における値の単位の種類を指定します。

Source:setDirection

Source の方向を設定します。ベクトル 0 は Source を無方向にします

Source:setDirection( x, y, z )

xnumberX 側の方向ベクトル。
ynumberY 側の方向ベクトル。
znumberZ 側の方向ベクトル。

Source:setAttenuationDistances

Source の基準及び最大減衰距離を設定します。引数は、現在の DistanceModel との組み合わせにより、距離を基準とした Source 音量の減衰方法に影響します。

減衰距離はモノラル(ステレオではない)の音声のみ適用できます。

Source:setAttenuationDistances( ref, max )

refnumber新規の基準減衰距離。現在の DistanceModel が clamped ならば、これは最小の減衰距離になります。
maxnumber新規の最大減衰距離。

Source:setCone

Source の方向にある音量錐を設定します。 Source:setDirection と一緒に、錐角は Source の音量の方向により変化できるようにします。

Source:setCone( innerAngle, outerAngle, outerVolume )

innerAnglenumberラジアン単位での Source の方向からの内角。この角度により定義された錐の内側にリスナーが存在する場合は Source は通常音量で再生されます。
outerAnglenumberラジアン単位での Source の方向からの外角。内角および外角により定義された錐の間にリスナーが存在する場合は Source は通常及び外部音量の間で再生されます。
outerVolume (0)numberリスナーが内角及び外角の錐の両方から外れて外側に存在する場合の Source の音量になります。

Source:setLooping

Source をループ再生するかどうか設定します。

Source:setLooping( loop )

loopbooleanTrue ならば Source をループ再生しますが、 false ならばループ再生を解除します。

Source:setPitch

Source における現在の音程を設定します。

Source:setPitch( pitch )

pitchnumber1 を基準音程として見なして計算をします。 50 パーセントずつ下げることは半音で -12 (1 オクターブ下げる)の音程をずらすことと等価です。 2 倍ずつ上げること半音で 12 (1 オクターブ上げる)の音程をずらすことと等価です。 0 は有効な値ではありません。

Source:setPosition

Source の座標を設定します。注意として、これは モノラル (つまり、非・ステレオ) の音声ファイルのみ動作します!

Source:setPosition( x, y, z )

xnumberSource の X 座標。
ynumberSource の Y 座標。
znumberSource の Z 座標。

Source:setRolloff

使用された減衰距離の強度に影響するロールオフ係数を設定します。

拡張情報および詳細な公式は OpenAL 1.1 仕様書の "3.4. 距離による減衰" の章にあります。

Source:setRolloff( rolloff )

rolloffnumber新規ロールオフ係数。

Source:setVelocity

Source の速度を設定します。

これは Source の座標を'''変更しません'''が、アプリケーションへドップラー効果の計算方法を知らせます。

Source:setVelocity( x, y, z )

xnumberX 側の速度ベクトル。
ynumberY 側の速度ベクトル。
znumberZ 側の速度ベクトル。

Source:setVolume

Source の現在の音量を設定します。

Source:setVolume( volume )

volumenumberSource の設定を指定します。1.0 は標準音量です。音量は 1.0 までであり、それ以上の値は指定できません。

Source:setVolumeLimits

音量制限を Source へ設定します。指定できる数値の範囲は 0.0 から 1.0 以内です。

Source:setVolumeLimits( min, max )

minnumber最小音量。
maxnumber最大音量。

Source:stop

Source の再生を停止します。

Source:stop()

Source:tell

現在再生中の Source の再生位置を取得します。

position = Source:tell( unit )

positionnumberThe currently playing position of the Source.
unit ("seconds")TimeUnitThe type of unit for the return value.

love.event

Functions

Enums

love.event.clear

イベントキューを消去します。

love.event.clear()

love.event.poll

イベントキューにあるメッセージに対してイテレーターを返します。

i = love.event.poll()

ifunctionfor ループで利用できるイテレーター関数。

love.event.pump

イベントキューへイベントを汲み出します。

これは低レベル関数であり、通常は利用者が呼ぶことはありませんが、 love.run からは呼ばれます。

なにかを OS が実行中であると考えられる場合、

および OS により生成されたイベント(コールバックを想定)を全て扱いたい場合に呼び出す必要があることに注意してください。

love.event.pump()

love.event.push

イベントキューへイベントを追加します。

0.10.0 以降では、デフォルトのコールバックにおいて、これまでは第六引数以降は未使用でしたが、この関数への引数として任意個数の引数を渡してもかまいません。

love.event.push( e, a, b, c, d )

eEventThe name of the event.
a (nil)VariantFirst event argument.
b (nil)VariantSecond event argument.
c (nil)VariantThird event argument.
d (nil)VariantFourth event argument.

love.event.quit

キューへ quit イベントを追加します。

quit イベントはイベントハンドラで LÖVE を終了するためのシグナルです。 love.quit コールバックにより終了処理を中止することもできます。

love.event.quit()

love.event.quit( exitstatus )

exitstatus (0)numberアプリケーション終了時に使用するためのプログラム終了状態。

love.event.quit( "restart" )

"restart"stringゲームの終了および実行可能ファイルを再実行せずに再起動を行うために標準の love.run を示します。これはメインの Lua における状態インスタンスを綺麗に停止してから新品のインスタンスを作成します。

love.event.wait

love.event.poll() と似ていますが、イベントキューにイベントがあるまで阻止します。

e, a, b, c, d = love.event.wait()

eEventイベントの種類。
aVariantイベントの第一引数。
bVariantイベントの第二引数。
cVariantイベントの第三引数。
dVariantイベントの第四引数。

Event

focus

ウィンドウ・フォーカスを得たか失った。

joystickaxis

ジョイスティックの軸が動いた。

joystickhat

ジョイスティックのハットが押された。

joystickpressed

ジョイスティックが押された。

joystickreleased

ジョイスティックが離された。

keypressed

キーが押された。

keyreleased

キーが離された。

mousefocus

ウィンドウがマウス・フォーカスを得たか失った。

mousepressed

マウスが押された。

mousereleased

マウスが離された。

resize

利用者によりウィンドウの大きさが変更された。

threaderror

スレッドで Lua のエラーが発生した。

quit

終了。

visible

利用者によりウィンドウが最小化または非最小化された。

love.filesystem

Types

Functions

Enums

love.filesystem.append

既存ファイルへデータを追記します。

success, errormsg = love.filesystem.append( name, data, size )

successbooleantrue ならば操作は成功しており、あるいは nil ならばエラーが発生しています。
errormsgstring失敗時のエラーメッセージ。
namestringファイルの名称(およびパス)。
datastringファイルへ追記する文字列データ。
size (all)number書き込む量をバイト数で指定します。

love.filesystem.areSymlinksEnabled

love.filesystem がシンボリック・リンクを辿るかどうかを取得します。

enable = love.filesystem.areSymlinksEnabled()

enablebooleanlove.filesystem がシンボリック・リンクを辿るかどうか。

love.filesystem.createDirectory

再帰的にディレクトリを作成します。

未だ存在しないときに、 "a/b" が呼ばれると "a" と "a/b" の両方が作成されます。

success = love.filesystem.createDirectory( name )

successbooleantrue ならばディレクトリは作成され、それ以外は false です。
namestring作成するディレクトリ。

love.filesystem.exists

ファイルまたはディレクトリが存在するか確認します。

exists = love.filesystem.exists( filename )

existsbooleantrue ならば指定されたファイルまたはディレクトリは存在しています。それ以外は false です。
filenamestringファイルまたはディレクトリが存在する可能性のあるパス。

love.filesystem.getAppdataDirectory

アプリケーションのデータディレクトリを返します (getUserDirectory と同じ場合があります)

path = love.filesystem.getAppdataDirectory()

pathstringアプリケーションのデータディレクトリのパス。

love.filesystem.getDirectoryItems

指定されたパスのファイルおよびサブディレクトリの名前をテーブルで返します。テーブルに対しては一切の並べ換えを行いません。順列はバラバラです。

パスとしてゲームおよびセーブ・ディレクトリとして存在するものが関数に渡された場合は、双方のファイルおよびディレクトリの場所の一覧を返します。

items = love.filesystem.getDirectoryItems( dir )

itemstablesequence は全てのファイルおよびサブディレクトリの名前を文字列として返したものです。
dirstringディレクトリ。

love.filesystem.getIdentity

ゲームの書き込み先のディレクトリ名を取得します。

これはファイルの格納先の完全なパスではなく、フォルダ名のみ返されることに留意してください。

love.filesystem.getIdentity( name )

namestringThe identity that is used as write directory.

love.filesystem.getLastModified

ファイルの最終更新時刻を取得します。

modtime, errormsg = love.filesystem.getLastModified( filename )

modtimenumber秒表現による UNIX エポック からの最終更新時刻または nil ならば失敗です。
errormsgstring失敗時のエラーメッセージ。
filenamestringファイルのパスと名前。

love.filesystem.getRealDirectory

プラットフォームに依存するファイルパスがあるディレクトリの絶対パスを取得します。

これはセーブ・ディレクトリまたはゲームのソースコードである .love ファイル内部にファイルが存在するかどうかを判定するために使用することができます。

realdir = love.filesystem.getRealDirectory( filepath )

realdirstringプラットフォームに依存するファイルパスがあるディレクトリのフルパス。
filepathstringディレクトリを取得するファイルパス。

love.filesystem.getRequirePath

require が呼ばれた時に検索されるファイルシステムのパスを取得します。

この関数により返されたパス文字列はセミコロンで分割された規範型パスのシーケンスです。 ''require'' の引数として渡されたものは任意の疑問符 ("?") の代わり各々の規範型へ挿入されます (その後に ''require'' へ渡される引数のドット文字はディレクトリの分離記号により置換されます)

love.filesystem.mount でマウントした任意のパスと同様に、ゲームのソースおよびセーブ・ディレクトリは相対的パスです。

paths = love.filesystem.getRequirePath()

pathsstring''require'' 関数で確認を行う LOVE ファイルシステムのパス。

love.filesystem.getSaveDirectory

明示されたセーブ・ディレクトリのフルパスを取得します。

これはセーブ・ディレクトリの読み書きを標準 IO ライブラリ (またはその他) で

行いたい場合に有用です。

path = love.filesystem.getSaveDirectory()

pathstringセーブ・ディレクトリの絶対パスを返します。

love.filesystem.getSize

ファイルの大きさをバイトで取得します。

size, errormsg = love.filesystem.getSize( filename )

sizenumberファイルの大きさをバイトで返しますが、 nil ならば失敗です。
errormsgstring失敗時のエラーメッセージ。
filenamestringファイルのパスと名前。

love.filesystem.getSource

.love ファイルまたはディレクトリのフルパスを返します。 LÖVE 実行可能形式にヒューズ化されている場合は、実行可能ファイルのパスを返します。

path = love.filesystem.getSource()

pathstring.love ファイルまたはディレクトリに対するプラットフォーム依存のフルパス。

love.filesystem.getSourceBaseDirectory

.love ファイルのあるディレクトリのフルパスを返します。 Fused 型のゲームであり LOVE 実行可能形式の場合は、実行可能形式のあるディレクトリを返します。

love.filesystem.isFused が有効な場合は、この関数により返されたパスは love.filesystem.mount へ渡すことができるため、ゲーム本体のあるディレクトリ (例えば C:\Program Files\coolgame\) は love.filesystem により読み取り可能になります。

path = love.filesystem.getSourceBaseDirectory()

pathstringプラットフォームに依存する.love ファイルがあるディレクトリのフルパス。

love.filesystem.getUserDirectory

利用者のディレクトリのパスを返します。

path = love.filesystem.getUserDirectory()

pathstring利用者のディレクトリのパス。

love.filesystem.getWorkingDirectory

現在の作業ディレクトリを取得します。

path = love.filesystem.getWorkingDirectory()

pathstring現在の作業ディレクトリ。

love.filesystem.init

love.filesystem を初期化しますが、これはシステム内部で呼ばれるものであるため、明示的に使用しないでください。

love.filesystem.init( appname )

appnamestringThe name of the application binary, typically love.

love.filesystem.isDirectory

対象がディレクトリかどうか確認します。

isDir = love.filesystem.isDirectory( path )

isDirbooleantrue ならば指定された名前はディレクトリであり、それ以外は false です。
pathstringディレクトリの可能性のあるパス。

love.filesystem.isFile

対象がファイルかどうか確認します。

isFile = love.filesystem.isFile( path )

isFilebooleantrue ならば指定された名前はファイルであり、それ以外は false です。
pathstringファイルの可能性のあるパス。

love.filesystem.isFused

ゲームがヒューズ・モードであるかどうか取得します。

ゲームがヒューズ・モードであるならば、セーブ・ディレクトリは Appdata/LOVE/ ではなく Appdata ディレクトリへ直接的に配置されます。さらに、ゲームはセーブ・ディレクトリに C言語で記述された Lua の動的ライブラリを配置して読み込むこともできます。

.love ソースが実行可能形式として作成された場合はヒューズ・モードになり(ゲームの配布を参照)、あるいはゲーム開始時にコマンドライン引数として "--fused" が与えられた場合はゲームはヒューズ・モードになります。

fused = love.filesystem.isFused()

fusedbooleantrue ならばゲームは fused モードであり、それ以外は false です。

love.filesystem.isSymlink

ファイルパスが本当にシンボリック・リンクであるかどうかを取得します。

シンボリック・リンクが有効ではない場合は (love.filesystem.setSymlinksEnabled によって)、この関数は常に false を返します。

symlink = love.filesystem.isSymlink( path )

symlinkbooleantrue ならばパスはシンボリック・リンクであり、それ以外は false です。
pathstring確認を行うファイルまたはディレクトリ。

love.filesystem.lines

ファイルの最終行までイテレート(反復)します。

iterator = love.filesystem.lines( name )

iteratorfunctionファイルの最終行まで全てイテレートを行う関数を返します。
namestringファイルの名前 (およびパス)。

love.filesystem.load

lua ファイルを読み込みます (が実行はしません)。

chunk = love.filesystem.load( name, errormsg )

chunkfunctionThe loaded chunk.
namestringThe name (and path) of the file.
errormsg (nil)stringThe error message if file could not be opened.

love.filesystem.mount

読み取るために zip ファイルまたはフォルダをゲームのセーブ・ディレクトリへマウント(装着)します。

ゲームが fused モードで動作している場合でも love.filesystem.getSourceBaseDirectory (日本語) でのマウントは同じく可能です。

success = love.filesystem.mount( archive, mountpoint, appendToPath )

successbooleanTrue if the archive was successfully mounted, false otherwise.
archivestringThe folder or zip file in the game's save directory to mount.
mountpointstringThe new path the archive will be mounted to.
appendToPath (false)stringWhether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories.

love.filesystem.newFile

File オブジェクトを新規作成します。

アクセスを可能にする前に開いておく必要があります。

file, errorstr = love.filesystem.newFile( filename, mode )

fileFile新規 File オブジェクト、または nil ならばエラーが発生しています。
errorstrstringエラー発生時のエラー文字列。
filenamestringFile のファイル名。
mode ("c")FileModeどのモードでファイルを開くか指定します。

love.filesystem.newFileData

FileData オブジェクトを新規作成します。

data = love.filesystem.newFileData( contents, name, decoder )

dataFileData新規 FileData を返します。
contentsstringファイルの内容。
namestringファイル名。
decoder ("file")FileDecoder内容を復号化する時に使用する方法。

data, err = love.filesystem.newFileData( filepath )

Creates a new FileData from a file on the storage device.

dataFileData新規 FileData を返します。あるいは nil ならばエラーが発生しています。
errstringエラー発生したときは、エラー文字列。
filepathstringファイルのパス。

love.filesystem.read

ファイルの内容を読み込みます。

contents, size = love.filesystem.read( name, bytes )

contentsstringThe file contents.
sizenumberHow many bytes have been read.
namestringThe name (and path) of the file.
bytes (all)numberHow many bytes to read.

love.filesystem.remove

ファイルまたは空のディレクトリを削除します。

success = love.filesystem.remove( name )

successbooleantrue ならばファイル、ディレクトリは削除されており、それ以外は false です。
namestring削除したいファイルまたはディレクトリ。

love.filesystem.setIdentity

ゲームの書き込み先ディレクトリを設定します。ファイルの格納先の場所ではなく、フォルダ名のみ設定できることに留意してください。

love.filesystem.setIdentity( name, appendToPath )

namestringThe new identity that will be used as write directory.
appendToPath (false)booleanWhether the identity directory will be searched when reading a filepath before or after the game's source directory and any currently mounted archives.

love.filesystem.setRequirePath

require が呼ばれた時に検索されるファイルシステムのパスを設定します。

この関数により与えられたパス文字列はセミコロンで分割された規範型パスのシーケンスです。 ''require'' の引数として渡されたものは任意の疑問符 ("?") の代わり各々の規範型へ挿入されます (その後に ''require'' へ渡される引数のドット文字はディレクトリの分離記号により置換されます)

love.filesystem.mount でマウントした任意のパスと同様に、ゲームのソースおよびセーブ・ディレクトリは相対的パスです。

love.filesystem.setRequirePath( paths )

pathsstring''require'' 関数で確認を行う LOVE ファイルシステムのパス。

love.filesystem.setSource

ゲームのソースとして、どこにコードが存在するのかを設定します。この関数は一度だけ呼び出すことができますが、通常は LÖVE により自動的に設定完了します。 LÖVE の内部処理で使用されます。

love.filesystem.setSource( path )

pathstringゲームのソース・フォルダの絶対パス。

love.filesystem.setSymlinksEnabled

love.filesystem がシンボリック・リンクを辿るように設定します。 version 0.10.0 以降において標準では有効であり、 0.9.2 において標準では無効です。

love.filesystem.setSymlinksEnabled( enable )

enablebooleanlove.filesystem がシンボリック・リンクを辿るべきであるかどうか。

love.filesystem.unmount

以前に love.filesystem.mount で読み取るためにマウントした zip ファイルまたはフォルダをアンマウント(脱着)します。

success = love.filesystem.unmount( archive )

successbooleantrue ならばアーカイブのアンマウントは成功であり、それ以外は false です。
archivestring現在、ゲームのセーブ・ディレクトリへマウントしている zip ファイルまたはフォルダ。

love.filesystem.write

セーブディレクトリにあるファイルへデータを書き込みます。既にファイルが存在するときは、新しい内容へ完全に置き換えます。

success, message = love.filesystem.write( name, data, size )

successboolean操作が成功したかどうか。
messagestring操作が失敗した場合はエラーメッセージ。
namestringファイル(およびパス)の名前。
datastringファイルへ書き込む文字列データ。
size (all)number書き込む量をバイト数で指定します。

success, message = love.filesystem.write( name, data, size )

successboolean操作が成功したかどうか。
messagestring操作が失敗した場合はエラーメッセージ。
namestringファイル(およびパス)の名前。
dataDataファイルへ書き込む Data オブジェクト。
size (all)number書き込む量をバイト数で指定します。

BufferMode

none

バッファリングなし。書き込みおよび追記の操作を行った結果は直ちに反映されます。

line

行バッファリング。書き込みおよび追記の操作を行った結果は改行が出力されるかバッファの大きさが限界に達するまでバッファへ蓄積されます。

full

完全なバッファリング。書き込みおよび追記の操作を行った結果はバッファの大きさが限界に達するまで常にバッファへ蓄積されます。

FileDecoder

file

データは符号化されていない。

base64

データは base64で符号化されている。

FileMode

r

読み込むためにファイルを開きます。

w

書き込むためにファイルを開きます。

a

追記するためにファイルを開きます。

c

ファイルを開きません (ファイルを閉じるという意味です)。

File

Represents a file on the filesystem.

Constructors

Functions

Supertypes

File:close

ファイルを閉じます。

success = File:close()

successbooleanファイルを閉じることに成功したかどうか。

File:flush

バッファへ書き込まれて蓄積された全てのデータをディスクのファイルへ追い出します。

success, err = File:flush()

successbooleanバッファに蓄積された全てのデータはディスクにあるファイルへ追い出すことに成功したかどうか。
errstringファイルへの追い出しができなかったりエラーが発生した場合は、エラー文字列を返します。

File:getBuffer

ファイルのバッファモードを取得します。

mode, size = File:getBuffer()

modeBufferModeファイルで使用している現在のバッファモード。
sizenumberファイルで使用している最大バッファ容量をバイト単位で返します。

File:getFilename

File オブジェクトと共に作成されたファイル名を取得します。 File オブジェクトが love.filedropped コールバックを由来とする場合は、ファイル名は完全にプラットフォームに依存するファイルパスです。

filename = File:getFilename()

filenamestringFile のファイル名

File:getMode

どの FileMode でファイルが開かれているか取得します。

mode = File:getMode()

modeFileModeこのファイルはどのモードで開かれているかどうか。

File:getSize

ファイルの大きさを返します。

size = File:getSize()

sizenumberファイルの大きさ。

File:isEOF

ファイル終端 (EOF : End-Of-File) まで到達したかどうかを取得します。

eof = File:isEOF()

eofbooleanEOF まで到達したかどうか。

File:isOpen

ファイルが開かれているかどうか取得します。

open = File:isOpen()

openbooleantrue ならばファイルは現在開かれており、それ以外は false です。

File:lines

ファイルの最終行まで全てイテレート(反復)します。

iterator = File:lines()

iteratorfunctionイテレーター (for ループで使用できます)

File:open

書き込み、読み込みまたは追記するためにファイルを開きます。

success = File:open( mode )

successbooleanTrue on success, false otherwise.
modeFileModeThe mode to open the file in.

File:read

ファイルからバイト単位で読み込みます。

contents, size = File:read( bytes )

contentsstring指定されたバイトから読み込んだ内容。
sizenumber読み込んだ量をバイト数で返します。
bytes (all)number読み込む量をバイト数で指定します。

File:seek

ファイルの指定位置へ移動します。

success = File:seek( position )

successboolean操作が成功したかどうか。
positionnumber移動先の位置。

File:setBuffer

書き込みまたは追記のために開いたファイルへに対してバッファモードの設定を行います。バッファモードによっては、バッファリングが有効になったファイルはバッファの最大使用可能容量が限界に到達するまでディスクへデータを書き出しません。

File:flush はバッファ(緩衝記憶機構)に蓄積された全てのデータを強制的にディスクへ書き出します。

success, errorstr = File:setBuffer( mode, size )

successbooleanバッファモードの設定が成功したかどうか。
errorstrstringバッファモードの設定ができなかった。またはエラーが発生した場合はエラー文字列を返します。
modeBufferMode使用するバッファモード。
size (0)numberファイルで使用する最大バッファ容量をバイト単位で指定します。

File:tell

ファイルの位置を返します。

pos = File:tell()

posnumber現在の位置

File:write

ファイルへデータを書き込みます

success = File:write( data, size )

successbooleanWhether the operation was successful.
datastringThe data to write.
size (all)numberHow many bytes to write.

FileData

ファイルの内容を Data として提供します。

Constructors

Functions

Supertypes

FileData:getExtension

FileData の拡張子を取得します。

ext = FileData:getExtension()

extstringFileData から提供されたファイルの拡張子。

FileData:getFilename

FileData のファイル名を取得します。

name = FileData:getFilename()

namestringFileData から提供されたファイル名。

love.graphics

Types

Functions

Enums

love.graphics.arc

塗り潰しまたは中抜きの円弧を (x, y) 座標へ描画します。円弧は angle1 から angle2 へ 弧度(ラジアン)単位を用いて描画されます。 引数 segments (セグメント) は円弧を描画するために使用する線分の数を決定します。線分を多くすると、角が滑らかな曲線になります。

love.graphics.arc( drawmode, arctype, x, y, radius, angle1, angle2, segments )

drawmodeDrawMode円弧の描画方法。
arctype ("pie")ArcType描画で使用する円弧の種類。
xnumber中心からの x-軸座標。
ynumber中心からの y-軸座標。
radiusnumber円弧の半径。
angle1number円弧における始点の角度。
angle2number円弧における終点の角度。
segments (10)number円弧を描画するために使用する線分の数。

love.graphics.circle

円を描画します。

love.graphics.circle( mode, x, y, radius )

modeDrawMode円の描画方法。
xnumber中心からの x-軸座標。
ynumber中心からの y-軸座標。
radiusnumber円の半径。

love.graphics.circle( mode, x, y, radius, segments )

modeDrawMode円の描画方法。
xnumber中心からの x-軸座標。
ynumber中心からの y-軸座標。
radiusnumber円の半径。
segmentsnumber円を描画するために使用する線分の数。注釈: 引数 segments を省略した場合の変数値は LÖVE のバージョンにより異なります。

love.graphics.clear

LÖVE 背景色で、または 0.10.0 以降では指定された色で画面を消去します。

この関数は love.draw の前に標準の love.run 関数から自動的に呼ばれます。この関数の典型的な使用法については love.run の用例を参照してください。

注意点として消去の領域は切り抜き範囲において制限されます。

love.graphics.clear()

Clears the screen to the background color in 0.9.2 and earlier, or to transparent black (0, 0, 0, 0) in LÖVE 0.10.0 and newer.

love.graphics.clear( r, g, b, a )

Clears the screen or active Canvas to the specified color.

rnumber画面の消去に使用する赤チャンネルの色です。
gnumber画面の消去に使用する緑チャンネルの色です。
bnumber画面の消去に使用する青チャンネルの色です。
a (255)number画面の消去に使用する透過チャンネルの色です。

love.graphics.clear( color, ... )

Clears multiple active Canvases to different colors, if multiple Canvases are active at once via love.graphics.setCanvas.

colortable最初に有効な Canvas の消去に使用する色を {r, g, b, a} 形式で有するテーブル。
...table有効な各 Canvas に対する追加のテーブル。

love.graphics.discard

画面または有効な Canvas の内容を廃棄 (破壊) します。これは特定の用途で使用する性能最適化関数です。

有効な Canvas を変更するだけであり、 "replace" の BlendMode で画面全体を扱う描画を使用する場合は、 love.graphics.discard を呼び出すよりも love.graphics.clear を呼び出す、または何も行わないことはモバイル機器での性能改善になります。

この関数は一部のデスクトップシステムでは動作しません。

love.graphics.discard( discardcolor, discardstencil )

discardcolor (true)boolean有効な Canvas のテクスチャ (Canvas が有効ではない場合は画面の内容) を破棄するかどうか。
discardstencil (true)boolean画面 / 有効な Canvas にあるステンシル・バッファの内容を廃棄するかどうか。

love.graphics.discard( discardcolors, discardstencil )

discardcolorstableCanvas が複数同時に有効な時に、有効な各 Canvas のテクスチャを廃棄するかどうかを示すブール値を有する配列。
discardstencil (true)boolean画面 / 有効な Canvas にあるステンシル・バッファの内容を廃棄するかどうか。

love.graphics.draw

Drawable オブジェクト(Image, Canvas, SpriteBatch, ParticleSystem, Mesh, または Video) に回転、尺度変更(拡大・縮小)および剪断を選択して画面へ描画します。

オブジェクトはローカル座標系に関連づけられて描画されます。原点の標準位置は Image また Canvas の左上端です。尺度変更、剪断および回転の全ての引数はその点と関連するオブジェクトを変形します。さらに、原点の位置は画面座標系により指定できます。

中心の原点の支距により、その中心に対してオブジェクトを回転させることは可能です。必ず回転角度は弧度を与えてください。尺度変更係数へ負数を使用することで中心線から反転することもできます。

注意として支距は回転、尺度変更、または剪断の前に適用されます。尺度変更および剪断は回転の前に適用されます。

オブジェクトの右と左の端は剪断係数へ角を定義することによりずらすことができます。

love.graphics.draw( drawable, x, y, r, sx, sy, ox, oy, kx, ky )

drawableDrawable描画可能なオブジェクト。
x (0)numberオブジェクトを描画する座標 (x-軸)。
y (0)numberオブジェクトを描画する座標 (y-軸)。
r (0)number方向 (弧度)。
sx (1)number尺度変更係数 (x-軸)。
sy (sx)number尺度変更係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

love.graphics.draw( texture, quad, x, y, r, sx, sy, ox, oy, kx, ky )

textureTextureQuad へテクスチャとして取り込む Texture または Canvas です。
quadQuad画面へ描画する Quad です。
x (0)numberオブジェクトを描画する座標 (x-軸)。
y (0)numberオブジェクトを描画する座標 (y-軸)。
r (0)number方向 (弧度)。
sx (1)number尺度変更係数 (x-軸)。
sy (sx)number尺度変更係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

love.graphics.ellipse

楕円を描画します。

love.graphics.ellipse( mode, x, y, radiusx, radiusy, segments )

modeDrawMode楕円の描画方法。
xnumber中心からの x-軸座標。
ynumber中心からの y-軸座標。
radiusxnumberx-軸からの楕円の半径 (楕円の幅の半分)。
radiusynumbery-軸からの楕円の半径 (楕円の高さの半分)。
segments (based on size)number楕円を描画するために使用する線分の数。

love.graphics.getBackgroundColor

現在の背景色を取得します。

r, g, b, a = love.graphics.getBackgroundColor()

rnumber赤色の成分 (0-255)
gnumber緑色の成分 (0-255)
bnumber青色の成分 (0-255)
anumber透過の成分 (0-255)

love.graphics.getBlendMode

混合方式を取得します。

mode, alphamode = love.graphics.getBlendMode()

modeBlendMode現在の混合モード。
alphamodeBlendAlphaMode現在の透過混合方式 ― 描画されたオブジェクトの透過色がどのように混合するのかに対して影響を及ぼすか決定します。

love.graphics.getCanvas

現在の対象となっている Canvas を取得します。

canvas = love.graphics.getCanvas()

canvasCanvassetCanvas により設定されたキャンバス。 nil が返されたときは実画面へ描画されています。

love.graphics.getCanvasFormats

利用可能なキャンバスの形式、および各種形式に対応しているかどうかを取得します。

formats = love.graphics.getCanvasFormats()

formatstableキーとして CanvasFormat が入っているテーブル、およびブール値により対応形式を示します。全てのシステムで全形式に対応しているとは限りません。

love.graphics.getColor

現在の色を取得します。

r, g, b, a = love.graphics.getColor()

rnumber赤色の成分 (0-255)
gnumber緑色の成分 (0-255)
bnumber青色の成分 (0-255)
anumber透過の成分 (0-255)

love.graphics.getColorMask

描画時に使用される有効な色成分を取得します。通常は 4 種類全ての成分は love.graphics.setColorMask が使用されるまで有効です。

色マスクは描画されたオブジェクトの各色の成分が画面の色に影響するかどうか決定します。また色マスクは同様に love.graphics.clear および Canvas:clear にも影響します。

r, g, b, a = love.graphics.getColorMask()

rboolean表示時に赤色の成分を有効にするかどうか。
gboolean表示時に緑色の成分を有効にするかどうか。
bboolean表示時に青色の成分を有効にするかどうか。
aboolean表示時に透過の成分を有効にするかどうか。

love.graphics.getCompressedImageFormats

利用可能な圧縮された画像形式、および対応しているかどうかを取得します。

formats = love.graphics.getCompressedImageFormats()

formatstableキーとして CompressedImageFormat が入っているテーブル、およびブール値により対応形式を示します。全てのシステムが全形式に対応しているとは限りません。

love.graphics.getDefaultFilter

Image, Canvas, および Font で使用される標準の尺度変更フィルタを返します。

min, mag, anisotropy = love.graphics.getDefaultFilter()

minFilterMode画像の縮小に使うフィルタのモード。
magFilterMode画像の拡大に使うフィルタのモード。
anisotropynumberAnisotropic(異方性)フィルタの最大使用量。

love.graphics.getDimensions

ウィンドウの幅と高さをピクセル単位で取得します。

width, height = love.graphics.getDimensions()

widthnumberウィンドウの幅。
heightnumberウィンドウの高さ。

love.graphics.getFont

現在の Font オブジェクトを取得します。

font = love.graphics.getFont()

fontFont現在のフォント。標準のフォントは自動的に作成と設定が行われますが、なにも返されない場合は未設定です。

love.graphics.getHeight

ウィンドウの高さをピクセル単位で取得します。

height = love.graphics.getHeight()

heightnumberウィンドウの高さ。

love.graphics.getLineJoin

線の連結方式を取得します。

join = love.graphics.getLineJoin()

joinLineJoin使用されている LineJoin の方式を返します。

love.graphics.getLineStyle

線の描画方法を取得します。

style = love.graphics.getLineStyle()

styleLineStyle現在の線の描画方法。

love.graphics.getLineWidth

現在の線の幅を取得します。

width = love.graphics.getLineWidth()

widthnumber現在の線の幅。

love.graphics.getShader

現在のシェーダーを取得します。 nil が返された場合は何も設定されていません。

shader = love.graphics.getShader()

shaderShader現在有効なシェーダー、または nil ならば何も設定されていません。

love.graphics.getStats

レンダリング性能関連の統計情報を取得します。

stats = love.graphics.getStats()

statstableA table with the following fields:
stats.drawcallsnumberThe number of draw calls made so far during the current frame.
stats.canvasswitchesnumberThe number of times the active Canvas has been switched so far during the current frame.
stats.texturememorynumberThe estimated total size in bytes of video memory used by all loaded Images, Canvases, and Fonts.
stats.imagesnumberThe number of Image objects currently loaded.
stats.canvasesnumberThe number of Canvas objects currently loaded.
stats.fontsnumberThe number of Font objects currently loaded.
stats.shaderswitchesnumberThe number of times the active Shader has been changed so far during the current frame.

love.graphics.getStencilTest

現在のステンシルにおけるテスト構成を取得します。

ステンシルテストが有効な時、全ての形状は本関数の引数および形状に接触している各ピクセルのステンシル値との間による比較に基づきクリップ / ステンシル処理されてから描画されます。ピクセルのステンシル値は love.graphics.stencil による影響を受けます。

各々の Canvas はピクセルごとにステンシル値を独自に有しています。

enabled, inverted = love.graphics.getStencilTest()

enabledbooleanWhether stencil testing is enabled.
invertedbooleanWhether the stencil test is inverted or not.

love.graphics.getSupported

システムにおける補助グラフィックス機能の対応状況を取得します。

一部の旧式または低級システムでは必ずしも全てのグラフィックス機能に対応しているとは限りません。

features = love.graphics.getSupported()

featurestableテーブルには GraphicsFeature のキーが格納されており、boolean 値は各機能の対応状況を示しています。

love.graphics.getSystemLimits

love.graphics の機能に関するシステム依存の最大値を取得します。

limits = love.graphics.getSystemLimits()

limitstableGraphicsLimit のキー、および数値が入っているテーブル。

love.graphics.getPointSize

点の大きさを取得します。

size = love.graphics.getPointSize()

sizenumber現在の点の大きさ。

love.graphics.getRendererInfo

システムに搭載されているビデオカードおよびドライバに関する情報を取得します。

name, version, vendor, device = love.graphics.getRendererInfo()

namestringレンダラーの名称。たとえば、 "OpenGL" または "OpenGL ES" です。
versionstring外部ドライバのバージョン情報に依存するレンダラーのバージョンの一部の情報。つまり、 "2.1 INTEL-8.10.44" です。
vendorstringグラフィックス・カードの製造元の名称。 例えば、 "Intel Inc." です。
devicestringグラフィックス・カードの製品の名称。例えば、 "Intel HD Graphics 3000 OpenGL Engine" です。

love.graphics.getScissor

現在の切り抜き範囲を取得します。

x, y, width, height = love.graphics.getScissor()

xnumber左上地点を箱の x-座標として返します。
ynumber左上地点を箱の y-座標として返します。
widthnumber箱の幅。
heightnumber箱の高さ。

love.graphics.getWidth

ウィンドウの幅をピクセル単位で取得します。

width = love.graphics.getWidth()

widthnumberウィンドウの幅。

love.graphics.intersectScissor

既存の切り抜きにより指定されている長方形の交差により作成された長方形に切り抜きを設定します。切り抜きが有効はない場合の動作は、 love.graphics.setScissor と同じです。

切り抜きは指定した長方形の範囲で描画領域を制限します。これは love.graphics.clear を含む、全てのグラフィック関連の呼び出しに影響を及ぼします。

切り抜きの範囲はグラフィックの変換には影響を及ぼしません (translate, scale, ...)。

love.graphics.intersectScissor( x, y, width, height )

Limits the drawing area to a specified rectangle.

xnumber既存の切り抜いている長方形と交差する長方形の左上角の x 座標。
ynumber既存の切り抜いている長方形と交差する長方形の左上角の y 座標。
widthnumber既存の切り抜いている長方形と交差する長方形の幅。
heightnumber既存の切り抜いている長方形と交差する長方形の長さ。

love.graphics.intersectScissor()

Disables scissor.

love.graphics.isGammaCorrect

ガンマ補正表示の対応状況および有効かどうかを取得します。これは love.conf で t.gammacorrect = true を設定することで有効化できます。

すべてのデバイスがガンマ補正表示に対応しているわけではありません。非対応の場合は自動的に無効化を行い本関数では false を返します。この機能はデスクトップ・システムでは OpenGL 3 / DirectX 10 に対応したグラフィックスカード、および OpenGL ES 3 を利用できる iOS デバイスで対応しています。

gammacorrect = love.graphics.isGammaCorrect()

gammacorrectbooleantrue ならばガンマ補正表示に対応しており love.conf で有効になっていますが、それ以外は false です。

love.graphics.isWireframe

描画時にワイヤーフレーム・モードが使用されているか取得します。

wireframe = love.graphics.isWireframe()

wireframebooleanTrue if wireframe lines are used when drawing, false if it's not.

love.graphics.line

二点の間で線を描画します。

love.graphics.line( x1, y1, x2, y2, ... )

x1number最初の点の x-軸座標。
y1number最初の点の y-軸座標。
x2number次の点の x-軸座標。
y2number次の点の y-軸座標。
...number多数の線を描画するために続きの点の座標を渡すことができます。

love.graphics.line( points )

pointstable上述の通り、点の座標をテーブルしたもの。

love.graphics.newCanvas

画面外表示を行うために Canvas オブジェクトを新規作成します。

canvas = love.graphics.newCanvas( width, height, format, msaa )

canvasCanvas指定された幅と高さの新規 Canvas です。
width (window width)number出力先の Canvas の幅。
height (window height)number出力先の Canvas の高さ。
format ("normal")CanvasFormat出力先の Canvas で使用するテクスチャ形式。
msaa (0)number出力先の Canvas で描画時に使用するマルチサンプル・アンチエイリアシング (MSAA) のサンプル数。

love.graphics.newFont

TrueType フォントまたは BMFont ファイルから Font を新規作成します。この関数を同一引数で呼び出しても常に新しい Font オブジェクトが作成されるため、フォントのキャッシュは作成されません。

全ての異形においてファイル名の代わりに Data オブジェクトを受け入れることができます。

font = love.graphics.newFont( file, size )

fontFontA Font object which can be used to draw text on screen.
filestring / File / FileDataThe file/File/FileData of the TrueType font file.
size (12)numberThe size of the font in pixels.

font = love.graphics.newFont( file, imagefilename )

fontFontテキストを画面へ描画するときに使用する Font オブジェクト。
filestring / File / FileDataTrueType フォントファイルのファイルパス。
imagefilename (path inside BMFont file)string / File / FileDataフォントの大きさをピクセル単位で指定します。

font = love.graphics.newFont( size )

Create a new instance of the default font (Vera Sans) with a custom size.

fontFontテキストを画面へ描画するときに使用する Font オブジェクト。
sizenumberフォントの大きさをピクセル単位で指定します。

love.graphics.newMesh

Mesh の新規作成。

描画時は Mesh がテクスチャ付きの Image または Canvas ならば Mesh:setTexture を使用してください。

mesh = love.graphics.newMesh( vertexformat, vertices, mode, usage )

Creates a Mesh with custom vertex attributes and the specified vertex data.

meshMeshThe new Mesh.
vertexformat (none)tableA table in the form of {attribute, ...}. Each attribute is a table which specifies a custom vertex attribute used for each vertex.
vertexformat.attributetableA table containing the attribute's name, it's data type, and the number of components in the attribute, in the form of {name, datatype, components}.
vertexformat....tableAdditional vertex attribute format tables.
verticestableThe table filled with vertex information tables for each vertex, in the form of {vertex, ...} where each vertex is a table in the form of {attributecomponent, ...}.
vertices.attributecomponentnumberThe first component of the first vertex attribute in the vertex.
vertices....numberAdditional components of all vertex attributes in the vertex.
mode ("fan")MeshDrawModeHow the vertices are used when drawing. The default mode "fan" is sufficient for simple convex polygons.
usage ("dynamic")SpriteBatchUsageThe expected usage of the Mesh. The specified usage mode affects the Mesh's memory usage and performance.

mesh = love.graphics.newMesh( vertexformat, vertexcount, mode, usage )

Creates a Mesh with custom vertex attributes and the specified number of vertices.

meshMeshThe new Mesh.
vertexformat (none)tableA table in the form of {attribute, ...}. Each attribute is a table which specifies a custom vertex attribute used for each vertex.
vertexformat.attributetableA table containing the attribute's name, it's data type, and the number of components in the attribute, in the form of {name, datatype, components}.
vertexformat....tableAdditional vertex attribute format tables.
vertexcountnumberThe total number of vertices the Mesh will use.
mode ("fan")MeshDrawModeHow the vertices are used when drawing. The default mode "fan" is sufficient for simple convex polygons.
usage ("dynamic")SpriteBatchUsageThe expected usage of the Mesh. The specified usage mode affects the Mesh's memory usage and performance.

love.graphics.newImage

ファイルパス、 FileData, ImageData または CompressedImageData から新規 Imageの作成を行い、さらに画像に対して任意で mipmap を作成または指定します。

image = love.graphics.newImage( file, flags )

imageImageAn Image object which can be drawn on screen.
filepath / File / FileData / ImageData / CompressedImageDataThe file path/File/FileData/ImageData/CompressedImageData of the image.
flagstableA table containing the following fields:
flags.linear (false)booleanTrue if the image's pixels should be interpreted as being linear RGB rather than sRGB-encoded, if gamma-correct rendering is enabled. Has no effect otherwise.
flags.mipmaps (false)boolean or tableIf true, mipmaps for the image will be automatically generated (or taken from the images's file if possible, if the image originated from a CompressedImageData). If this value is a table, it should contain a list of other filenames of images of the same format that have progressively half-sized dimensions, all the way down to 1x1. Those images will be used as this Image's mipmap levels.

love.graphics.newImageFont

特別な形式の画像から読み込んで Font を新規作成します。

versions 0.9.0 以前で、 LÖVE はグリフ文字列において ISO 8859-1 エンコーディングを要求します。

font = love.graphics.newImageFont( file, glyphs, extraspacing )

fontFont画面へテキストを描画するために使用できる Font オブジェクト。
filepath / File / FileData画像ファイルのファイルパス。
glyphsstring画像ファイルのファイルパス。
extraspacing (0)numberFont で各グリフに適用される追加の間隔(整数または負数)。

love.graphics.newParticleSystem

ParticleSystem の新規作成。

system = love.graphics.newParticleSystem( texture, buffer )

systemParticleSystem新規の ParticleSystem です。
textureTexture使用するテクスチャ(Image または Canvas) です。
buffer (1000)number同時に使用するパーティクルの最大数。

love.graphics.newShader

ハードウェアにより加速化された頂点またはピクセル・エフェクトに対して Shader オブジェクトを新規作成します。Shader には頂点シェーダーのコード、ピクセル・シェーダーのコード、のいずれか、または両方が含まれています。

Shader は描画時にビデオカードにて実行される小型のプログラムです。頂点シェーダーは各頂点に対して一括で実行されます (例えば、 Image では頂点が4つあります。 - 角ごとに一つずつ。 Mesh では、さらに存在する場合があります)。ピクセル・シェーダーは描画されたオブジェクトが関係する画面上の各ピクセルに対して一括で実行します。全てのオブジェクトの頂点が頂点シェーダーにより処理された後にピクセル・シェーダーのコードは実行されます。

shader = love.graphics.newShader( code )

shaderShaderA Shader object for use in drawing operations.
codestring / File / FileDataThe pixel shader or vertex shader code, or a file with the code.

shader = love.graphics.newShader( pixelcode, vertexcode )

shaderShaderA Shader object for use in drawing operations.
pixelcodestring / File / FileDataThe pixel shader code, or a file with the code.
vertexcodestring / File / FileDataThe vertex shader code, or a file with the code.

love.graphics.newText

描画可能な Text (テキスト) オブジェクトを新規作成します。

text = love.graphics.newText( font, textstring )

textTextThe new drawable Text object.
fontFontThe font to use for the text.
textstring (nil)stringThe initial string of text that the new Text object will contain. May be nil.

love.graphics.newQuad

Quad の新規作成。

quad = love.graphics.newQuad( x, y, width, height, sw, sh )

quadQuad新規 Quad です。
xnumberImage における左上からの x-軸座標。
ynumberImage における左上からの y-軸座標。
widthnumberImage における Quad の幅。 (必ず 0 以上にしてください)
heightnumberImage における Quad の高さ。 (必ず 0 以上にしてください)
swnumberImage の幅であり、基準の幅です。 (必ず 0 以上にしてください)
shnumberImage の高さであり、基準の高さです。 (必ず 0 以上にしてください)

love.graphics.newScreenshot

画面撮影したものを作成して画像データとして返します。

screenshot = love.graphics.newScreenshot( copyAlpha )

screenshotImageData画面撮影の画像データ。
copyAlpha (false)booleanImageData へ画面の透過チャンネルを含めるかどうか。 false であれば、画面撮影の透過成分は完全に不透明になります。

love.graphics.newSpriteBatch

SpriteBatch オブジェクトの新規作成。

spriteBatch = love.graphics.newSpriteBatch( texture, maxsprites, usage )

spriteBatchSpriteBatch新規 SpriteBatch です。
textureTextureスプライトとして使用する Image または Canvas です。
maxsprites (1000)numberSpriteBatch が随時有することができるスプライトの最大数。
usage ("dynamic")SpriteBatchUsageSpriteBatch で予想される使用方法。指定された使用方法の方式は SpriteBatch におけるメモリの使用状況と性能に影響を与えます。

love.graphics.newVideo

描画可能な Video を新規作成します。現在のところ Ogg Theora 形式の動画ファイルのみ対応しています。

video = love.graphics.newVideo( file, loadaudio )

videoVideo新規 Video.
filestring / FileOgg Theora 形式の動画ファイルへのファイルパス。
loadaudio (nil)booleanVideo の音声へ音声 Source を読み込むべきかどうかを指定します。明示的に true または false に設定されないとき、 Video に音声がない場合であってもエラーは発生しません。

love.graphics.origin

現在の座標変換を初期状態へ戻します。

この関数は以前に呼ばれた love.graphics.rotate, love.graphics.scale, love.graphics.shear または love.graphics.translate の全てに対して破棄するために常時使用されます。これは現在の座標状態を標準へ復帰します。

love.graphics.origin()

love.graphics.points

一つ以上の点を描画します。

love.graphics.points( x, y, ... )

xnumberx-軸において最初の点の位置。
ynumbery-軸において最初の点の位置。
...number追加の点において x および y 座標。

love.graphics.points( points )

pointstableA table containing multiple point positions, in the form of {x, y, ...}.
points.xnumberThe position of the first point on the x-axis.
points.ynumberThe position of the first point on the y-axis.
points....numberThe x and y coordinates of additional points.

love.graphics.points( points )

pointstableA table containing multiple individually colored points, in the form of {point, ...}. Each table contains the position and color of a point in the form of {x, y, r, g, b, a}. The color components are optional.
points.pointtableA table containing the position and color of the first point, in the form of {x, y, r, g, b, a}. The color components are optional.
points....tableAdditional tables containing the position and color of more points, in the form of {x, y, r, g, b, a}. The color components are optional.

love.graphics.polygon

多角形を描画します。

mode 引数に続いて、この関数へ複数の数値引数または数値から成る単体のテーブル引数を解釈できます。いずれの場合も、引数は多角形の頂点の x と y 座標が交互に解釈されます。

love.graphics.polygon( mode, ... )

modeDrawMode多角形の描画方法。
...number多角形の頂点。

love.graphics.polygon( mode, vertices )

modeDrawMode多角形の描画方法。
verticestable多角形の頂点をテーブルで表記したもの。

love.graphics.pop

現在の座標変換を変換スタックから復帰します。

この関数は以前の待避操作から回復するために常時使用されます。それは現在の変換状態を最後に待避する前の状態へ復帰します。

love.graphics.pop()

love.graphics.present

画面への描画操作結果を表示します。

この関数は自分で love.run 関数を書く場合に使用します。これにより画面への描画結果を全て表示します。この関数の典型的な使用法については love.run の用例を参照してください。

love.graphics.present()

love.graphics.print

画面へテキストを描画します。 Font が設定されていない場合は、必要ならば(一括で)作成と設定をしてください。

LÖVE 0.7.1 において、変換および尺度変更の関数を使用してテキストを描画する場合は、この関数では最初に尺度変更が発生すると仮定します。このことをスクリプトで注意しない場合は、テキストは正しい位置に表示されないか、または恐らく画面に表示されません。

love.graphics.print および love.graphics.printf の両方ともに UTF-8 文字コードに対応しています。さらに特殊文字用の適切な Font が必要です。

love.graphics.print( text, x, y, r, sx, sy, ox, oy, kx, ky )

textstringテキスト文字列。
xnumberオブジェクトの描画位置 (x-軸)。
ynumberオブジェクトの描画位置 (y-軸)。
r (0)number方向 (弧度)。
sx (1)number尺度変更係数 (x-軸)。
sy (sx)number尺度変更係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

love.graphics.print( coloredtext, x, y, angle, sx, sy, ox, oy, kx, ky )

coloredtexttableA table containing colors and strings to add to the object, in the form of {color1, string1, color2, string2, ...}.
coloredtext.color1tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string1stringA string of text which has a color specified by the previous color.
coloredtext.color2tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string2stringA string of text which has a color specified by the previous color.
coloredtext....tables and stringsAdditional colors and strings.
xnumberThe position of the new text on the x-axis.
ynumberThe position of the new text on the y-axis.
angle (0)numberThe orientation of the object in radians.
sx (1)numberScale factor on the x-axis.
sy (sx)numberScale factor on the y-axis.
ox (0)numberOrigin offset on the x-axis.
oy (0)numberOrigin offset on the y-axis.
kx (0)numberShearing / skew factor on the x-axis.
ky (0)numberShearing / skew factor on the y-axis.

love.graphics.printf

語句の折り返しと整列を行い、整形したテキストを描画します。

追加の注記は love.graphics.print を参照してください。

version 0.9.2 以前において、折り返しの実装は空白による語句の分割および、指定された制限範囲内に上手く合わさるのを確実にするために後方へ配置します。しかしながら、この方法では、この時点で実行終了してしまうが故に、語句間への空白の追加は完了して不足するので、画面へ表示されたときには、一部の行は与えられた制限を超過してしまい文字溢れを起こしてしまいます。この症状は version 0.10.0 以降では修正済です。

love.graphics.printf( text, x, y, limit, align, r, sx, sy, ox, oy, kx, ky )

textstringテキスト文字列。
xnumberx-軸の座標での位置。
ynumbery-軸の座標での位置。
limitnumberこの水平ピクセルの後に行を折り返す長さ。
align ("left")AlignModeテキストの揃え方。
r (0)number方向 (弧度)。
sx (1)number尺度変更係数 (x-軸)。
sy (sx)number尺度変更係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

love.graphics.printf( coloredtext, x, y, wraplimit, align, angle, sx, sy, ox, oy, kx, ky )

coloredtexttableA table containing colors and strings to add to the object, in the form of {color1, string1, color2, string2, ...}.
coloredtext.color1tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string1stringA string of text which has a color specified by the previous color.
coloredtext.color2tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string2stringA string of text which has a color specified by the previous color.
coloredtext....tables and stringsAdditional colors and strings.
xnumberThe position of the new text on the x-axis.
ynumberThe position of the new text on the y-axis.
wraplimitnumberThe maximum width in pixels of the text before it gets automatically wrapped to a new line.
alignAlignModeThe alignment of the text.
angle (0)numberThe orientation of the object in radians.
sx (1)numberScale factor on the x-axis.
sy (sx)numberScale factor on the y-axis.
ox (0)numberOrigin offset on the x-axis.
oy (0)numberOrigin offset on the y-axis.
kx (0)numberShearing / skew factor on the x-axis.
ky (0)numberShearing / skew factor on the y-axis.

love.graphics.push

現在の座標変換を変換スタックへコピーおよび待避します。

この関数はその後に対応する復帰操作の準備をするために常に使用されます。これは変換スタックへ現在の座標状態を格納して保持したままにしておきます。変換による変更後は復帰操作を使用することにより元に戻すことができ、待避操作を呼び出す前の座標変換の状態へ復帰します。

love.graphics.push( stack )

stack ("transform")StackType待避を行うスタックの種類 (例えば単純な変換状態、または love.graphics の全状態)。

love.graphics.rectangle

長方形を描画します。

love.graphics.rectangle( mode, x, y, width, height, rx, ry, segments )

Draws a rectangle with rounded corners.

modeDrawMode長方形の描画方法。
xnumber左上角から見た x-軸の座標。
ynumber左上角から見た y-軸の座標。
widthnumber長方形の幅。
heightnumber長方形の高さ。
rx (0)numberx-軸によるそれぞれの丸角の半径。長方形の幅の半分より大きくできません。
ry (rx)numbery-軸によるそれぞれの丸角の半径。長方形の幅の半分より大きくできません。
segments (based on size)number丸角を描画するために使用される線分の数。数値未指定時はデフォルト値が選択されます。

love.graphics.reset

現在のグラフィック設定を初期状態に戻します。

この関数を呼ぶと現在の描画色は白色、現在の背景色は黒色に設定され、有効な Canvas または Shader は全て無効、および全ての切り抜きは削除されます。BlendMode は alpha へ設定され、 色成分マスク は全て有効になり、 ワイヤーフレーム・モード は無効および現在のグラフィックス変換は origin へ初期化します。点と線に関しては両方とも描画方法を <tt>smooth</tt> および大きさは <tt>1.0</tt> へ設定します。

love.graphics.reset()

love.graphics.rotate

二次元座標系を回転させます。

この関数を呼び出すと指定された弧度の量により原点の周囲にある座標系の回転を行うため以降の全描画操作に影響します。この変更は love.draw() の終端まで継続します。

love.graphics.rotate( angle )

anglenumber弧度による座標系の回転量。

love.graphics.scale

二次元座標系を尺度変更(拡大・縮小)します。

標準において LÖVE の座標系はディスプレイの水平および垂直方向のピクセルと一対一で対応しており、 X 軸は右方向へ拡大する一方で Y 軸は下方向へ拡大します。この関係を座標系の尺度変更では変更します。

sx および sy により尺度変更された後に、全座標に対しての処理として sx および sy の乗算が実行されます。描画操作における結果の全てにおいても対応して尺度変更される故に、例えば尺度変更が (2, 2) のときは大きな x および y 方向の両方に対して二倍にしたものを作成することを意味します。負数値による尺度変更は対応する方向へ座標系を反転するため、それらは反転または上下逆さま、または両方がどのように描画されるかを意味します。 0 による尺度変更は有用な操作ではありません。

尺度変更および平行移動は交換可能な操作ではないため、それ故に、様々な順序で呼び出すと結果が変更されます。

尺度変更は love.draw() の終端まで継続します。

love.graphics.scale( sx, sy )

sxnumberThe scaling in the direction of the x-axis.
sy (sx)numberThe scaling in the direction of the y-axis. If omitted, it defaults to same as parameter sx.

love.graphics.setBackgroundColor

背景色を設定します。

love.graphics.setBackgroundColor( r, g, b, a )

rnumber赤色の成分 (0-255)
gnumber緑色の成分 (0-255)
bnumber青色の成分 (0-255)
a (255)number透過の成分 (0-255)

love.graphics.setBackgroundColor( rgba )

rgbatable赤、緑、青および透過の number 値で構成された数字の索引テーブル。

love.graphics.setBlendMode

混合方式を設定します。

love.graphics.setBlendMode( mode, alphamode )

modeBlendMode使用する混合方式。
alphamode ("alphamultiply")BlendAlphaMode混合時に描画されたオブジェクトの透過をどう扱うか。

love.graphics.setCanvas

Canvas へ描画操作を取り込みます。

love.graphics.setCanvas( canvas )

Sets the render target to a specified Canvas. All drawing operations until the next love.graphics.setCanvas call will be redirected to the Canvas and not shown on the screen.

canvasCanvas新規対象。

love.graphics.setCanvas()

Resets the render target to the screen, i.e. re-enables drawing to the screen.

love.graphics.setCanvas( canvas1, canvas2, ... )

Sets the render target to multiple simultaneous Canvases. All drawing operations until the next love.graphics.setCanvas call will be redirected to the specified canvases and not shown on the screen.

canvas1CanvasThe first render target.
canvas2CanvasThe second render target.
...CanvasMore canvases.

love.graphics.setColor

描画に使用する色を設定します。

love.graphics.setColor( red, green, blue, alpha )

rednumber赤の量。
greennumber緑の量。
bluenumber青の量。
alphanumber透過の量。設定後に画像の描画であっても、透過値は全ての描画操作へ適用されます。

love.graphics.setColor( rgba )

rgbatable赤、緑、青および透過の number 値で構成された数字の索引テーブル。透過は選択制であり無指定時は標準で 255 を設定します。

love.graphics.setColorMask

色マスクの設定。画面への表示および消去時に特定の色の成分を有効または無効にします。例えば、'''赤'''を '''false''' へ設定したとき、それ以降は全てのピクセルにある赤の成分への変更は一切行われなくなります。

love.graphics.setColorMask( red, green, blue, alpha )

Enables color masking for the specified color components.

redboolean表示を行う赤の成分。
greenboolean表示を行う緑の成分。
blueboolean表示を行う青の成分。
alphaboolean表示を行う透過の成分。

love.graphics.setColorMask()

Disables color masking.

love.graphics.setDefaultFilter

Image, Canvas, および Font で使用される標準の尺度変更フィルタを設定します。

love.graphics.setDefaultFilter( min, mag, anisotropy )

minFilterMode画像の縮小に使うフィルタのモード。
mag (min)FilterMode画像の拡大に使うフィルタのモード。
anisotropy (1)numberAnisotropic (異方性) フィルタの最大使用量。

love.graphics.setFont

既に読み込んだ Font を現在のフォントに設定するかファイルと大きさを指定して読み込んでから新規作成します。

Font オブジェクトは読み込み段階で love.graphics.newFont にて作成してから描画段階で当関数へ渡すことを推奨します。

love.graphics.setFont( font )

fontFont使用する Font オブジェクト。

love.graphics.setLineJoin

線の連結方法を設定します。利用可能な連結方法は LineJoin を参照してください。

love.graphics.setLineJoin( join )

joinLineJoin使用する LineJoin を指定します。

love.graphics.setLineStyle

線の描画方法を設定します。

love.graphics.setLineStyle( style )

styleLineStyle使用する LineStyle を指定します。線の方式には smooth および rough があります。

love.graphics.setLineWidth

線の幅を設定します。

love.graphics.setLineWidth( width )

widthnumber線の幅。

love.graphics.setNewFont

Font の作成と設定を行います。

font = love.graphics.setNewFont( filename, size )

fontFontThe new font.
filenamestring / File / FileDataThe file path/File/FileData of the font.
size (12)numberThe size of the font.

love.graphics.setShader

現在のピクセルエフェクトまたは頂点シェーダーへ Shader を設定するか初期状態に戻します。全ての描画操作は次の ''love.graphics.setShader'' が呼ばれるまで指定された Shader オブジェクトを使用して描画されます。

love.graphics.setShader()

love.graphics.setShader( shader )

shaderShader新規シェーダー。

love.graphics.setPointSize

点の大きさを設定します。

love.graphics.setPointSize( size )

sizenumber新しい点の大きさ。

love.graphics.setScissor

切り抜きの設定または解除。

切り抜きは指定した長方形の範囲で描画領域を制限します。これは love.graphics.clear を含む、全てのグラフィック関連の呼び出しに影響を及ぼします。

切り抜きの範囲はグラフィックの変換には影響を及ぼしません (translate, scale, ...)。

love.graphics.setScissor( x, y, width, height )

Limits the drawing area to a specified rectangle.

xnumber左上端の x 座標。
ynumber左上端の y 座標。
widthnumber長方形として切り抜く幅。
heightnumber長方形として切り抜く高さ。

love.graphics.setScissor()

Disables scissor.

love.graphics.setStencilTest

ステンシルにおけるテストを構成または無効にします。

ステンシルテストが有効な時、全ての形状は本関数の引数および形状に接触している各ピクセルのステンシル値との間による比較に基づきクリップ / ステンシル処理されてから描画されます。ピクセルのステンシル値は love.graphics.stencil による影響を受けます。

各々の Canvas はピクセルごとにステンシル値を独自に有しています。

love.graphics.setStencilTest( comparemode, comparevalue )

comparemodeCompareMode各ピクセルの比較方法。
comparevaluenumber各ピクセルのステンシル値を比較する時に使用される値。範囲は 0 から 255 までの間にする必要があります。

love.graphics.setStencilTest()

Disables stencil testing.

love.graphics.setWireframe

描画時にワイヤーフレーム・モードを使用するために設定します。

love.graphics.setWireframe( enable )

enablebooleanTrue ならば描画時にワイヤーフレーム・モードを有効にしますが、 false ならば無効にします。

love.graphics.shear

座標系の剪断(せんだん)。

love.graphics.shear( kx, ky )

kxnumberx-軸の剪断係数。
kynumbery-軸の剪断係数。

love.graphics.stencil

ステンシルとして幾何学的形状を描きます。

幾何学的形状はピクセルの色を設定する代わりに、与えられた関数へ不可視のピクセル値を設定することにより描画されます。ピクセルのステンシル値は、マスク / ステンシルのように機能させることができます。 ― love.graphics.setStencilTest は、以降の描画で各ピクセルにおいてステンシル値により、どのような影響を受けるのを決定するために使用することができます。

各 Canvas は個別にピクセルごとのステンシル値を有しています。ステンシル値は 255 の範囲内です。

love.graphics.stencil( stencilfunction, action, value, keepvalues )

stencilfunctionfunction幾何学的形状を描画するための関数。ピクセルのステンシル値は、各ピクセルの色よりも幾何学的形状の影響を受けます。
action ("replace")StencilActionステンシル関数で描画されたものに接触しているピクセルに対して任意のステンシル値で変更する方法。
value (1)number "replace" によるステンシルの動作で使用される場合にピクセルに対して使用される新規ステンシル値。その他のステンシルに対する動作には影響はありません。値の範囲は 0 から 255 までにする必要があります。
keepvalues (false)booleantrue ならばピクセルの古いステンシル値を保存しますが、 false ならばステンシル値の実行前に、全てのピクセルにステンシル値を 0 にして初期状態へ戻します。同様に love.graphics.clear (日本語) は全てのステンシル値に対して初期状態へ戻します。

love.graphics.translate

二次元座標系を平行移動します。

この関数が dx と dy の二つの数値を付けて呼ばれたとき、 x と y の座標に対して x+dx と y+dy が実行されるため以降の全描画操作に対して効果が適用されます。

尺度変更および平行移動は交換可能な操作ではないため、それ故に、様々な順序で呼び出すと結果が変更されます。

この変更は love.draw() の終端まで継続あるいは以前の love.graphics.push に対する love.graphics.pop により復帰します。

平行移動を全体の数値に使用することで画像の破断・ブレを防止でき、平行移動後にフォントの描画が行なわれます。

love.graphics.translate( dx, dy )

dxnumberX 軸と関連する平行移動。
dynumberY 軸と関連する平行移動。

AlignMode

center

テキストの中央揃え。

left

テキストの左揃え。

right

テキストの右揃え。

justify

テキストの左右両端揃え。

ArcType

pie

円弧の領域が中心の終点に接続されている状態で、円弧が一切れのパイのように描画されます。

open

円弧において二つの終点は未接続のままで円弧は線分として描画されます。円弧が塗り潰される方式で描画されるときは "closed" 型の円弧のように動作します。

closed

円弧において二つの終点は互いに接続されます。

AreaSpreadDistribution

uniform

一様分布。

normal

正規 (ガウシアン) 分布。

ellipse

楕円形での一様分布。

none

分布無し - 領域展開を無効にします。

BlendAlphaMode

alphamultiply

描画された RGB 値が混合されている間は、それらの色が有する透過値を乗算します。これは標準の透過方式です。

premultiplied

描画された RGB 値が混合されている間は、それらの色が有する透過値を'''乗算しません'''。この透過方式はほとんどの混合方式で正確に動作しますが、描画されるオブジェクトの色は、ある時点で予(あらかじ)め透過値を RGB 値で乗算されたものを有する必要があります。 ("premultiplied alpha")

BlendMode

alpha

透過混合方式 (標準)。透過は描画される対象の不透明度を決定します。

replace

追加の混合処理を行わずに、画面上にあるものを描画される対象にある色で完全に置換します。 love.graphics.setBlendMode で指定された BlendAlphaMode は以後の対象に影響を与えます。

screen

'画面'混合方式。

add

描画される対象にあるピクセルの色は既に画面上に存在するピクセルの色により加算されます。画面の透過は変更されません。

subtract

描画される対象にあるピクセルの色は既に画面上に存在するピクセルの色により減算されます。画面の透過は変更されません。

multiply

描画される対象にあるピクセルの色は既に画面上に存在するピクセルの色により乗算されます (暗くなります)。描画されるオブジェクトの透過は "alphamultiply" 型の BlendAlphaMode が使用されている場合であっても、画面上の色がどれほど影響を受けるかで決定されるのではなく、画面の透過により乗算されます。

lighten

描画される対象にあるピクセルの色は既に画面上に存在するピクセルの色と比較を行い、各色要素にある二つの値よりも大きいものを使用します。 love.graphics.setBlendMode で "premultiplied" 型の BlendAlphaMode を使用した場合のみ動作します。

darken

描画される対象にあるピクセルの色は既に画面上に存在するピクセルの色と比較を行い、各色要素にある二つの値よりも小きいものを使用します。 love.graphics.setBlendMode で "premultiplied" 型の BlendAlphaMode を使用した場合のみ動作します。

CanvasFormat

normal

標準 Canvas 形式 ― 通常は rgba8 形式、または LÖVE ガンマ補正表示が有効ならば srgb の別名です。

hdr

高解像度の内容に適している形式です。 - 通常は、 rgba16f 形式に対する別名です。

rgba8

RGBA チャンネル (32 bpp) 当たり 8 bit です。色チャンネルの値は 0 から 255 (シェーダーは 0 から 1 まで) までの範囲です。

rgba4

RGBA チャンネル (16 bpp) 当たり 4 bit です。

rgb5a1

RGB チャンネル当たり 5 bit であり、 1 bit の透過チャンネルです (16bpp)。

rgb565

それぞれ、赤色 (R) は 5 bit、緑色 (G) は 6 bit、および青色 (B) は 5 bit から構成されている RGB です (16 bpp)。この形式には透過色 (A) チャンネルはありません。

rgb10a2

RGB チャンネル当たり 10 bit であり、 2 bit の透過チャンネルです (32bpp)。

rgba16f

チャンネルあたり 16 bit の浮動小数点を使用した RGBA です(64 bpp)。色の範囲値は +65504 まで選択することができます。

rgba32f

チャンネルあたり 32 bit の浮動小数点を使用した RGBA です(128 bpp)。

rg11b10f

浮動小数点を使用した RGB であり赤色および緑色チャンネルは 11 bit であり、青色チャンネルは 10 bit (32bpp) です。透過チャンネルはありません。色の値の範囲は +65024 までを選択することができます。

srgb

rgba8 と同じですが、 Canvas は sRGB 色空間として''解釈''されます。 Canvas へ描画されたものは全て線形 RGB から sRGB へ変換されます。 Canvas 描画(またはシェーダーにて使用される)時に、 sRGB から 線形 RGB へ復号化されます。これは sRGB による符号化において、さらに深い暗色に対しては線形 RGB よりもっと多くの精度があるため、ガンマ補正表示を行う場合に、色の帯域を削減します。

r8

単一チャンネル (赤色の要素) 形式です (8 bpp)。

rg8

チャンネル (16 bpp) 当たり 8 bit の 2 チャンネル (赤色と青色の要素) 形式です。

r16f

浮動小数点による単一チャンネル形式 (16 bpp)。色の値は +65504 の範囲までです。

rg16f

チャンネル (32 bpp) 当たり 16 bit の浮動小数点による 2 チャンネル形式です。色の値は +65504 の範囲までです。

r32f

浮動小数点による単一チャンネル形式 (32 bpp)。

rg32f

チャンネル (64 bpp) 当たり 32 bit の浮動小数点による 2 チャンネル形式です。

CompareMode

equal

ピクセルのステンシル値は与えられた値と等しい。

notequal

ピクセルのステンシル値は与えられた値と等しくない。

less

ピクセルのステンシル値は与えられた値より小さい。

lequal

ピクセルのステンシル値は与えられた値より小さいか等しい。

gequal

ピクセルのステンシル値は与えられた値より大きいか等しい。

greater

ピクセルのステンシル値は与えられた値より大きい。

DrawMode

fill

塗り潰しの図形を描きます。

line

中抜きの図形を描きます。

FilterMode

linear

画像の尺度変更で線形補間 (一次補間) を使用します (デフォルト値)。

nearest

画像の尺度変更で最近接補間 (隣接補完) を使用します。

GraphicsFeature

clampzero

"clampzero" 加工方式に関する対応状況。

lighten

"lighten" および "darken" 混合方式に関する対応状況。

multicanvasformats

別々の形式で複数の Canvas が同じ love.graphics.setCanvas 呼び出しで使用可能であるかどうかに関する対応状況。

GraphicsLimit

pointsize

point の最大の大きさ。

texturesize

Image および Canvas の最大の幅または高さ。

multicanvas

同時に有効にできる Canvas の最大数 (love.graphics.setCanvas による)

canvasmsaa

Canvas に対するアンチエイリアシングの最大サンプル数。

LineJoin

miter

線分の終点を継ぎ目なしで傾斜します (留め継ぎ)。

bevel

線分が互いに交わる地点を平板化します (斜角)。

none

線分の終点に上限を適用しません (なし)。

LineStyle

rough

荒い線を描きます。

smooth

滑らかな線を描きます。

MeshDrawMode

fan

中心点として作用する最初の頂点に対して"扇形"の頂点を作成します。単一の凸面がある多角形を容易に描画するために使用できます。

strip

頂点 1, 2, 3, それに 3, 2, 4 (順序に注意してください), さらに 3, 4, 5 などを使用して連続で接続されている三角形の頂点を作成します。

triangles

頂点と接続されていない三角形を作成します。

points

頂点と接続されていない点を描画します (love.graphics.setPointSize を参照)。

ParticleInsertMode

top

パーティクルは ParticleSystem のパーティクル一覧の一番上へ挿入されます。

bottom

パーティクルは ParticleSystem のパーティクル一覧の一番下へ挿入されます。

random

パーティクルは ParticleSystem のパーティクル一覧の無作為な位置へ挿入されます。

SpriteBatchUsage

dynamic

オブジェクトのデータは存続時間中に時々変更します。

static

初期スプライトまたは頂点が追加された後にオブジェクトの変更を行いません。

stream

オブジェクトのデータは描画中に常時変更します。

StackType

transform

変換スタック (love.graphics.translate, love.graphics.rotate など)。

all

変換状態を含む、全ての love.graphics における状態。

StencilAction

replace

ピクセルにオブジェクトが接触している場合、ピクセルのステンシル値は love.graphics.stencil により指定された値で置換されます。

increment

ピクセルに接触している各オブジェクトに対してステンシル値は 1 加算されます。ステンシル値が 255 まで到達した場合は 255 のままになります。

decrement

ピクセルに接触している各オブジェクトに対してステンシル値は 1 減算されます。 ステンシル値が 0 まで到達した場合は 0 のままになります。

incrementwrap

ピクセルに接触している各オブジェクトに対してステンシル値は 1 加算されます。ステンシル値として 255 が加算される場合は 0 を設定します。

decrementwrap

ピクセルに接触している各オブジェクトに対してステンシル値は 1 減算されます。ステンシル値として 0 が減算された場合は 255 を設定します。

invert

ピクセルに接触している各オブジェクトに対してステンシル値はビットごとに反転されます。ステンシル値として 0 が反転された場合は 255 になります。

WrapMode

clamp

テクスチャを固定します。一度だけ出現します。テクスチャの正常範囲外領域はテクスチャの輪郭線ピクセルに基づいて着色されます。

repeat

テクスチャを反復します。利用可能な範囲全体を塗りつぶします。

mirroredrepeat

毎回反復する度に反転を行うことで、テクスチャを反復します。テクスチャが繋ぎ目のないタイルではない時に repeat 方式よりも良い視覚的な結果を生成するかもしれません。

clampzero

テクスチャを固定します。テクスチャの標準範囲外領域を透過な黒色 (または透過チャンネルがないテクスチャに対しては不透明な黒色) で塗りつぶします。

Canvas

Canvas (キャンバス、画布) は画面外表示で使用されます。つまり描画はできるが可視の実画面に描画されるまでは表示されない不可視の画面と考えることができます。さらに "テクスチャの表示" としても知られています。

Canvas へ座標を変更せず頻繁に描画を行うとき(例えば背景にあるアイテム)、各アイテムごとではなく Canvas へ全て描画することにより、各フレームの描画操作の実行回数を削減できます。

Version 0.10.0 以前は、 LÖVE により対応している全てのグラフィックスカードで Canvas を使用できるとは限りません。

love.graphics.isSupported("canvas") は実行時に対応状況を調べるために使用できます。

Constructors

Functions

Supertypes

Canvas:getDimensions

Canvas の幅と高さを取得します。

width, height = Canvas:getDimensions()

widthnumberピクセル単位での Canvas の幅。
heightnumberピクセル単位での Canvas の高さ。

Canvas:getFilter

Canvas のフィルタ方式を取得します。

min, mag, anisotropy = Canvas:getFilter()

minFilterModeキャンバスの縮小に使うフィルタのモード。
magFilterModeキャンバスの拡大に使うフィルタのモード。
anisotropynumberAnisotropic(異方性)フィルタの最大使用量。

Canvas:getFormat

Canvas のテクスチャ形式を取得します。

format = Canvas:getFormat()

formatCanvasFormatCanvas の形式。

Canvas:getHeight

Canvas の高さを取得します。

height = Canvas:getHeight()

heightnumberピクセル単位での Canvas の高さ。

Canvas:getMSAA

Canvas の描画時に使用するマルチサンプル・アンチエイリアシング (Multi Sample Anti-Alias : MSAA) のサンプル数を取得します。

これは LÖVE を実行するシステムが当数値に非対応であるならば love.graphics.newCanvas の引数に使用される数値と異なる場合があります。

samples = Canvas:getMSAA()

samplesnumberCanvas の描画時に使用するマルチサンプル・アンチエイリアシングのサンプル数。

Canvas:getWidth

Canvas の幅を取得します。

width = Canvas:getWidth()

widthnumberピクセル単位での Canvas の幅。

Canvas:getWrap

Canvas の加工特性を取得します。

この関数は Canvas に現在設定されている水平および垂直方向の加工方式を返します。

horizontal, vertical = Canvas:getWrap()

horizontalWrapModeCanvas の水平方向の加工方式。
verticalWrapModeCanvas の垂直方向の加工方式。

Canvas:newImageData

Canvas の内容から ImageData を生成します。

data = Canvas:newImageData()

dataImageDataCanvas の内容から作成した新規 ImageData です。

data = Canvas:newImageData( x, y, width, height )

dataImageDataCanvas の内容から作成した新規 ImageData です。
xnumber取り込み対象の Canvas 内にある領域の左上角を始点とした x 軸です。
ynumber取り込み対象の Canvas 内にある領域の左上角を始点とした y 軸です。
widthnumber取り込み対象の Canvas 内に対する領域の幅
heightnumber取り込み対象の Canvas 内に対する領域の高さ

Canvas:renderTo

Canvas へ表示するために関数を使用します。

これは love.graphics.setCanvas への略記法であり、

canvas:renderTo( func )

は下記と同じです。

love.graphics.setCanvas( canvas )

func()

love.graphics.setCanvas()

Canvas:renderTo( func )

funcfunction描画操作を行う関数。

Canvas:setFilter

Canvas の フィルタ方式 を設定します。

Canvas:setFilter( min, mag, anisotropy )

minFilterModeCanvas の縮小に使うフィルタの方式。
mag (min)FilterModeCanvas の拡大に使うフィルタの方式。
anisotropy (1)numberAnisotropic (異方性)フィルタの最大使用量。

Canvas:setWrap

Canvas の加工特性を設定します。

この関数は回転または尺度変更時における Canvas の角の取り扱い方を設定します。 WrapMode に 'clamp' が設定されたときは、角の補間を行いません。 'repeat' が設定されたときはキャンバスの反対側にあるピクセルにより角を補完します。

Canvas:setWrap( horizontal, vertical )

horizontalWrapModeCanvas の水平方向の加工方式。
vertical (horizontal)WrapModeCanvas の垂直方向の加工方式。

Font

画面に描写できる文字の字形を定義します。

Constructors

Functions

Supertypes

Font:getAscent

フォントの勾配を取得します。

基線および基線から最も遠い範囲のグリフの上部との間の距離を勾配として計ります。

ascent = Font:getAscent()

ascentnumberピクセル単位でのフォントの勾配。

Font:getBaseline

フォントの基線を取得します。

ほとんどのスクリプトにおいて基線の概念を共有します: 文字に基づく仮想水平行です。一部のスクリプトにおいて、グリフの部分は、基線より下に位置します。

baseline = Font:getBaseline()

baselinenumberピクセル単位でのフォントの基線。

Font:getDescent

フォントの傾斜を取得します。

基線および書体にあるグリフの最も低い傾斜との間の距離を傾斜として計ります。

descent = Font:getDescent()

descentnumberピクセル単位でのフォントの傾斜。

Font:getFilter

フォントのフィルタ方式を取得します。

min, mag, anisotropy = Font:getFilter()

minFilterModeフォントの縮小に使うフィルタのモード。
magFilterModeフォントの拡大に使うフィルタのモード。
anisotropynumberAnisotropic(異方性)フィルタの最大使用量。

Font:getHeight

フォントの高さを取得します。

全ての空白を含んだ大きさがフォントの高さになります。つまり必要な高さです。

height = Font:getHeight()

heightnumberピクセル単位でのフォントの高さ。

Font:getLineHeight

行の高さを取得します。

この値は以前に Font:setLineHeight により設定されたもの、または標準値の 1.0 です。

height = Font:getLineHeight()

heightnumber行の現在の高さ。

Font:getWidth

テキストの行で求められる水平方向の大きさを判定します。

改行には対応していません。

width = Font:getWidth( line )

widthnumber行の幅。
linestring文字列。

Font:getWrap

折り返し制限の設定情報、テキストに対する書式情報を取得します。

この関数は改行を正確に計算します(つまり '\n')。

width, wrappedtext = Font:getWrap( text, wraplimit )

widthnumber折り返されたテキストの最大幅。
wrappedtexttable折り返されたテキストの各行を有するシーケンス。
textstring折り返すテキスト。
wraplimitnumber折り返す前にテキストで許容される各行のピクセル単位による''テキスト''最大幅。

Font:hasGlyphs

フォントが文字または文字列として表示できるか取得します。

hasglyph = Font:hasGlyphs( character )

hasglyphbooleanフォントが文字列内にある全ての UTF-8 文字を表示できるかどうか。
characterstringUTF-8 で符号化された Unicode 文字列。

hasglyph = Font:hasGlyphs( codepoint )

hasglyphbooleanWhether the font can render the glyph represented by the codepoint number.
codepointnumberA unicode codepoint number.

Font:setFallbacks

代替フォントを設定します。フォントがグリフを有していない場合は、次に存在する別の代替フォントからグリフを代用します。 これは Cascading Style Sheets (CSS) で "フォントスタック" を設定するのと類似しています。

Font:setFallbacks( fallbackfont1, ... )

fallbackfont1Font使用する最初の代替フォント
...Font追加の代替フォント

Font:setFilter

フォントのフィルタ方式を設定します。

Font:setFilter( min, mag, anisotropy )

minFilterModeフォントの縮小に使うフィルタのモード。
mag (min)FilterModeフォントの拡大に使うフィルタのモード。
anisotropy (1)numberAnisotropic(異方性)フィルタの最大使用量。

Font:setLineHeight

行の高さを設定します。

フォントの表示時における実際の行の高さは

フォントの高さに行の高さを乗算したものにより決定されます。

標準値は 1.0 です。

Font:setLineHeight( height )

heightnumber新しい行の高さ。

Mesh

二次元ポリゴンメッシュはテクスチャが貼られた図形の描画に使用されます。

Constructors

Functions

Supertypes

Mesh:attachAttribute

描画時に使用するために、この Mesh と異なる Mesh から頂点属性を付加します。これは幾つか異なる Mesh 間で頂点属性データを共有するために使用することができます。

Mesh:attachAttribute( name, mesh )

namestring付加を行う頂点属性の名称。
meshMesh頂点属性の取得を行う Mesh です。

Mesh:getDrawMode

Mesh の描画に使用する方式を取得します。

mode = Mesh:getDrawMode()

modeMeshDrawModeMesh の描画に使用する方式。

Mesh:getDrawRange

Mesh の描画時に使用される頂点の範囲を取得します。

min, max = Mesh:getDrawRange()

minnumber描画時に使用される最初の頂点の索引または、この Mesh に一つ設定されている場合に頂点マップにある最初の値の索引を使用します。
maxnumber描画時に使用される最後の頂点の索引または、この Mesh に一つ設定されている場合に頂点マップにある最後の値の索引を使用します。

Mesh:getTexture

Mesh の描画時に使用するテクスチャ (Image または Canvas) を取得します。

texture = Mesh:getTexture()

textureTextureMesh の描画時にテクスチャとして使用する Image か Canvas, または nil ならば何も設定されていません。

Mesh:getVertex

Mesh にある頂点の特性を取得します。

attributecomponent, ... = Mesh:getVertex( index )

attributecomponentnumber指定された頂点にある最初の頂点属性における第一要素。
...number指定された頂点にある全頂点属性の追加要素。
indexnumber情報の検索を行う頂点の索引。

x, y, u, v, r, g, b, a = Mesh:getVertex( index )

xnumber頂点の位置における x-座標。
ynumber頂点の位置における y-座標。
unumberテクスチャの座標として水平の要素。
vnumberテクスチャの座標として垂直の要素。
rnumber頂点の色として赤の要素。
gnumber頂点の色として緑の要素。
bnumberThe 頂点の色として青色の成分。
anumber頂点の色として透過の要素。
indexnumber情報の検索を行う頂点の索引。

Mesh:getVertexAttribute

Mesh において頂点内にある特定属性の特性を取得します。

love.graphics.newMesh (日本語) によりカスタム頂点形式で指定された Mesh を除き、

最初の属性は位置を、二番目の属性はテクスチャ座標を、そして三番目の属性は色を有しています。

value1, value2, ... = Mesh:getVertexAttribute( vertexindex, attributeindex )

value1number属性の第一要素に対する値。
value2number属性の第二要素に対する値。
...number任意による追加の頂点属性要素。
vertexindexnumber変更を行う頂点の索引。
attributeindexnumber変更を行う頂点にある属性の索引。

Mesh:getVertexCount

Mesh にある頂点の合計数を取得します。

num = Mesh:getVertexCount()

numnumberMesh にある頂点の合計数。

Mesh:getVertexFormat

作成された Mesh の頂点形式を取得します。

format = Mesh:getVertexFormat()

formattableThe vertex format of the Mesh, which is a table containing tables for each vertex attribute the Mesh was created with, in the form of {attribute, ...}.
format.attributetableA table containing the attribute's name, it's data type, and the number of components in the attribute, in the form of {name, datatype, components}.
format....tableAdditional vertex attributes in the Mesh.

Mesh:getVertexMap

Mesh に対して頂点マップを取得します。頂点マップは Mesh が描画される時に頂点を使用する順序を記述します。頂点、頂点マップと Mesh 描画方式は画面で対象を正確に表示するか決定するために連携動作します。

Mesh:setVertexMap で頂点マップが以前に設定されていない場合は、この関数は LÖVE nil を、または 0.9.2 以前ではからテーブルを返します。

map = Mesh:getVertexMap()

maptable描画時に使用する頂点の索引一覧があるテーブル。

Mesh:isAttributeEnabled

Mesh にある特定の頂点属性が有効または無効であるかを取得します。無効にされた属性の頂点データは Mesh の描画時に使用されません。

enabled = Mesh:isAttributeEnabled( name )

enabledbooleanこの Mesh を描画する場合に頂点属性を使用するか否か。
namestring有効または無効にする頂点属性の名称。

Mesh:setAttributeEnabled

Mesh にある特定の頂点属性を有効または無効にします。無効にされた属性の頂点データは Mesh の描画時に使用されません。

Mesh:setAttributeEnabled( name, enable )

namestring有効または無効にする頂点属性の名称。
enablebooleanこの Mesh を描画する場合に頂点属性を使用するか否か。

Mesh:setDrawMode

Mesh の描画に使用する方式を設定します。

Mesh:setDrawMode( mode )

modeMeshDrawModeMesh の描画に使用する方式。

Mesh:setDrawRange

合計の部分集合に対して Mesh における頂点の描画を制限します。

Mesh:setDrawRange( min, max )

minnumber描画時に使用される最初の頂点の索引または、この Mesh に一つ設定されている場合に頂点マップにある最初の値の索引を使用します。
maxnumber描画時に使用される最後の頂点の索引または、この Mesh に一つ設定されている場合に頂点マップにある最後の値の索引を使用します。

Mesh:setDrawRange()

Allows all vertices in the Mesh to be drawn.

Mesh:setTexture

Mesh の描画時に使用するテクスチャ (Image または Canvas) を設定します。

Mesh:setTexture()

Mesh:setTexture( texture )

textureTextureMesh の描画時にテクスチャとして使用する Image または Canvas です。

Mesh:setVertex

Mesh にある頂点の特性を設定します。

Mesh:setVertex( index, attributecomponent, ... )

indexnumber変更したい頂点の索引。
attributecomponentnumber指定された頂点にある最初の頂点属性における第一要素。
...number指定された頂点にある全頂点属性の追加要素。

Mesh:setVertex( index, vertex )

indexnumberThe index of the the vertex you want to modify.
vertextableA table with vertex information, in the form of {attributecomponent, ...}.
vertex.attributecomponentnumberThe first component of the first vertex attribute in the specified vertex.
vertex....numberAdditional components of all vertex attributes in the specified vertex.

Mesh:setVertex( index, x, y, u, v, r, g, b, a )

Sets the vertex components of a Mesh that wasn't created with a custom vertex format.

indexnumber変更したい頂点の索引。
xnumber頂点の位置として x-軸。
ynumber頂点の位置として y-軸。
unumberテクスチャの座標として水平の要素。
vnumberテクスチャの座標として垂直の要素。
r (255)number頂点の色として赤色の成分。
g (255)number頂点の色として緑色の成分。
b (255)number頂点の色として青色の成分。
a (255)number頂点の色として透過の成分。

Mesh:setVertex( index, vertex )

Sets the vertex components of a Mesh that wasn't created with a custom vertex format.

indexnumberThe index of the the vertex you want to modify.
vertextableA table with vertex information.
vertex.[1]numberThe position of the vertex on the x-axis.
vertex.[2]numberThe position of the vertex on the y-axis.
vertex.[3]numberThe horizontal component of the texture coordinate.
vertex.[4]numberThe vertical component of the texture coordinate.
vertex.[5] (255)numberThe red component of the vertex's color.
vertex.[6] (255)numberThe green component of the vertex's color.
vertex.[7] (255)numberThe blue component of the vertex's color.
vertex.[8] (255)numberThe alpha component of the vertex's color.

Mesh:setVertexAttribute

Mesh において頂点内にある特定属性の特性を設定します。

love.graphics.newMesh (日本語) によりカスタム頂点形式で指定された Mesh を除き、

最初の属性は位置を、二番目の属性はテクスチャ座標を、そして三番目の属性は色を有しています。

Mesh:setVertexAttribute( vertexindex, attributeindex, value1, value2, ... )

vertexindexnumber変更を行う頂点の索引。
attributeindexnumber変更を行う頂点にある属性の索引。
value1number属性の第一要素に対する新規値。
value2number属性の第二要素に対する新規値。
...number任意による追加の頂点属性要素。

Mesh:setVertexMap

Mesh に対して頂点マップを設定します。頂点マップは Mesh の描画時における頂点の使用順序について記述します。頂点、頂点マップ、および Mesh の描画方式はどのように対象が正確に画面へ表示されるか決定するために動作します。

頂点マップは描画時に頂点の再利用また並び替えを頂点の引数または頂点の複製といった実際の変更なしで可能にします。これは異なる Mesh の描画方式と組み合わせたときに特に有用です。

Mesh:setVertexMap( map )

maptable描画時に使用する頂点の索引一覧があるテーブル。必ず値の範囲は Mesh:getVertexCount() にしてください。

Mesh:setVertexMap( vi1, vi2, vi3 )

vi1number描画時に使用する一番目の頂点の索引。必ず値の範囲は Mesh:getVertexCount() にしてください。
vi2number描画時に使用する二番目の頂点の索引。
vi3number描画時に使用する三番目の頂点の索引。

Mesh:setVertices

新規 Mesh により頂点の範囲を変更します。 Mesh による頂点の総数は作成後に変更できません。これはループ内で Mesh:setVertex を呼び出すよりも多くの場合はより効率的です。

Mesh:setVertices( vertices )

verticestableThe table filled with vertex information tables for each vertex, in the form of {vertex, ...} where each vertex is a table in the form of {attributecomponent, ...}.
vertices.attributecomponentnumberThe first component of the first vertex attribute in the vertex.
vertices....numberAdditional components of all vertex attributes in the vertex.
vertices.startvertex (1)numberThe index of the first vertex to replace.

Mesh:setVertices( vertices )

Sets the vertex components of a Mesh that wasn't created with a custom vertex format.

verticestableThe table filled with vertex information tables for each vertex as follows:
vertices.[1]numberThe position of the vertex on the x-axis.
vertices.[2]numberThe position of the vertex on the y-axis.
vertices.[3]numberThe horizontal component of the texture coordinate. Texture coordinates are normally in the range of [0, 1], but can be greater or less (see WrapMode).
vertices.[4]numberThe vertical component of the texture coordinate. Texture coordinates are normally in the range of [0, 1], but can be greater or less (see WrapMode).
vertices.[5] (255)numberThe red color component.
vertices.[6] (255)numberThe green color component.
vertices.[7] (255)numberThe blue color component.
vertices.[8] (255)numberThe alpha color component.

Image

描画可能な画像の型。

Constructors

Functions

Supertypes

Image:getData

元の ImageData または CompressedData から取得したものを使用して画像を作成します。

全ての画像は参照用の Data として保持したまま画像を作成するために使用されます。 love.window.setMode または Image:refresh が呼ばれたときに画像の再読込をするために Data は使用されます。

data = Image:getData()

dataImageData元の ImageData を使用して作成された圧縮画像。

data = Image:getData()

dataCompressedImageDataThe original CompressedImageData used to create the Image, if the image is compressed.

Image:getDimensions

画像の幅と高さを取得します。

width, height = Image:getDimensions()

widthnumberピクセル単位による画像の幅。
heightnumberピクセル単位での画像の高さ。

Image:getFilter

画像のフィルタ方式を取得します。

min, mag = Image:getFilter()

minFilterMode画像の縮小に使うフィルタの方式。
magFilterMode画像の拡大に使うフィルタの方式。

Image:getFlags

Image が作成されたときに使用されるフラグを取得します。

flags = Image:getFlags()

flagstableImageFlag キーを有するテーブル。

Image:getHeight

画像の高さを取得します。

height = Image:getHeight()

heightnumberピクセル単位での画像の高さ。

Image:getMipmapFilter

Image に対して mipmap フィルタの方式を取得します。

mode, sharpness = Image:getMipmapFilter()

modeFilterModemipmap レベルとの間で使用されるフィルタ方式。 nil ならば mipmap フィルタは有効になっていません。
sharpnessnumber描画時に通常よりもより多くまたはより少なく詳細な mipmap レベルを画像へ使用すべきかどうかで使う値を決定します。

Image:getWidth

画像の幅を取得します。

width = Image:getWidth()

widthnumberピクセル単位での画像の幅。

Image:getWrap

Image の加工特性を取得します。

この関数は Image に現在設定されている水平および垂直方向の加工方式を返します。

horizontal, vertical = Image:getWrap()

horizontalWrapModeImage の水平方向の加工方式。
verticalWrapModeImage の垂直方向の加工方式。

Image:refresh

画像の作成に用いるために ImageData または CompressedData から画像の内容を再読込します。

Image:refresh()

Image:refresh( x, y, width, height )

xnumber再読み込みを行う画像領域内における右上角の x-軸。
ynumber再読み込みを行う画像領域内における右上角の x-軸。
widthnumber再読み込みを行う画像領域内における幅。
heightnumber再読み込みを行う画像領域内における高さ。

Image:setFilter

画像のフィルタ方式を設定します。

Image:setFilter( min, mag )

minFilterMode画像の縮小に使うフィルタの方式。
mag (min)FilterMode画像の拡大に使うフィルタの方式。

Image:setMipmapFilter

Image に対して mipmap フィルタの方式を設定します。

ミップマップ (Mipmap) は縮尺での描画時に有用です。これにより性能およびエイリアシングの問題を改善できます。

作成する必要があります。

Image:setMipmapFilter( filtermode, sharpness )

filtermodeFilterModemipmap レベルとの間で使用されるフィルタ方式。 "nearest" であれば大抵はより良い性能になります。
sharpness (0)number性能を犠牲にして描画を行う場合に、正数による鮮鋭度の値としてより詳細な mipmap レベルを画像に使用します。負数値では反転を行います。

Image:setMipmapFilter()

Disables mipmap filtering.

Image:setWrap

Image の加工特性を設定します。

この関数は画像の範囲より大きい Quad で画像を反復して描画する方法を設定します。画像へ clamped または repeat を設定して垂直および水平方向の両方を反復できます。 Clamped では画像が一度だけ現れますが、repeate では Quad に余白がある限り何度も繰り返します。

重要な注意。Quad へ全て詰め込むために画像を伸張を行ってしまうため望まない視覚効果が発生する場合があります。この場合は、 <tt>Image:setWrap("repeat", "repeat")</tt> を設定することで画像は全て繰り返し描画され、適切な大きさの Quad を使用することで視覚的に最良の外観になります。

Image:setWrap( horizontal, vertical )

horizontalWrapModeImage の水平方向の加工方式。
vertical (horizontal)WrapModeImage の垂直方向の加工方式。

ParticleSystem

ParticleSystemは 火炎または煙幕などのパーティクル(粒子)による視覚効果を作成するために使用することができます。

パーティクル・システムは love.graphics.newParticleSystem を使用して作成します。その他なんらかの 描画可能 なものと同様に love.graphics.draw を使用して画面へ描画することができます。さらに、放射されたパーティクルのあらゆる変更を確認するために love.update コールバックにてパーティクル・システムの更新を行う必要があります。

パーティクル・システムは setParticleLifetime および setEmissionRate を呼び出すまでパーティクルを一切作成しません。

Constructors

Functions

Supertypes

ParticleSystem:clone

ParticleSystem の同一複製物を停止状態に設定して作成します。

particlesystem = ParticleSystem:clone()

particlesystemParticleSystemこの ParticleSystem の新規同一複製物。

ParticleSystem:emit

パーティクル・エミッタからパーティクルの爆発を放射します。

ParticleSystem:emit( numparticles )

numparticlesnumberパーティクルの放射量。パーティクル・システムのバッファの大きさが最大まで到達した場合は、パーティクルの放射数は切り詰められます。

ParticleSystem:getCount

システムにあるパーティクルの現在量を取得します。

count = ParticleSystem:getCount()

countnumber現在活動中のパーティクルの数。

ParticleSystem:getAreaSpread

パーティクルの領域に基づく生産引数を取得します。

distribution, dx, dy = ParticleSystem:getAreaSpread()

distributionAreaSpreadDistributionパーティクルにおける分布の種類。
dxnumber一様偏差によるX-軸のエミッタからの距離または標準偏差による X-軸の正規分布を大量生産します。
dynumber一様偏差によるY-軸のエミッタからの距離または標準偏差による Y-軸の正規分布を大量生産します。

ParticleSystem:getBufferSize

ParticleSystem で一度に扱うことのできるパーティクルの最大数を取得します。

buffer = ParticleSystem:getBufferSize()

buffernumberパーティクルの最大数。

ParticleSystem:getColors

パーティクルのスプライトへ適用されている一連の色を取得します。

r1, g1, b1, a1, r2, g2, b2, a2, ... = ParticleSystem:getColors()

r1numberFirst color, red component (0-255).
g1numberFirst color, green component (0-255).
b1numberFirst color, blue component (0-255).
a1numberFirst color, alpha component (0-255).
r2numberSecond color, red component (0-255).
g2numberSecond color, green component (0-255).
b2numberSecond color, blue component (0-255).
a2numberSecond color, alpha component (0-255).
...numberEtc.

ParticleSystem:getDirection

パーティクル・エミッタ (粒子放出器) の方向を取得します (弧度にて)。

direction = ParticleSystem:getDirection()

directionnumberエミッタの方向 (弧度)

ParticleSystem:getEmissionRate

毎秒当たりにおけるパーティクルの放射量を取得します。

rate = ParticleSystem:getEmissionRate()

ratenumber毎秒当たりにおけるパーティクルの放射量。

ParticleSystem:getInsertMode

パーティクルを ParticleSystem へ新規追加するときに使用する方式を取得します。

mode = ParticleSystem:getInsertMode()

modeParticleInsertMode新規のパーティクルを ParticleSystem へ追加するときに使用する方式。

ParticleSystem:getLinearAcceleration

パーティクルにおける線形加速度 (X および Y 軸からの加速度)を取得します。

作成されたパーティクルごとに X および Y 軸から xmin, ymin および xmax, ymax との間に加速度があります。

xmin, ymin, xmax, ymax = ParticleSystem:getLinearAcceleration()

xminnumberX 軸からの最小加速度。
yminnumberY 軸からの最小加速度。
xmaxnumberX 軸からの最大加速度。
ymaxnumberY 軸からの最大加速度。

ParticleSystem:getLinearDamping

パーティクルに対する線形減衰 (定数減速) 量を取得します。

min, max = ParticleSystem:getLinearDamping()

minnumberパーティクルに適用されている線形減衰の最小量。
maxnumberパーティクルに適用されている線形減衰の最大量。

ParticleSystem:getEmitterLifetime

パーティクル・システムにおけるパーティクルの放射時間の長さを取得します ( -1 ならばパーティクルは永久に放射します)。

life = ParticleSystem:getEmitterLifetime()

lifenumberエミッタの活動限界時間 (秒単位)。

ParticleSystem:getOffset

パーティクル画像の描画支距を取得します。

x, y = ParticleSystem:getOffset()

xnumberパーティクル画像においての描画支距の X 座標。
ynumberパーティクル画像においての描画支距の Y 座標。

ParticleSystem:getParticleLifetime

パーティクルの活動限界時間を取得します。

min, max = ParticleSystem:getParticleLifetime()

minnumberパーティクルの最小活動限界時間 (秒単位)
max (min)numberパーティクルの最大活動限界時間 (秒単位)

ParticleSystem:getQuads

パーティクル・スプライトに対して使用されている連続 Quad を取得します。

quads = ParticleSystem:getQuads()

quadstable使用されている Quad を有するテーブル。

ParticleSystem:getPosition

エミッタの位置を取得します。

x, y = ParticleSystem:getPosition()

xnumberx-軸からの座標。
ynumbery-軸からの座標。

ParticleSystem:getRadialAcceleration

半径の加速度を取得します (エミッタから離れて別方向へ)。

min, max = ParticleSystem:getRadialAcceleration()

minnumber最小加速度。
max (min)number最大加速度。

ParticleSystem:getRotation

パーティクル作成後における画像の回転を取得します (弧度にて)。

min, max = ParticleSystem:getRotation()

minnumber最小初期角度 (弧度)。
max (min)number最大初期角度 (弧度)。

ParticleSystem:getSizes

スプライトの尺度変更における一連の大きさを取得します。 1.0 は通常の大きさです。パーティクルシステムはパーティクルの活動限界時間内は各々の大きさを均一に書き換え続けます。

size1, size2, ... = ParticleSystem:getSizes()

size1number一番目の大きさ。
size2number二番目の大きさ。
...number八番目の大きさ。

ParticleSystem:getSizeVariation

大きさの変動量を取得します(0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

variation = ParticleSystem:getSizeVariation()

variationnumber変動量 (0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

ParticleSystem:getSpeed

パーティクルの速度を取得します。

min, max = ParticleSystem:getSpeed()

minnumberパーティクルの最小線形速度。
max (min)numberパーティクルの最大線形速度。

ParticleSystem:getSpin

スプライトの回転を取得します。

min, max = ParticleSystem:getSpin()

minnumberThe minimum spin (radians per second).
max (min)numberThe maximum spin (radians per second).

ParticleSystem:getSpinVariation

回転の変動量を取得します (0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

variation = ParticleSystem:getSpinVariation()

variationnumber変動量 (0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

ParticleSystem:getSpread

パーティクル・エミッタの方向展開量を取得します (弧度にて)。

spread = ParticleSystem:getSpread()

spreadnumberエミッタの展開量 (弧度にて)。

ParticleSystem:getTexture

パーティクルで使用されるテクスチャ (Image または Canvas) を取得します。

texture = ParticleSystem:getTexture()

textureTextureパーティクルで使用されるテクスチャ (Image または Canvas)。

ParticleSystem:getTangentialAcceleration

接線加速度を取得します (パーティクルの方向への垂直加速度)。

min, max = ParticleSystem:getTangentialAcceleration()

minnumber最小加速度。
max (min)number最大加速度。

ParticleSystem:hasRelativeRotation

パーティクルの角度および回転と速度を相対的にするかどうか取得します。有効時に、パーティクルは速度の角度および回転と相対的な角度により整列されます。

enabled = ParticleSystem:hasRelativeRotation()

enabledbooleantrue ならばパーティクルの相対的回転は有効であり、 false であれば無効です。

ParticleSystem:isActive

パーティクル・システムにおいてパーティクルの放射が機能しているかどうか確認します。

active = ParticleSystem:isActive()

activebooleantrue ならばシステムは機能しており、それ以外は false です。

ParticleSystem:isPaused

パーティクル・システムが一時停止しているかどうか確認します。

paused = ParticleSystem:isPaused()

pausedbooleantrue ならばシステムは一時停止しており、それ以外は false です。

ParticleSystem:isStopped

パーティクル・システムが停止しているかどうか確認します。

stopped = ParticleSystem:isStopped()

stoppedbooleantrue ならばシステムは停止しており、それ以外は false です。

ParticleSystem:moveTo

エミッタの位置を移動します。この結果として ParticleSystem:setPosition をフレームごとに使用する場合の挙動よりパーティクルは円滑に生産されます。

ParticleSystem:moveTo( x, y )

xnumberx-軸からの座標。
ynumbery-軸からの座標。

ParticleSystem:pause

パーティクル・エミッタの一時停止。

ParticleSystem:pause()

ParticleSystem:reset

パーティクル・エミッタを初期状態に戻すために、既に存在するパーティクルの削除および活動限界時間カウンタを初期状態へ戻します。

ParticleSystem:reset()

ParticleSystem:setAreaSpread

パーティクルの領域に基づく生産引数を設定します。新規に作成されたパーティクルは、この関数への引数に基づきエミッタの周辺領域で生産されます。

ParticleSystem:setAreaSpread( distribution, dx, dy )

distributionAreaSpreadDistribution新規のパーティクルにおける分布の種類。
dxnumber一様偏差によるX-軸のエミッタからの距離または標準偏差によるX-軸の正規分布を大量生産します。
dynumber一様偏差によるY-軸のエミッタからの距離または標準偏差によるY-軸の正規分布を大量生産します。

ParticleSystem:setBufferSize

バッファの大きさを設定します(システムで利用可能なパーティクルの最大量)。

ParticleSystem:setBufferSize( buffer )

buffernumberバッファの大きさ。

ParticleSystem:setColors

パーティクルのスプライトへ適用する一連の色を設定します。パーティクルシステムはパーティクルの活動限界時間内は各色を均一に書き換え続けます。

RGBA の四種類をまとめたものを引数として渡すことができ、使用したい RGA 成分値を表記したもの、または RGBA の成分値をテーブルとして表したものであり、三つだけ値を与えられた場合は標準の透過値は 255 になります。最低でも一色は必ず指定してください。最大八番目まで使用できます。

ParticleSystem:setColors( r1, g1, b1, a1, r2, g2, b2, a2, ... )

r1numberFirst color, red component (0-255).
g1numberFirst color, green component (0-255).
b1numberFirst color, blue component (0-255).
a1numberFirst color, alpha component (0-255).
r2numberSecond color, red component (0-255).
g2numberSecond color, green component (0-255).
b2numberSecond color, blue component (0-255).
a2numberSecond color, alpha component (0-255).
...numberEtc.

ParticleSystem:setDirection

パーティクルが放射される方向を設定します。

ParticleSystem:setDirection( direction )

directionnumberエミッタの方向 (弧度)

ParticleSystem:setEmissionRate

毎秒当たりにおけるパーティクルの放射量を設定します。

ParticleSystem:setEmissionRate( rate )

ratenumber毎秒当たりにおけるパーティクルの放射量。

ParticleSystem:setEmitterLifetime

パーティクル・システムにおけるパーティクルの放射時間の長さを設定します ( -1 ならばパーティクルは永久に放射します)。

ParticleSystem:setEmitterLifetime( life )

lifenumberエミッタの活動限界時間 (秒単位)。

ParticleSystem:setInsertMode

新規のパーティクルを ParticleSystem へ追加するときに使用する方式を設定します。

ParticleSystem:setInsertMode( mode )

modeParticleInsertMode新規のパーティクルを ParticleSystem へ追加するときに使用する方式。

ParticleSystem:setLinearAcceleration

パーティクルにおける線形加速度 (X および Y 軸からの加速度)を設定します。

作成されたパーティクルごとに X および Y 軸から xmin,ymin および xmax,ymax との間の加速度があります。

ParticleSystem:setLinearAcceleration( xmin, ymin, xmax, ymax )

xminnumberX 軸からの最小加速度。
ymin (0)numberY 軸からの最小加速度。
xmax (xmin)numberX 軸からの最大加速度。
ymax (ymin)numberY 軸からの最大加速度。

ParticleSystem:setLinearDamping

パーティクルに対する線形減衰 (定数減速) 量を設定します。

ParticleSystem:setLinearDamping( min, max )

minnumberパーティクルに適用されている線形減衰の最小量。
maxnumberパーティクルに適用されている線形減衰の最大量。

ParticleSystem:setOffset

パーティクルのスプライトが回転する支距の位置を設定します。

この関数を使用しない場合は、パーティクルは中心の周囲を回転します。

ParticleSystem:setOffset( x, y )

xnumberX 座標の回転支距。
ynumberY 座標の回転支距。

ParticleSystem:setParticleLifetime

パーティクルの活動限界時間を設定します。

ParticleSystem:setParticleLifetime( min, max )

minnumberパーティクルの最小活動限界時間 (秒単位)
max (min)numberパーティクルの最大活動限界時間 (秒単位)

ParticleSystem:setPosition

エミッタの位置を取得します。

ParticleSystem:setPosition( x, y )

xnumberx-軸からの座標。
ynumbery-軸からの座標。

ParticleSystem:setQuads

パーティクル・スプライトに対して使用する連続 Quad を設定します。パーティクルはパーティクルの現在の活動限界に基づいた一覧から Quad の選択を行うことで、 ParticleSystems にあるアニメーションされたスプライト・シートの使用を可能にします。

ParticleSystem:setQuads( quad1, quad2 )

quad1Quad一番目に使用する Quad
quad2Quad二番目に使用する Quad

ParticleSystem:setQuads( quads )

quadstable使用対象の Quad を有するテーブル。

ParticleSystem:setRadialAcceleration

半径の加速度を設定します (エミッタから離れて別方向へ)。

ParticleSystem:setRadialAcceleration( min, max )

minnumber最小加速度。
max (min)number最大加速度。

ParticleSystem:setRelativeRotation

パーティクルの角度および回転と速度を相対的にするかどうか設定します。有効時に、パーティクルは速度の角度および回転と相対的な角度により整列されます。

ParticleSystem:setRelativeRotation( enable )

enablebooleantrue ならばパーティクルの相対的回転は有効であり、 false であれば無効です。

ParticleSystem:setRotation

パーティクル作成後の画像の回転を設定します (弧度にて)。

ParticleSystem:setRotation( min, max )

minnumber最小初期角度 (弧度)。
max (min)number最大初期角度 (弧度)。

ParticleSystem:setSizes

スプライトの尺度変更における一連の大きさを設定します。 1.0 は通常の大きさです。パーティクルシステムはパーティクルの活動限界時間内は各々の大きさを均一に書き換え続けます。

最低でも大きさとして必ず一つ指定してください。最大八番目まで使用できます。

ParticleSystem:setSizes( size1, size2, ... )

size1number一番目の大きさ。
size2number二番目の大きさ。
...number八番目の大きさ。

ParticleSystem:setSizeVariation

大きさの変動量を設定します(0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

ParticleSystem:setSizeVariation( variation )

variationnumber変動量 (0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

ParticleSystem:setSpeed

パーティクルの速度を設定します。

ParticleSystem:setSpeed( min, max )

minnumberパーティクルの最小線形速度。
max (min)numberパーティクルの最大線形速度。

ParticleSystem:setSpin

スプライトの回転を設定します。

ParticleSystem:setSpin( min, max )

minnumber最小回転数 (一秒あたりの弧度)
max (min)number最大回転数 (一秒あたりの弧度)

ParticleSystem:setSpinVariation

回転の変動量を設定します(0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

ParticleSystem:setSpinVariation( variation )

variationnumber変動量 (0 であれば無変動であり 1 であれば開始から終了の間まで完全に変動します)。

ParticleSystem:setSpread

システムにおける展開量を設定します。

ParticleSystem:setSpread( spread )

spreadnumber展開量 (弧度)

ParticleSystem:setTexture

パーティクルで使用されるテクスチャ (Image または Canvas) を設定します。

ParticleSystem:setTexture( texture )

textureTextureパーティクルで使用されるテクスチャ (Image または Canvas)。

ParticleSystem:setTangentialAcceleration

接線加速度を設定します (パーティクルの方向への垂直加速度)。

ParticleSystem:setTangentialAcceleration( min, max )

minnumber最小加速度。
max (min)number最大加速度。

ParticleSystem:start

パーティクル・エミッタを開始します。

ParticleSystem:start()

ParticleSystem:stop

パーティクル・エミッタを停止して、活動限界時間カウンタを初期設定へ戻します。

ParticleSystem:stop()

ParticleSystem:update

パーティクル・システムの更新。パーティクルの移動、作成および破壊。

ParticleSystem:update( dt )

dtnumber最後のフレームからの時間 (秒単位)。

Quad

テクスチャの座標情報を持つ四辺形 (四辺と四角がある多角形)。

Quad はテクスチャの一部を選択して描画をするために使用できます。この方法では、一枚のテクスチャ・アトラス (テクスチャの見本集または地図帳) を読み込んでから、副・画像へ分割できます。

Constructors

Functions

Supertypes

Quad:getTextureDimensions

love.graphics.newQuad で初期指定された基準テクスチャ寸法の取得します。

sw, sh = Quad:getTextureDimensions()

swnumberQuad で使用されるテクスチャの幅。
shnumberQuad で使用されるテクスチャの高さ。

Quad:getViewport

この Quad における現在の表示領域 (Viewport: ビューポート) を取得します。

x, y, w, h = Quad:getViewport()

xnumber左上端からの x-軸。
ynumber右上端からの x-軸。
wnumber表示領域の幅。
hnumber表示領域の高さ。

Quad:setViewport

表示領域 (Viewport) と合致するテクスチャの座標を設定します。

Quad:setViewport( x, y, w, h )

xnumber左上端からの x-軸。
ynumber右上端からの x-軸。
wnumber表示領域の幅。
hnumber表示領域の高さ。

Shader

Shader は高度なハードウェア高速化によるピクセルまたは頂点の操作にて使用されます。これらのエフェクトは容易にコーディングするために若干簡素化された GLSL (Open'''GL''' '''S'''hading '''L'''anguage) 言語に基づいたもので記述されます。

Shader は HDR/ブルームを含む、モーション・ブラー、グレースケール/反転/セピア/あらゆるの種類の彩色エフェクト、反射/屈折、歪み、バンプ・マッピング、およびその他多種多様なものへ使用できる潜在能力があります! こちらは基本的なシェーダと学習を始めるには良い出発点となる教材集があります: https://github.com/vrld/shine

Constructors

Functions

Supertypes

Shader:getExternVariable

シェーダーに存在する 'extern' ('uniform') 変数に関する情報を取得します。

シェーダーに変数名が存在しない、またはビデオドライバーのシェーダー・コンパイラにより変数が影響を与えないことを決定した場合は nil を返します。

type, components, arrayelements = Shader:getExternVariable( name )

typeShaderVariableType変数の基底型。
componentsnumber変数にある要素数 (例えば 2 に対しては vec2 または mat2)。
arrayelementsnumber変数の種類が配列であれば配列にある要素数であり、それ以外は 1 です。
namestringextern 変数の名前。

Shader:getWarnings

シェーダーのコードからあらゆる警告およびエラーメッセージを返します。これはグラフィックス・ハードウェアが原因ではない何らかの不具合がある場合に作成したシェーダーのデバッグにて使用できます。

warnings = Shader:getWarnings()

warningsstring警告およびエラーメッセージ (もしあれば)。

Shader:send

シェーダーの内部にある特別な変数 (''uniform'') へ一つ以上の値を送信します。Uniform 変数は ''uniform'' または ''extern'' キーワードを使用して区分する必要があります。例えば、

uniform float time; // "float" は GLSL シェーダーで使用される数値型です。

uniform float varsvec2 light_pos;

uniform vec4 colors[4;

相当する send 呼び出しは

shader:send("time", t)

shader:send("vars",a,b)

shader:send("light_pos", {light_x, light_y})

shader:send("colors", {r1, g1, b1, a1}, {r2, g2, b2, a2}, {r3, g3, b3, a3}, {r4, g4, b4, a4})

Uniform / extern 変数はシェーダのコード側では読み取り専用であり、 Shader:send の呼び出しにより変更されるまで不変です。変数が各々で宣言されている場合に限り、シェーダーの頂点およびピクセルの両方にある要素の Uniform 変数へアクセスできます。

Shader:send( name, number, ... )

namestringシェーダーへ送信する number の名前。
numbernumberuniform 変数へ格納するために送信する number
...numberuniform 変数が配列である場合に送信する追加の number

Shader:send( name, vector, ... )

namestringシェーダーへ送信するベクトルの名前。
vectortableベクトルとして uniform 変数へ格納するために送信する number です。テーブルにある要素数でベクトルの種類を決定します (例えば、数値が二つであれば -> vec2)。最低2つおよび最高4つまでの数値を使用できます。
...tableuniform 変数が配列である場合に送信する追加のベクトル。ベクトルの大きさは全て同一である必要があります (例えば、 vec3 のものだけ)。

Shader:send( name, matrix, ... )

namestringシェーダーへ送信するベクトルの名前。
matrixtableベクトルとして uniform 変数へ格納するために送信する number です。テーブルにある要素数でベクトルの種類を決定します (例えば、数値が二つであれば -> vec2)。最低2つおよび最高4つまでの数値を使用できます。
...tableuniform 変数が配列である場合に送信する追加のベクトル。ベクトルの大きさは全て同一である必要があります (例えば、 vec3 のものだけ)。

Shader:send( name, texture )

namestringシェーダーへ送信する Texture の名前。
textureTextureuniform 変数へ送信するテクスチャ (Image または Canvas)

Shader:send( name, boolean, ... )

namestringシェーダーへ送信する Boolean の名前。
booleanbooleanuniform 変数へ送信する Boolean です。
...booleanuniform 変数が配列である場合に送信する追加の Boolean です。

Shader:sendColor

シェーダに存在する特別な (''extern'' / ''uniform'') vec3 または vec4 変数へ1つ以上の色を送信します。Shader:send と異なり、色の要素は 255 の範囲内にする必要があります。大域ガンマ補正が有効な場合は、色に対してガンマ補正処理を行います。

外部変数は ''extern'' キーワードを使用して識別する必要があります。例えば、

extern vec4 Color;

対応する sendColor 呼び出しは、

shader:sendColor("Color", {r, g, b, a})

各変数が宣言されている限り、 外部変数は頂点およびピクセル(画素)シェーダの段階で両方ともアクセスすることができます。

Shader:sendColor( name, color, ... )

namestringシェーダへ送信を行う色の外部変数名。
colortableベクターとして extern へ送信するために 255 の範囲内から成る赤、緑、青、および選択制の透過色要素を有するテーブル。
...tableextern が配列の場合に送信を行う追加の色。全ての色は同じ大きさ (例えば vec3 のみ)である必要があります。

SpriteBatch

一枚の画像を用いて、 love.graphics.draw() の呼び出しを一回使用することにより任意数の同一内容の複製を描画します。これは、例えば、高性能で一枚の背景画像の複製を繰り返して描画するために使用できます。

画像としてテクスチャ・アトラス (一枚の画像ファイルに独立した複数の画像が存在する地図や図表のようなもの) である場合は SpriteBatch はより有用になります。 Quad をバッチへ追加することにより、アトラスから様々な副-画像を描画できます。

Constructors

Functions

Supertypes

SpriteBatch:add

スプライトをバッチへ追加します。スプライトは追加された順番にて描画されます。

id = SpriteBatch:add( x, y, r, sx, sy, ox, oy, kx, ky )

idnumber追加されたスプライトの識別子。
xnumberオブジェクトを描画する座標 (x-軸)。
ynumberオブジェクトを描画する座標 (y-軸)。
r (0)number方向 (弧度)。
sx (1)number尺度変更係数 (x-軸)。
sy (sx)number尺度変更係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

id = SpriteBatch:add( quad, x, y, r, sx, sy, ox, oy, kx, ky )

idnumber追加されたスプライトの識別子。
quadQuadQuad を追加します。
xnumberオブジェクトを描画する座標 (x-軸)
ynumberオブジェクトを描画する座標 (y-軸)
r (0)number方向 (弧度)。
sx (1)number尺度変更係数 (x-軸)。
sy (sx)number尺度変更係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

SpriteBatch:attachAttribute

描画時に使用するために、この SpriteBatch に Mesh から頂点ごとの属性を付加します。これはスプライトごとに色を有する代わりとして頂点ごと、あるいは追加のスプライトごとの情報により SpriteBatch を拡張するために Shader と組み合わせることができます。

SpriteBatch にある各スプライトは次の順番で 4 つの頂点を有しています: 左上、左下、右上、右下です。 SpriteBatch:add (そして SpriteBatch:set で使用される) により返された索引は特定のスプライトで最初の頂点を判定するために 4 で乗算することができます。

SpriteBatch:attachAttribute( name, mesh )

namestring付加を行う頂点属性の名称。
meshMesh頂点属性の取得を行う Mesh です。

SpriteBatch:clear

バッファからスプライトを全て削除します。

SpriteBatch:clear()

SpriteBatch:flush

バッチ内にある新規変更されたデータを直接的にグラフィックス・カードへ全て送信します。

通常は本メソッドを love.graphics.draw(spritebatch, ...) として呼び出すことは不要であり必要になれば自動的に呼ばれますが、明示的に '''SpriteBatch:flush''' を使用することにより発生するかに対して多くの制御を与えます。

このメソッドが使用された場合は、一般に love.graphics.draw(spritebatch, ...) 呼び出しの間に一回(最大量)だけでありそれ以上呼ばれるべきではありません。

SpriteBatch:flush()

SpriteBatch:getBufferSize

SpriteBatch が保持できる最大スプライト数を取得します。

size = SpriteBatch:getBufferSize()

sizenumberSpriteBatch が保持できるスプライトの最大数。

SpriteBatch:getColor

add および set の操作で使用する色を取得します。

このメソッドは SpriteBatch:setColor で色が設定されていないか現在の SpriteBatch の色が消去されている場合は、 nil を返します。

r, g, b, a = SpriteBatch:getColor()

rnumber赤色の成分 (0-255)
gnumber緑色の成分 (0-255)
bnumber青色の成分 (0-255)
anumber青色の成分 (0-255)

SpriteBatch:getCount

SpriteBatch にある現在のスプライトの本数を取得します。

count = SpriteBatch:getCount()

countnumberSpriteBatch にある現在のスプライトの本数。

SpriteBatch:getTexture

SpriteBatch にて使用されているテクスチャ (Image または Canvas) を取得します。

texture = SpriteBatch:getTexture()

textureTextureSpriteBatch にて使用されている Image または Canvas です。

SpriteBatch:set

バッチにあるスプライトを変更します。これには add および addq により返された識別子が必要です。

SpriteBatch:set( id, x, y, r, sx, sy, ox, oy, kx, ky )

idnumber変更されるスプライトの識別子。
xnumberオブジェクトを描画する座標 (x-軸)
ynumberオブジェクトを描画する座標 (y-軸)
r (0)number方向 (弧度)。
sx (1)number拡大・縮小係数 (x-軸)。
sy (sx)number拡大・縮小係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

SpriteBatch:set( id, quad, x, y, r, sx, sy, ox, oy, kx, ky )

idnumber変更されるスプライトの識別子。
quadQuadバッチの画像として使用される Quad です。
xnumberオブジェクトを描画する座標 (x-軸)
ynumberオブジェクトを描画する座標 (y-軸)
r (0)number方向 (弧度)。
sx (1)number拡大・縮小係数 (x-軸)。
sy (sx)number拡大・縮小係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断係数 (x-軸)。
ky (0)number剪断係数 (y-軸)。

SpriteBatch:setBufferSize

SpriteBatch が保持できる最大スプライト数を設定します。この関数が呼ばれてもバッチにある既存のスプライト(新規の最大数まで)は消去''されません''。

SpriteBatch:setBufferSize( size )

sizenumberSpriteBatch が保持できるスプライトの最大数。

SpriteBatch:setColor

次回の add および set の操作で使用する色を設定します。引数なしで関数を呼び出すと SpriteBatch に対してスプライトごとに全ての色を無効にします。

version 0.9.2 以前では、いずれかのスプライトが色を保持していれば SpriteBatch には love.graphics.setColor により設定されたグローバルな色の影響を受けません。

SpriteBatch:setColor( r, g, b, a )

rnumber赤の量。
gnumber緑の量。
bnumber青の量。
a (255)number透過の量。

SpriteBatch:setColor()

Disables all per-sprite colors for this SpriteBatch.

SpriteBatch:setTexture

描画時に、バッチにあるスプライトで使用されるテクスチャ (Image または Canvas) を設定します。

SpriteBatch:setTexture( texture )

textureTextureバッチにあるスプライトで使用される新規の Image または Canvas です。

Text

描画可能なテキスト。

Constructors

Functions

Supertypes

Text:add

Text オブジェクトに対して着色したテキストを指定された位置に追加します。

index = Text:add( textstring, x, y, angle, sx, sy, ox, oy, kx, ky )

indexnumberText:getWidth または Text:getHeight で使用できる索引番号。
textstringstringオブジェクトへ追加するテキスト。
x (0)numberx-軸における新規テキストの位置。
y (0)numbery-軸における新規テキストの位置。
angle (0)number弧度による新規テキストの方向。
sx (1)numberx-軸の尺度変更係数。
sy (sx)numbery-軸の尺度変更係数。
ox (0)numberx-軸における原点の支距。
oy (0)numbery-軸における原点の支距。
kx (0)numberx-軸の剪断 / 斜行係数
ky (0)numbery-軸の剪断 / 斜行係数

index = Text:add( coloredtext, x, y, angle, sx, sy, ox, oy, kx, ky )

indexnumberAn index number that can be used with Text:getWidth or Text:getHeight.
coloredtexttableA table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }.
coloredtext.color1tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string1stringA string of text which has a color specified by the previous color.
coloredtext.color2tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string2stringA string of text which has a color specified by the previous color.
coloredtext....tables and stringsAdditional colors and strings.
x (0)numberThe position of the new text on the x-axis.
y (0)numberThe position of the new text on the y-axis.
angle (0)numberThe orientation of the new text in radians.
sx (1)numberScale factor on the x-axis.
sy (sx)numberScale factor on the y-axis.
ox (0)numberOrigin offset on the x-axis.
oy (0)numberOrigin offset on the y-axis.
kx (0)numberShearing / skew factor on the x-axis.
ky (0)numberShearing / skew factor on the y-axis.

Text:addf

Text オブジェクトに対して整形 / 着色したテキストを指定された位置に追加します。

index = Text:addf( textstring, wraplimit, align, x, y, angle, sx, sy, ox, oy, kx, ky )

indexnumberText:getWidth または Text:getHeight で使用できる索引番号。
textstringstringオブジェクトへ追加するテキスト。
wraplimitnumber自動で次行への行送り処理を行うまでのピクセル単位によるテキストの最大幅。
alignAlignModeテキストの整列位置。
xnumber新規テキストの位置 (x-軸)。
ynumber新規テキストの位置 (y-軸)
angle (0)number方向 (弧度)。
sx (1)number尺度変更係数 (x-軸)。
sy (sx)number尺度変更係数 (y-軸)。
ox (0)number原点の支距 (x-軸)。
oy (0)number原点の支距 (y-軸)。
kx (0)number剪断 / 斜行係数 (x-軸)。
ky (0)number剪断 / 斜行係数 (y-軸)。

index = Text:addf( coloredtext, wraplimit, align, x, y, angle, sx, sy, ox, oy, kx, ky )

indexnumberAn index number that can be used with Text:getWidth or Text:getHeight.
coloredtexttableA table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }.
coloredtext.color1tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string1stringA string of text which has a color specified by the previous color.
coloredtext.color2tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string2stringA string of text which has a color specified by the previous color.
coloredtext....tables and stringsAdditional colors and strings.
wraplimitnumberThe maximum width in pixels of the text before it gets automatically wrapped to a new line.
alignAlignModeThe alignment of the text.
xnumberThe position of the new text on the x-axis.
ynumberThe position of the new text on the y-axis.
angle (0)numberThe orientation of the object in radians.
sx (1)numberScale factor on the x-axis.
sy (sx)numberScale factor on the y-axis.
ox (0)numberOrigin offset on the x-axis.
oy (0)numberOrigin offset on the y-axis.
kx (0)numberShearing / skew factor on the x-axis.
ky (0)numberShearing / skew factor on the y-axis.

Text:clear

Text オブジェクトの内容を消去します。

Text:clear()

Text:getDimensions

ピクセル単位でテキストの幅と高さを取得します。

width, height = Text:getDimensions()

widthnumberテキストの幅。複数の部分文字列が Text:add で追加された場合は、最後にある部分文字列の幅を返します。
heightnumberテキストの高さ。複数の部分文字列が Text:add で追加された場合は、最後にある部分文字列の高さを返します。

width, height = Text:getDimensions( index )

Gets the width and height of a specific sub-string that was previously added to the Text object.

widthnumber部分文字列の幅 (尺度変更およびその他の変換前の)。
heightnumber部分文字列の高さ (尺度変更およびその他の変換前の)。
indexnumberText:add または Text:addf により返された索引番号。

Text:getFont

Text オブジェクトで使用されているフォントを取得します。

font = Text:getFont()

fontFontThe font used with this Text object.

Text:getHeight

ピクセル単位でテキストの高さを取得します。

height = Text:getHeight()

heightnumberThe height of the text. If multiple sub-strings have been added with Text:add, the height of the last sub-string is returned.

height = Text:getHeight( index )

Gets the height of a specific sub-string that was previously added to the Text object.

heightnumber部分文字列の高さ (尺度変更およびその他の変換前の)。
indexnumberText:add または Text:addf により返された索引番号。

Text:getWidth

ピクセル単位でテキストの幅を取得します。

width = Text:getWidth()

widthnumberThe width of the text. If multiple sub-strings have been added with Text:add, the width of the last sub-string is returned.

width = Text:getWidth( index )

Gets the width of a specific sub-string that was previously added to the Text object.

widthnumber部分文字列の幅 (尺度変更およびその他の変換前の)。
indexnumberText:add または Text:addf により返された索引番号。

Text:set

Text オブジェクトの内容を新規未整形の文字列で置き換えます。

Text:set( textstring )

textstringstringテキストとして使用する新規文字列。

Text:set( coloredtext )

coloredtexttableA table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }.
coloredtext.color1tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string1stringA string of text which has a color specified by the previous color.
coloredtext.color2tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string2stringA string of text which has a color specified by the previous color.
coloredtext....tables and stringsAdditional colors and strings.

Text:set()

Clears the contents of the Text object.

Text:setf

Text オブジェクトの内容を新規整形した文字列で置き換えます。

Text:setf( textstring, wraplimit, align )

textstringstringテキストとして使用する新規文字列。
wraplimitnumber自動で次行への行送り処理を行うまでのピクセル単位によるテキストの最大幅。
align ("left")AlignModeテキストの整列位置。

Text:setf( coloredtext, wraplimit, align )

coloredtexttableA table containing colors and strings to use as the new text, in the form of { color1, string1, color2, string2, ... }.
coloredtext.color1tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string1stringA string of text which has a color specified by the previous color.
coloredtext.color2tableA table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
coloredtext.string2stringA string of text which has a color specified by the previous color.
coloredtext....tables and stringsAdditional colors and strings.
wraplimitnumberThe maximum width in pixels of the text before it gets automatically wrapped to a new line.
align ("left")AlignModeThe alignment of the text.

Text:setf()

Clears the contents of the Text object.

Text:setFont

Text で使用されているフォントを置き換えます。

Text:setFont( font )

fontFontこの Text オブジェクトで新規に使用するフォントです。

Texture

Drawable オブジェクトでテクスチャを表現するための上位型です。全てのテクスチャは Quad により描画できます。この抽象型は直接の作成はできません。

Supertypes

Subtypes

Video

Video を描画できるようにします。

Constructors

Functions

Supertypes

Video:getDimensions

ピクセル単位で Video の幅と高さを取得します。

width, height = Video:getDimensions()

widthnumberVideo の幅。
heightnumberVideo の高さ。

Video:getFilter

描画時に使用される拡大・縮小フィルタを取得します。

min, mag, anisotropy = Video:getFilter()

minFilterModeVideo 縮小時に使用されるフィルター方式。
magFilterModeVideo 拡大時に使用されるフィルター方式。
anisotropy (1)number異方性フィルタリングの最大使用量。

Video:getHeight

ピクセル単位で Video の高さを取得します。

height = Video:getHeight()

heightnumberVideo の高さ。

Video:getSource

Video の音声を再生するために使用する音声 Source を取得します。 Video が音声を有していない、または Video:setSource で nil 引数により呼び出された場合は nil を返します。

source = Video:getSource()

sourceSource音声の再生に使用する音声 Source または、 Video が無音声ならば nil を返します。

Video:getWidth

ピクセル単位で Video の幅を取得します。

width = Video:getWidth()

widthnumberVideo の幅。

Video:isPlaying

Video が現在再生中かどうか返します。

playing = Video:isPlaying()

playingbooleanVideo が再生中かどうか。

Video:pause

Video を一時停止します。

Video:pause()

Video:play

Video の再生を開始します。画面上に Video を映し出すには love.graphics.draw で描画する必要があります。

Video:play()

Video:rewind

Video を先頭まで巻き戻します。

Video:rewind()

Video:seek

Video の現在再生位置を設定します。

Video:seek( offset )

offsetnumber時間は Video の先頭からの秒数です。

Video:setFilter

描画時に使用される拡大・縮小フィルタを設定します。

Video:setFilter( min, mag, anisotropy )

minFilterModeVideo 縮小時に使用されるフィルター方式。
magFilterModeVideo 拡大時に使用されるフィルター方式。
anisotropy (1)number異方性フィルタリングの最大使用量。

Video:setSource

Video の音声を再生するために使用する音声 Source を設定します。音声 Source は再生速度および同期により制御されます。

Video:setSource( source )

source (nil)Source音声の再生に使用する音声 Source または、 Video の同期が無効ならば nil を返します。

Video:tell

Video の現在再生位置を取得します。

Video:tell( seconds )

secondsnumberThe time in seconds since the beginning of the Video.

love.image

Types

Functions

Enums

love.image.isCompressed

CompressedImageData としてファイルを読み込むことができるかどうか判定します。

compressed = love.image.isCompressed( filename )

compressedbooleanファイルは CompressedImageData として読み込むことができるか否か。
filenamestring圧縮された可能性がある画像ファイルの名前です。

compressed = love.image.isCompressed( fileData )

compressedbooleanFileData は CompressedImageData として読み込むことができるか否か。
fileDataFileData圧縮された可能性がある画像の FileData オブジェクト。

love.image.newCompressedData

圧縮された画像ファイルから CompressedImageData オブジェクトを新規作成します。 LÖVEは CompressedImageFormat ページで列挙されている複数の圧縮テクスチャ形式に対応しています。

compressedImageData = love.image.newCompressedData( file )

compressedImageDataCompressedImageData新規 CompressedImageData オブジェクト。
filestring / File / FileData圧縮された画像ファイルのファイル名。

love.image.newImageData

ImageData オブジェクトを新規作成します。

imageData = love.image.newImageData( width, height, data )

imageDataImageData新規 ImageData オブジェクト。
widthnumberImageData の幅。
heightnumberImageData の高さ。
data (none)stringImageData へ読み込むデータ (RGBA バイト列、左側から右側および上側から下側) です。

imageData = love.image.newImageData( file )

imageDataImageData新規 ImageData オブジェクト。
filestring / File / FileData画像ファイルのファイル名。

CompressedImageFormat

DXT1

DXT1 形式。ピクセルごとに 4 bit のRGB データ (32 bit の ImageData および通常の Image との比較)。デスクトップシステムにおいて完全に不透明な画像に適しています。

DXT3

DXT3 形式。ピクセルごとに 8 bit の RGBA データ。この形式で不透明度を滑らかに変化させる場合は上手く混ざり合いません。

DXT5

DXT5 形式。ピクセルごとに 8 bit の RGBA データ。デスクトップシステムにおいて不透明度が変化する画像において推奨されます。

BC4

BC4 形式 (3Dc+ または ATI1 としても知られています)。ピクセルごとに 4 bit の赤チャンネルのみを格納します。

BC4s

これは BC4 形式の符号付きによる異形です。上記と同じですがテクスチャーにおけるピクセル値はシェーダー側の 0, 1 ではなく 1 範囲です。

BC5

BC5 形式 (3Dc または ATI2 としても知られています)。ピクセルごとに 8 bit の赤および緑チャンネルを格納します。

BC5s

これは BC5 形式の符号付きによる異形です。

BC6h

BC6hs

BC6H 形式の符号付きによる異形です。 RGB データの格納範囲は +65504 です。

BC7

BC7 形式 (BPTC としても知られています)。ピクセルごとに 8 bit の RGB または RGBA データを格納します。

ETC1

ETC1 形式。ピクセルごとに 4 bit の RGB です。古い Android デバイスにおいて完全に不透明な画像に適しています。

ETC2rgb

ETC2 形式の異形。ピクセルごとに 4 bit の RGB です。新しい Android デバイスにおいて完全に不透明な画像に適しています。

ETC2rgba

ETC2 形式の異形。ピクセルごとに 8 bit の RGBA データ。新しいモバイル機器において不透明が可変の画像で推奨されます。

ETC2rgba1

ETC2 形式の RGBA による異形でありピクセルが完全に透明または完全に不透明からなります。ピクセルごとに 4 bit の RGBA です。

EACr

単一チャンネルによる EAC 形式の異形です。ピクセルごとに 4 bit の赤チャンネルのみを格納します。

EACrs

符号付き単一チャンネルによる EAC 形式の異形です。上記と同じですがシェーダーにおいてテクスチャのピクセル値は 1 ではなく 1 の範囲です。

EACrg

2チャンネルによる EAC 形式の異形です。ピクセルごとに 8 bit の赤および緑チャンネルを格納します。

EACrgs

符号付き2チャンネルによる EAC 形式の異形です。

PVR1rgb2

ピクセルごとに 2 bit の RGB からなる PVRTC1 形式の異形です。テクスチャは 2 の累乗または平方の大きさにより PVRTC1 形式で圧縮する必要があります。

PVR1rgb4

ピクセルごとに 4 bit の RGB からなる PVRTC1 形式の異形です。ピクセルごとに 8bit の RGB データを格納します。

PVR1rgba2

ピクセルごとに 2 bit の RGBA からなる PVRTC1 形式の異形です。

PVR1rgba4

ピクセルごとに 4 bit の RGBA からなる PVRTC1 形式の異形です。

ASTC4x4

ASTC 形式のブロックごとに 4x4 ピクセルによる異形。ピクセルあたり 8 bit による RGBA データ。

ASTC5x4

ASTC 形式のブロックごとに 5x4 ピクセルによる異形。ピクセルあたり 6.4 bit による RGBA データ。

ASTC5x5

ASTC 形式のブロックごとに 5x5 ピクセルによる異形。ピクセルあたり 5.12 bit による RGBA データ。

ASTC6x5

ASTC 形式のブロックごとに 6x5 ピクセルによる異形。ピクセルあたり 4.27 bit による RGBA データ。

ASTC6x6

ASTC 形式のブロックごとに 6x6 ピクセルによる異形。ピクセルあたり 3.56 bit による RGBA データ。

ASTC8x5

ASTC 形式のブロックごとに 8x5 ピクセルによる異形。ピクセルあたり 3.2 bit による RGBA データ。

ASTC8x6

ASTC 形式のブロックごとに 8x6 ピクセルによる異形。ピクセルあたり 2.67 bit による RGBA データ。

ASTC8x8

ASTC 形式のブロックごとに 8x8 ピクセルによる異形。ピクセルあたり 2 bit による RGBA データ。

ASTC10x5

ASTC 形式のブロックごとに 10x5 ピクセルによる異形。ピクセルあたり 2.56 bit による RGBA データ。

ASTC10x6

ASTC 形式のブロックごとに 10x6 ピクセルによる異形。ピクセルあたり 2.13 bit による RGBA データ。

ASTC10x8

ASTC 形式のブロックごとに 10x8 ピクセルによる異形。ピクセルあたり 1.6 bit による RGBA データ。

ASTC10x10

ASTC 形式のブロックごとに 10x10 ピクセルによる異形。ピクセルあたり 1.28 bit による RGBA データ。

ASTC12x10

ASTC 形式のブロックごとに 12x10 ピクセルによる異形。ピクセルあたり 1.07 bit による RGBA データ。

ASTC12x12

ASTC 形式のブロックごとに 12x12 ピクセルによる異形。ピクセルあたり 0.89 bit による RGBA データ。

ImageFormat

tga

Targa 画像形式。

png

PNG 画像形式。.

CompressedImageData

圧縮したまま RAM に存在できるように設計された圧縮画像形式を提供します。

CompressedImageData は DXT1, DXT5, および BC5 / 3Dc のような標準圧縮テクスチャ形式を包括的に扱います。

CompressedImageData では画面へ直接描画できません。これに関しては Image を参照してください。

Constructors

Functions

Supertypes

CompressedImageData:getDimensions

CompressedImageData の幅と高さを取得します。

width, height = CompressedImageData:getDimensions()

widthnumberCompressedImageData の幅。
heightnumberCompressedImageData の高さ。

width, height = CompressedImageData:getDimensions( level )

widthnumberCompressedImageData の特有の mipmap レベルの幅。
heightnumberCompressedImageData の特有の mipmap レベルの高さ。
levelnumbermipmap (ミップマップ)のレベル。必ず CompressedImageData:getMipmapCount() の範囲内にする必要があります。

CompressedImageData:getFormat

CompressedImageData の形式を取得します。

format = CompressedImageData:getFormat()

formatCompressedImageFormatCompressedImageData の形式。

CompressedImageData:getHeight

CompressedImageData の高さを取得します。

height = CompressedImageData:getHeight()

heightnumberCompressedImageData の高さ。

height = CompressedImageData:getHeight( level )

heightnumberCompressedImageData の特有の mipmap レベルの高さ。
levelnumbermipmap のレベル。必ず CompressedImageData:getMipmapCount() の範囲内にする必要があります。

CompressedImageData:getMipmapCount

CompressedImageData に存在する Mipmap (ミップマップ)のレベル数を取得します。基となる mipmap レベル (元画像) も総計へ算入されます。

mipmaps = CompressedImageData:getMipmapCount()

mipmapsnumberCompressedImageData に格納されている mipmap のレベル数。

CompressedImageData:getWidth

CompressedImageData の幅を取得します。

width = CompressedImageData:getWidth()

widthnumberCompressedImageData の幅。

width = CompressedImageData:getWidth( level )

widthnumberCompressedImageData の特有の mipmap レベルの幅。
levelnumbermipmap のレベル。必ず CompressedImageData:getMipmapCount() の範囲内にする必要があります。

ImageData

生の (復号化された) 画像データ。

ImageData では画面へ直接描画できません。これに関しては Image を参照してください。

Constructors

Functions

Supertypes

ImageData:encode

ImageData の符号化を行いセーブ・ディレクトリへ書き込みます。

filedata = ImageData:encode( format, filename )

filedataFileData新規 FileData オブジェクトとして符号化された画像。
formatImageFormat画像の符号化形式。
filename (nil)stringファイル出力先のファイル名称。 nil の場合はファイルの出力を行わずに FileData のまま返します。

ImageData:getDimensions

ImageData の幅と高さを取得します。

width, height = ImageData:getDimensions()

widthnumberImageData の幅を取得します。
heightnumberImageData の高さを取得します。

ImageData:getHeight

ピクセル単位で ImageData の高さを取得します。

height = ImageData:getHeight()

heightnumberピクセル単位による ImageData の高さ。

ImageData:getPixel

画像において指定された座標にあるピクセルの色を取得します。

有効な x および y の値は 0 を始点として画像の幅および高さの -1 以下までです。非整数値は切り捨てられます。

r, g, b, a = ImageData:getPixel( x, y )

rnumber赤色の成分 (0-255)
gnumber緑色の成分 (0-255)
bnumber青色の成分 (0-255)
anumber透過の成分 (0-255)
xnumberX 軸上のピクセル位置。
ynumberY 軸上のピクセル位置。

ImageData:getWidth

ピクセル単位で ImageData の幅を取得します。

width = ImageData:getWidth()

widthnumberピクセル単位による ImageData の幅さ。

ImageData:mapPixel

全ピクセルへ関数を適用して画像を変形します。

この関数は高次関数です。別の関数を引数として扱い、ImageData にある各ピクセルに対して一括で呼び出します。

渡されたは関数へ各ピクセルの順番により 6 つの引数から呼ばれます。引数はピクセルの x と y 座標および赤、緑、青、および透過の値を数値として表記したものです。関数はピクセルに対して赤、緑、青、および透過の値を返します。

function pixelFunction(x, y, r, g, b, a)

    -- ピクセル・マッピング関数を定義するための雛形です。

    -- ここで r, g, b および a へ新しい値を与えるための演算を行います

-- ...

return r, g, b, a

end

ImageData:mapPixel( pixelFunction )

pixelFunctionfunction全ピクセルへ適用する関数の引数。

ImageData:paste

別のソースの ImageData から ImageData へ貼り付けます。

ImageData:paste( source, dx, dy, sx, sy, sw, sh )

sourceImageData複製を行う転送元の ImageData です。
dxnumber転送先において左上角からの x 軸における位置。
dynumber転送先において左上角からの y 軸における位置。
sxnumber転送元において左上角からの x 軸における位置。
synumber転送元において左上角からの y 軸における位置。
swnumber転送元の幅。
shnumber転送元の高さ。

ImageData:setPixel

画像において指定された座標にあるピクセルの色を設定します。

有効な x および y の値は 0 を始点として画像の幅および高さの -1 以下までです。

ImageData:setPixel( x, y, r, g, b, a )

xnumberX 軸上のピクセル位置。
ynumberY 軸上のピクセル位置。
rnumber赤色の成分 (0-255)
gnumber緑色の成分 (0-255)
bnumber青色の成分 (0-255)
anumber透過の成分 (0-255)

love.joystick

Types

Functions

Enums

love.joystick.getJoystickCount

接続されているジョイスティックの本数を取得します。

joystickcount = love.joystick.getJoystickCount()

joystickcountnumber接続されているジョイスティックの本数

love.joystick.getJoysticks

接続されているジョイスティックの一覧を取得します。

joysticks = love.joystick.getJoysticks()

joystickstable現在接続されている Joystick の一覧。

love.joystick.loadGamepadMappings

love.joystick.saveGamepadMappings により作成されたゲームパッド・マッピングの文字列またはファイルを読み込みます。

例えば Steam におけるコントローラー構成インタフェースの全体像、またはこの優良なデータベースにから作成されたものなども同様に、任意の SDL ゲームコントローラ・マッピング文字列として認識します。

love.joystick.loadGamepadMappings( filename )

filenamestringマッピングとして読み込む文字列。

love.joystick.loadGamepadMappings( mappings )

mappingsstringマッピングとして読み込む文字列。

love.joystick.saveGamepadMappings

ゲームパッドとして認識されており最近使用されたかゲームパッドの割り当てが変更されたかのいずれかにおいて全てのジョイスティックの仮想ゲームパッド・マッピングを保存します。

マッピングは love.joystick.loadGamepadMappings にて使用するために格納されます。

mappings = love.joystick.saveGamepadMappings( filename )

mappingsstringファイルへ書きこまれたマッピング文字列。
filename (no file)stringファイル名へ保存するマッピング文字列。

love.joystick.setGamepadMapping

ある種類のジョイスティックの全てのボタン、軸またはハットを仮想ゲームパッドの入力へ割り当てます。例えば、この関数が OS X で接続されている Dualshock 3 コントローラー から返された GUID を使用する場合、 OS X で実行するゲームにおいて''全ての'' Dualshock 3 コントローラー は Joystick:getGamepadAxis および Joystick:isGamepadDown の割り当てに影響します。

LÖVE は一般的なコントローラー向けのゲームパッドの割り当てを多く内蔵しています。この関数は割り当てを変更したり標準ではゲームパッドとして認識されないジョイスティックの種類用に割り当てを新規追加できます。

仮想ゲームパッドのボタンおよび軸は Xbox 360 コントローラーの配列を想定して設計されてます。

success = love.joystick.setGamepadMapping( guid, button, inputtype, inputindex, hatdirection )

successboolean仮想ゲームパッドのボタンへの割り当てが成功したかどうか。
guidstringジョイスティックの種類の割り当てに影響する OS 依存の GUID を指定します。
buttonGamepadButton割り当て先の仮想ゲームパッドのボタン。
inputtypeJoystickInputType仮想ゲームパッドのボタンへ割り当てる入力の種類。
inputindexnumber仮想ゲームパッドのボタンへ割り当てるジョイスティックの軸、ボタン、またはハットの番号。
hatdirectionJoystickHat仮想ゲームパッドのボタンへハットが割り当てられている場合はハットの方向。それ以外は nil です。

success = love.joystick.setGamepadMapping( guid, axis, inputtype, inputindex, hatdirection )

successboolean仮想ゲームパッドの軸への割り当てが成功したかどうか。
guidstringジョイスティックの種類の割り当てに影響する OS 依存の GUID を指定します。
axisGamepadAxis割り当て先の仮想ゲームパッドの軸。
inputtypeJoystickInputType仮想ゲームパッドの軸へ割り当てる入力の種類。
inputindexnumber仮想ゲームパッドの軸へ割り当てるジョイスティックの軸、ボタン、またはハットの番号。
hatdirectionJoystickHat仮想ゲームパッドの軸へハットが割り当てられている場合はハットの方向。それ以外は nil です。

GamepadAxis

leftx

左側のサムスティックの x-軸。

lefty

左側のサムスティックの y-軸。

rightx

右側のサムスティックの x-軸。

righty

右側のサムスティックの y-軸。

triggerleft

左側のアナログトリガー。

triggerright

右側のアナログトリガー。

GamepadButton

a

下面ボタン (A)。

b

右面ボタン (B)。

x

左面ボタン (X)。

y

上面ボタン (Y)。

back

戻るボタン

guide

ガイドボタン。

start

スタートボタン。

leftstick

左スティックのクリックボタン。

rightstick

右スティックのクリックボタン。

leftshoulder

左パンパー。

rightshoulder

右パンパー。

dpup

D-パッドの上。

dpdown

D-パッドの下。

dpleft

D-パッドの左。

dpright

D-パッドの右。

JoystickHat

c

中央

d

l

ld

左下

lu

左上

r

rd

右下

ru

右上

u

JoystickInputType

axis

アナログの軸。

button

ボタン。

hat

8-方向 ハット の値

Joystick

物理ジョイスティックを提供します。

Constructors

Functions

Supertypes

Joystick:getAxes

各軸の方向を返します。

axisDir1, axisDir2, axisDirN = Joystick:getAxes()

axisDir1number軸 1 の方向。
axisDir2number軸 2 の方向。
axisDirNnumber軸 N の方向。

Joystick:getAxis

軸の方向を返します。

direction = Joystick:getAxis( axis )

directionnumber軸の現在値。
axisnumber確認をしたい軸。

Joystick:getAxisCount

ジョイスティックに実装されている軸の個数を取得します。

axes = Joystick:getAxisCount()

axesnumber利用可能な軸の個数。

Joystick:getButtonCount

ジョイスティックに実装されているボタンの個数を取得します。

buttons = Joystick:getButtonCount()

buttonsnumber利用可能なボタンの個数。

Joystick:getGUID

物理的なジョイスティックの機種に基づく時間変化のない固定された固有 GUID を取得します。例えば 全ての Sony Dualshock 3 コントローラー は OS X において 同一の GUID を持ちます。この値はプラットフォームに依存します。

guid = Joystick:getGUID()

guidstringジョイスティックの機種に基づくOS 依存の固有識別子。

Joystick:getGamepadAxis

仮想ゲームパッドの軸の方向を取得します。ジョイスティックがゲームパッドとして認識できないか未接続の場合は、この関数は常に 0 を返します。

direction = Joystick:getGamepadAxis( axis )

directionnumber軸の現在値。
axisGamepadAxis確認をしたい仮想軸。

Joystick:getGamepadMapping

ボタン、軸またはハットを仮想ゲームパッドの入力への割り当てを取得します。

inputtype, inputindex, hatdirection = Joystick:getGamepadMapping( axis )

inputtypeJoystickInputType仮想ゲームパッドの軸へ割り当てた入力の種類。
inputindexnumber仮想ゲームパッドの軸へ割り当てられたジョイスティックの軸、ボタン、またはハットの番号。
hatdirectionJoystickHat仮想ゲームパッドの軸へハットが割り当てられている場合はハットの方向、それ以外は nil です。
axisGamepadAxis割り当てを取得したい仮想ゲームパッドの軸。

inputtype, inputindex, hatdirection = Joystick:getGamepadMapping( button )

inputtypeJoystickInputType仮想ゲームパッドの軸へ割り当てた入力の種類。
inputindexnumber仮想ゲームパッドの軸へ割り当てられたジョイスティックの軸、ボタン、またはハットの番号。
hatdirectionJoystickHat仮想ゲームパッドの軸へハットが割り当てられている場合はハットの方向、それ以外は nil です。
buttonGamepadAxis割り当てを取得したい仮想ゲームパッドの軸。

Joystick:getHat

ハットの方向を取得します。

direction = Joystick:getHat( hat )

directionJoystickHat押されたハットの方向。
hatnumberハットを確認するジョイスティックの番号。

Joystick:getHatCount

ジョイスティックに実装されているハットの個数を返します。

hats = Joystick:getHatCount()

hatsnumberジョイスティックに実装されているハットの個数。

Joystick:getID

ジョイスティックの固有識別子を取得します。識別子の寿命はゲームの終了までであり、ジョイスティックを接続および再接続しても同一になりますが、ゲームを再起動すると'''変更されます。'''

id, instanceid = Joystick:getID()

idnumberジョイスティックの固有識別子 ゲームの起動中は変更されません。
instanceidnumberインスタンスの固有識別子。ジョイスティックの再接時に毎回変更されます。 nil のときはジョイスティックは未接続です。

Joystick:getName

ジョイスティックの機器名を取得します。

name = Joystick:getName()

namestringジョイスティックの機器名。

Joystick:getVibration

ジョイスティックがブルブル対応であれば現在の振動モーターの強さを取得します。

left, right = Joystick:getVibration()

leftnumberジョイスティックに搭載されている現在の左側の振動モーターの強さ。
rightnumberジョイスティックに搭載されている現在の右側の振動モーターの強さ。

Joystick:isConnected

ジョイスティックが接続されているかどうか取得します。

connected = Joystick:isConnected()

connectedbooleantrue ならばジョイスティックは現在は接続されており、 それ以外は false です。

Joystick:isDown

ジョイスティックのボタンが押されているか確認します。

LÖVE 0.9.0 には不具合があり Joystick:isDown に渡されるボタンの番号が 1-基数ではなく 0-基数を要求されてしまいます。例えば、この関数ではボタン 1 は 0 に割り当てられてしまいます。これは 0.9.1 で修正済みです。

anyDown = Joystick:isDown( ... )

anyDownbooleanTrue ならば指定された任意のボタンは押されており、それ以外ならば false です。
...number確認をしたいボタンの番号。

Joystick:isGamepad

ジョイスティックがゲームパッドとして認識されているかどうか取得します。この場合であれば、ジョイスティックのボタンおよび軸は Joystick:getGamepadAxis, Joystick:isGamepadDown, love.gamepadpressed, および関連する関数を経由することで様々なオペレーティングシス

テムおよびジョイスティックの機種であっても標準化された方法を用いて使用できます。

LÖVE は最も人気のあるコントローラーをXbox 360 コントローラーと同様のレイアウトのゲームパッドとして自動認識しますが、さらに love.joystick.setGamepadMapping により追加できます。

isgamepad = Joystick:isGamepad()

isgamepadbooleanTrue ならばジョイスティックはゲームパッドとして認識されており、それ以外は false です。

Joystick:isGamepadDown

仮想ゲームパッドのボタンとしてジョイスティックが押されているか確認します。ジョイスティックがゲームパッドとして認識されていないか未接続ならば、この関数は常に false を返します。

anyDown = Joystick:isGamepadDown( ... )

anyDownbooleantrue ならば用意された任意のボタンは押されており、それ以外ならば false です。
...GamepadButton確認をしたいゲームパッドのボタン。

Joystick:isVibrationSupported

ジョイスティックが振動に対応しているか取得します。

supported = Joystick:isVibrationSupported()

supportedbooleantrue ならばこのジョイスティックはブルブル / フォース・フィードバックによる振動に対応しており、そうでなければ false です。

Joystick:setVibration

ジョイスティックがブルブル対応であれば振動モーターの速度を設定します。これは一般的なゲームパッドの多くは動作しますが、すべてのドライバで適切に対応しているとは限りません。 Joystick:isVibrationSupported を使用して確認を行ってください。

success = Joystick:setVibration( left, right, duration )

successbooleantrue ならば振動値の適用は成功であり、それ以外は false です。
leftnumberジョイスティックに実装されている左側の振動モーターの強度。必ず範囲は 1 にしてください。
rightnumberジョイスティックに実装されている右側の振動モーターの強度。必ず範囲は 1 にしてください。
duration (-1)numberブルブルの長さを秒数で指定します。負数値は無限長を意味します。

love.keyboard

Functions

Enums

love.keyboard.getKeyFromScancode

指定されたハードウェア・スキャンコードに対してキーを対応させます。

キー定数とは異なり、スキャンコードはキーボード配列に依存しません。例えばキーにどの様な刻印がされているか、あるいは利用者のオペレーティング・システムの設定がどの様なものであるかに関わらず、 米国配列のキーボードにある "w" キーと同じ位置にあるキーが押された場合はスキャンコードの "w" が生成されます。

スキャンコードは全てのシステムにて同一の物理配置があるときに標準の操作方法を作成するのに有用です。

key = love.keyboard.getKeyFromScancode( scancode )

keyKeyConstant指定されたスキャンコードに対して対応するキー、または現在のシステムにおいてスキャンコードが KeyConstant のマップに存在しない場合は "unknown" を返します。
scancodeScancodeキー取得先のスキャンコード。

love.keyboard.getScancodeFromKey

指定されたキーに対してハードウェア・スキャンコードを対応させます。

キー定数とは異なり、スキャンコードはキーボード配列に依存しません。例えばキーにどの様な刻印がされているか、あるいは利用者のオペレーティング・システムの設定がどの様なものであるかに関わらず、 米国配列のキーボードにある "w" キーと同じ位置にあるキーが押された場合はスキャンコードの "w" が生成されます。

スキャンコードは全てのシステムにて同一の物理配置があるときに標準の操作方法を作成するのに有用です。

scancode = love.keyboard.getScancodeFromKey( key )

scancodeScancode指定されたキーに対して対応するスキャンコード、または現在のシステムにおいて指定されたキーが物理的な表現として認識されない場合は "unknown" を返します。
keyKeyConstantスキャンコード取得先のキー。

love.keyboard.hasKeyRepeat

キーリピートが有効であるかどうか取得します。

enabled = love.keyboard.hasKeyRepeat()

enabledbooleanキーリピートが有効であれば true を、無効であれば false を返します。

love.keyboard.hasTextInput

テキスト入力イベントが有効であるかどうか取得します。

enabled = love.keyboard.hasTextInput()

enabledbooleanテキスト入力イベントが有効であれば true を、無効であれば false を返します。

love.keyboard.isDown

特定のキーが押されたかどうか検出します。 love.keypressed または love.keyreleased とは混同しないでください。

anyDown = love.keyboard.isDown( key, ... )

anyDownbooleantrue ならば用意された任意のキーは押されており、それ以外ならば false です。
keyKeyConstant検出したいキー。
...KeyConstant検出したい追加のキー。

love.keyboard.isScancodeDown

指定されたスキャンコードが押されたかどうか確認します。 love.keypressed または love.keyreleased とは混同しないでください。

正規のキー定数とは異なり、スキャンコードはキーボード配列に依存しません。キーにどの様な刻印がされているか、あるいは利用者のオペレーティング・システムの設定がどの様なものであるかに関わらず、米国配列のキーボードにある "w" キーと同じ位置にあるキーが押された場合はスキャンコードの "w" が使用されます。

down = love.keyboard.isScancodeDown( scancode, ... )

downbooleantrue ならば用意された任意のキーは押されており、それ以外ならば false です。
scancodeScancode検出したいキー。
...Scancode検出したい追加のキー。

love.keyboard.setKeyRepeat

love.keypressed に対するキーリピートを有効または無効にします。デフォルト値では無効です。

love.keyboard.setKeyRepeat( enable )

enableboolean有効にするとキーを押し続けたときに Keypress イベントでキーリピートを行います。

love.keyboard.setTextInput

テキスト入力イベントを有効または無効にします。 Windows, Mac, and Linux のデフォルト値では有効 (enable) であり、 iOS および Android のデフォルト値では無効 (disable) です。

タッチデバイスでは、これが有効ならばシステム固有のスクリーンキーボード表示します。

love.keyboard.setTextInput( enable )

enablebooleanテキスト入力イベントを使用可能にするかどうか。

love.keyboard.setTextInput( enable, x, y, w, h )

enablebooleanテキスト入力イベントを使用可能にするかどうか。
xnumberテキスト矩形領域の x 位置。
ynumberテキスト矩形領域の y 位置。
wnumberテキスト矩形領域の幅。
hnumberテキスト矩形領域の高さ。

KeyConstant

a

The A key

b

The B key

c

The C key

d

The D key

e

The E key

f

The F key

g

The G key

h

The H key

i

The I key

j

The J key

k

The K key

l

The L key

m

The M key

n

The N key

o

The O key

p

The P key

q

The Q key

r

The R key

s

The S key

t

The T key

u

The U key

v

The V key

w

The W key

x

The X key

y

The Y key

z

The Z key

0

The zero key

1

The one key

2

The two key

3

The three key

4

The four key

5

The five key

6

The six key

7

The seven key

8

The eight key

9

The nine key

space

Space key

In version 0.9.2 and earlier this is represented by the actual space character

!

Exclamation mark key

"

Double quote key

#

Hash key

$

Dollar key

&

Ampersand key

'

Single quote key

(

Left parenthesis key

)

Right parenthesis key

*

Asterisk key

+

Plus key

,

Comma key

-

Hyphen-minus key

.

Full stop key

/

Slash key

:

Colon key

;

Semicolon key

<

Less-than key

=

Equal key

>

Greater-than key

?

Question mark key

@

At sign key

[

Left square bracket key

\

Backslash key

]

Right square bracket key

^

Caret key

_

Underscore key

`

Grave accent key

Also known as the "Back tick" key

kp0

The numpad zero key

kp1

The numpad one key

kp2

The numpad two key

kp3

The numpad three key

kp4

The numpad four key

kp5

The numpad five key

kp6

The numpad six key

kp7

The numpad seven key

kp8

The numpad eight key

kp9

The numpad nine key

kp.

The numpad decimal point key

kp/

The numpad division key

kp*

The numpad multiplication key

kp-

The numpad substraction key

kp+

The numpad addition key

kpenter

The numpad enter key

kp=

The numpad equals key

up

Up cursor key

down

Down cursor key

right

Right cursor key

left

Left cursor key

home

Home key

end

End key

pageup

Page up key

pagedown

Page down key

insert

Insert key

backspace

Backspace key

tab

Tab key

clear

Clear key

return

Return key

Also known as the Enter key

delete

Delete key

f1

The 1st function key

f2

The 2nd function key

f3

The 3rd function key

f4

The 4th function key

f5

The 5th function key

f6

The 6th function key

f7

The 7th function key

f8

The 8th function key

f9

The 9th function key

f10

The 10th function key

f11

The 11th function key

f12

The 12th function key

f13

The 13th function key

f14

The 14th function key

f15

The 15th function key

numlock

Num-lock key

capslock

Caps-lock key

Caps-on is a key press. Caps-off is a key release.

scrollock

Scroll-lock key

rshift

Right shift key

lshift

Left shift key

rctrl

Right control key

lctrl

Left control key

ralt

Right alt key

lalt

Left alt key

rmeta

Right meta key

lmeta

Left meta key

lsuper

Left super key

rsuper

Right super key

mode

Mode key

compose

Compose key

pause

Pause key

escape

Escape key

help

Help key

print

Print key

sysreq

System request key

break

Break key

menu

Menu key

power

Power key

euro

Euro (€) key

undo

Undo key

www

WWW key

mail

Mail key

calculator

Calculator key

appsearch

Application search key

apphome

Application home key

appback

Application back key

appforward

Application forward key

apprefresh

Application refresh key

appbookmarks

Application bookmarks key

Scancode

a

米国配列では 'A' キー。

b

米国配列では 'B' キー。

c

米国配列では 'C' キー。

d

米国配列では 'D' キー。

e

米国配列では 'E' キー。

f

米国配列では 'F' キー。

g

米国配列では 'G' キー。

h

米国配列では 'H' キー。

i

米国配列では 'I' キー。

j

米国配列では 'J' キー。

k

米国配列では 'K' キー。

l

米国配列では 'L' キー。

m

米国配列では 'M' キー。

n

米国配列では 'N' キー。

o

米国配列では 'O' キー。

p

米国配列では 'P' キー。

q

米国配列では 'Q' キー。

r

米国配列では 'R' キー。

s

米国配列では 'S' キー。

t

米国配列では 'T' キー。

u

米国配列では 'U' キー。

v

米国配列では 'V' キー。

w

米国配列では 'W' キー。

x

米国配列では 'X' キー。

y

米国配列では 'Y' キー。

z

米国配列では 'Z' キー。

1

米国配列では '1' キー。

2

米国配列では '2' キー。

3

米国配列では '3' キー。

4

米国配列では '4' キー。

5

米国配列では '5' キー。

6

米国配列では '6' キー。

7

米国配列では '7' キー。

8

米国配列では '8' キー。

9

米国配列では '9' キー。

0

米国配列では '0' キー。

return

米国配列では 'return' / 'enter' キー。

escape

米国配列では 'escape' キー。

backspace

米国配列では 'backspace' キー。

tab

米国配列では 'tab' キー。

space

米国配列では spacebar

-

米国配列では 加算 キー。

=

米国配列では 減算 キー。

[

米国配列では 左角括弧 キー。

]

米国配列では 右角括弧 キー。

\

米国配列では バックスラッシュ キー。

nonus#

非米国圏におけるハイフンのスキャンコード。

;

米国配列では セミコロン キー。

'

米国配列では アポストロフィー キー。

`

米国配列では バックチック・重アクセント キー。

,

米国配列では カンマ キー。

.

米国配列では ピリオド キー。

/

米国配列では 前方スラッシュ キー。

capslock

米国配列では capslock キー。

f1

米国配列では F1 キー。

f2

米国配列では F2 キー。

f3

米国配列では F3 キー。

f4

米国配列では F4 キー。

f5

米国配列では F5 キー。

f6

米国配列では F6 キー。

f7

米国配列では F7 キー。

f8

米国配列では F8 キー。

f9

米国配列では F9 キー。

f10

米国配列では F10 キー。

f11

米国配列では F11 キー。

f12

米国配列では F12 キー。

f13

米国配列では F13 キー。

f14

米国配列では F14 キー。

f15

米国配列では F15 キー。

f16

米国配列では F16 キー。

f17

米国配列では F17 キー。

f18

米国配列では F18 キー。

f19

米国配列では F19 キー。

f20

米国配列では F20 キー。

f21

米国配列では F21 キー。

f22

米国配列では F22 キー。

f23

米国配列では F23 キー。

f24

米国配列では F24 キー。

lctrl

米国配列では左 control キー。

lshift

米国配列では 左 shift キー。

lalt

米国配列では左 alt / option キー。

lgui

米国配列では左 GUI (command / windows / super) キー。

rctrl

米国配列では右 control キー。

rshift

米国配列では右 shift キー。

ralt

米国配列では右 alt / option キー。

rgui

米国配列では右 GUI (command / windows / super) キー。

printscreen

米国配列では printscreen キー。

scrolllock

米国配列では scroll-lock キー。

pause

米国配列では pause キー。

insert

米国配列では insert キー。

home

米国配列では home キー。

numlock

米国配列では numlock / clear キー。

pageup

米国配列では page-up キー。

delete

米国配列では 前方 delete キー。

end

米国配列では end キー。

pagedown

米国配列では page-down キー。

right

米国配列では ← キー。

left

米国配列では → キー。

down

米国配列では ↓ キー。

up

米国配列では ↑ キー。

nonusbackslash

非米国圏におけるバックスラッシュのスキャンコード。

application

米国配列ではアプリケーションキー。 Windows コンテキストメニュー、修飾キー。

execute

米国配列では '実行' キー。

help

米国配列では 'ヘルプ' キー。

menu

米国配列では 'メニュー' キー。

select

米国配列では '選択' キー。

stop

米国配列では '停止' キー。

again

米国配列では 'やり直し' キー。

undo

米国配列では '元に戻す' キー。

cut

米国配列では '切り取り' キー。

copy

米国配列では 'コピー' キー。

paste

米国配列では '貼り付け' キー。

find

米国配列では '検索' キー。

kp/

米国配列ではテンキーの 前方スラッシュ キー。

kp*

米国配列ではテンキーの '*' キー。

kp-

米国配列ではテンキーの 減算 キー。

kp+

米国配列ではテンキーの 加算 キー。

kp=

米国配列ではテンキーの 等号 キー。

kpenter

米国配列ではテンキーの enter キー。

kp1

米国配列ではテンキーの '1' キー。

kp2

米国配列ではテンキーの '2' キー。

kp3

米国配列ではテンキーの '3' キー。

kp4

米国配列ではテンキーの '4' キー。

kp5

米国配列ではテンキーの '5' キー。

kp6

米国配列ではテンキーの '6' キー。

kp7

米国配列ではテンキーの '7' キー。

kp8

米国配列ではテンキーの '8' キー。

kp9

米国配列ではテンキーの '9' キー。

kp0

米国配列ではテンキーの '0' キー。

kp.

米国配列ではテンキーの ピリオド キー。

international1

米国配列では1番目の国際化キー。アジア圏のキーボードで使用されています。

international2

米国配列では2番目の国際化キー。

international3

米国配列では3番目の国際化キー。円記号。

international4

米国配列では4番目の国際化キー。

international5

米国配列では5番目の国際化キー。

international6

米国配列では6番目の国際化キー。

international7

米国配列では7番目の国際化キー。

international8

米国配列では8番目の国際化キー。

international9

米国配列では9番目の国際化キー。

lang1

「ハングル・英語相互切り替え」のスキャンコード。

lang2

「漢字変換」のスキャンコード。

lang3

「カタカナ」のスキャンコード。

lang4

「ひらがな」のスキャンコード

lang5

「全角・半角」のスキャンコード

mute

米国配列では消音キー。

volumeup

米国配列では音量大キー。

volumedown

米国配列では音量小キー。

audionext

米国配列では音楽次曲キー。

audioprev

米国配列では音楽前キー。

audiostop

米国配列では音楽停止キー。

audioplay

米国配列では音楽再生キー。

audiomute

米国配列では音楽消音キー。

mediaselect

米国配列ではメディアの選択キー。

www

米国配列では 'WWW' キー。

mail

米国配列ではメールキー。

calculator

米国配列では電卓キー。

computer

米国配列では 'コンピューター' キー。

acsearch

米国配列ではアプリケーションの検索キー。

achome

米国配列ではアプリケーションのホームキー。

acback

米国配列ではアプリケーションの戻る キー。

acforward

米国配列ではアプリケーションの進むキー。

acstop

米国配列ではアプリケーションの停止キー。

acrefresh

米国配列ではアプリケーションの更新キー。

acbookmarks

米国配列ではアプリケーションのブックマークキー。

power

米国配列ではシステム電源のスキャンコード。

brightnessdown

米国配列では画面暗のスキャンコード。

brightnessup

米国配列では画面明のスキャンコード。

displayswitch

米国配列では画面切り替えのスキャンコード。

kbdillumtoggle

米国配列ではキーボード昭明での点灯・消灯を相互切り替えするスキャンコード。

kbdillumdown

米国配列ではキーボード昭明を暗くするスキャンコード。

kbdillumup

米国配列ではキーボード昭明を明るくするスキャンコード。

eject

ディスク排出のスキャンコード。

sleep

システム休止のスキャンコード。

alterase

米国配列では alt-erase キー。

sysreq

米国配列では sysreq キー。

cancel

米国配列では 'cancel' キー。

clear

米国配列では 'clear' キー。

prior

米国配列では 'prior' キー。

return2

米国配列では 'return2' キー。

separator

米国配列では 'separator' キー。

out

米国配列では 'out' キー。

oper

米国配列では 'oper' キー。

clearagain

米国配列では 'clearagain' キー。

crsel

米国配列では 'crsel' キー。

exsel

米国配列では 'exsel' キー。

kp00

米国配列ではテンキーの 00 キー。

kp000

米国配列ではテンキーの 000 キー。

thsousandsseparator

米国配列では桁区切り文字キー。

decimalseparator

米国配列では小数点キー。

currencyunit

米国配列では通貨単位キー。

currencysubunit

米国配列では通貨副単位キー。

app1

'app1' のスキャンコード。

app2

'app2' のスキャンコード。

unknown

不明なキー

love.math

Types

Functions

Enums

love.math.compress

特定の圧縮アルゴリズムを使用して文字列またはデータを圧縮します。

compressedData = love.math.compress( rawstring, format, level )

compressedDataCompressedData圧縮版の文字列を有する新規 Data オブジェクト。
rawstringstring圧縮対象の生文字列 (無圧縮)。
format ("lz4")CompressedDataFormat文字列の圧縮時に使用する形式。
level (-1)number0 から 9 までの使用する圧縮率。 -1 は標準の圧縮率を表します。この引数の意味は使用される圧縮形式に依存することを表します。

compressedData = love.math.compress( data, format, level )

compressedDataCompressedData圧縮版の生データを有する新規 Data オブジェクト。
dataData圧縮対象の生データ (無圧縮) を有する Data オブジェクト。
format ("lz4")CompressedDataFormatデータの圧縮時に使用する形式。
level (-1)number0 から 9 までの使用する圧縮率。 -1 は標準の圧縮率を表します。この引数の意味は使用される圧縮形式に依存することを表します。

love.math.decompress

CompressedData または以前に圧縮された文字列あるいは Data オブジェクトを展開します。

rawstring = love.math.decompress( compressedData )

rawstringstring展開された生データを有する文字列。
compressedDataCompressedData展開対象の圧縮されたデータ。

rawstring = love.math.decompress( compressedString, format )

rawstringstring展開された生データを有する文字列。
compressedStringstring以前 love.math.compress により圧縮されたデータを有する文字列。
formatCompressedDataFormat与えられた文字列を圧縮するために使用された形式。

rawstring = love.math.decompress( data, format )

rawstringstring展開された生データを有する文字列。
dataData以前 love.math.compress により圧縮されたデータを有する Data オブジェクト。
formatCompressedDataFormat与えられたデータを圧縮するために使用された形式。

love.math.gammaToLinear

ガンマ空間 (sRGB) から線形空間 (RGB) へ色変換します。これはガンマ補正表示を行う場合、および LÖVE が線形 RGB を自動変換処理しない場合に計算をする必要がある場合に有用です。

ガンマ補正表示に関する詳細は ここ、 ここ、さらにここ にあります。

lr, lg, lb = love.math.gammaToLinear( r, g, b )

lrnumber線形 RGB 空間へ変換された色の赤チャンネル。
lgnumber線形 RGB 空間へ変換された色の緑チャンネル。
lbnumber線形 RGB 空間へ変換された色の青チャンネル。
rnumber変換したい sRGB 色の赤チャンネル。
gnumber変換したい sRGB 色の緑チャンネル。
bnumber変換したい sRGB 色の青チャンネル。

lr, lg, lb = love.math.gammaToLinear( color )

lrnumber線形 RGB 空間へ変換された色の赤チャンネル。
lgnumber線形 RGB 空間へ変換された色の緑チャンネル。
lbnumber線形 RGB 空間へ変換された色の青チャンネル。
colortable変換したい sRGB 色における赤、青、および青チャンネルの配列。

lc = love.math.gammaToLinear( c )

lcnumber線形 RGB 空間における色チャンネルの値。
cnumber変換したい sRGB 空間における色チャンネルの値。

love.math.getRandomSeed

乱数生成器の種を取得します。

種は Lua の全ての数値に対してdouble を使用することにより二つの数値へ分割されます ― double において 2 の 53 乗以上になる整数値を正確に表現できませんが、種であれば 2 の 64 乗まで整数値の表現ができます。

low, high = love.math.getRandomSeed()

lownumber乱数生成器の 64 bit 種値のうち下位 32 bit の整数表現。
highnumber乱数生成器の 64 bit 種値のうち上位 32 bit の整数表現。

love.math.getRandomState

Gets the current state of the random number generator. This returns an opaque implementation-dependent string which is only useful for later use with RandomGenerator:setState.

This is different from RandomGenerator:getSeed in that getState gets the RandomGenerator's current state, whereas getSeed gets the previously set seed number.

The value of the state string does not depend on the current operating system.

state = love.math.getRandomState()

statestringThe current state of the RandomGenerator object, represented as a string.

love.math.isConvex

凸面の多角形かどうか確認します。

love.physics での PolygonShapes, Mesh の一部形式、 love.graphics.polygon にて描画された多角形は必ず単一の凸面の多角形になります。

convex = love.math.isConvex( vertices )

convexboolean凸面の多角形かどうか。
verticestable多角形の頂点として <nowiki>{x1, y1, x2, y2, x3, y3, ...}</nowiki> の形式のテーブル。

convex = love.math.isConvex( x1, y1, x2, y2, x3, y3, ... )

convexbooleanWhether the given polygon is convex.
x1numberThe position of the first vertex of the polygon on the x-axis.
y1numberThe position of the first vertex of the polygon on the y-axis.
x2numberThe position of the second vertex of the polygon on the x-axis.
y2numberThe position of the second vertex of the polygon on the y-axis.
x3numberThe position of the third vertex of the polygon on the x-axis.
y3numberThe position of the third vertex of the polygon on the y-axis.
...numberAdditional vertices.

love.math.linearToGamma

線形空間 (RGB) からガンマ空間 (sRGB) へ色変換します。これは線形 RGB 色の値を画像へ格納する場合に有用です。理由として暗色に対して線形 RGB 色空間は sRGB より低精度であるため、結果として描画時に気付くほどの色帯域となるからです。

一般に、画面上で見える物に基づいて選択された色が既にガンマ空間に当てはまるならば、倍数変換をしないでください。数学的なものを使用して計算された色において大抵は線形 RGB 空間に当てはまります。

ガンマ補正表示に関する詳細は ここ、 ここ、さらにここ にあります。

cr, cg, cb = love.math.linearToGamma( lr, lg, lb )

crnumberガンマ sRGB 空間へ変換された色の赤チャンネル。
cgnumberガンマ sRGB 空間へ変換された色の緑チャンネル。
cbnumberガンマ sRGB 空間へ変換された色の青チャンネル。
lrnumber変換したい線形 RGB 色の赤チャンネル。
lgnumber変換したい線形 RGB 色の緑チャンネル。
lbnumber変換したい線形 RGB 色の青チャンネル。

cr, cg, cb = love.math.linearToGamma( color )

crnumberガンマ sRGB 空間へ変換された色の赤チャンネル。
cgnumberガンマ sRGB 空間へ変換された色の緑チャンネル。
cbnumberガンマ sRGB 空間へ変換された色の青チャンネル。
colortable変換したい RGB 色の赤、青、および青チャンネルの配列。

c = love.math.linearToGamma( lc )

cnumberガンマ sRGB 空間における色チャンネルの値。
lcnumber変換したい線形 RGB 空間における色チャンネルの値。

love.math.newBezierCurve

BezierCurve オブジェクトの新規作成。

制御用多角形にある頂点の個数は曲線の次数を決定します。例えば、頂点が3つであれば二次式(次数2)のベジェ曲線の定義を行い、頂点が4つであれば三次式(次数3)などのベジェ曲線の定義を行います。

curve = love.math.newBezierCurve( vertices )

curveBezierCurveベジェ曲線オブジェクト。
verticestable制御用多角形の頂点として <nowiki>{x1, y1, x2, y2, x3, y3, ...}</nowiki> 形式のテーブル。

curve = love.math.newBezierCurve( x1, y1, x2, y2, x3, y3, ... )

curveBezierCurveA Bézier curve object.
x1numberThe position of the first vertex of the control polygon on the x-axis.
y1numberThe position of the first vertex of the control polygon on the y-axis.
x2numberThe position of the second vertex of the control polygon on the x-axis.
y2numberThe position of the second vertex of the control polygon on the y-axis.
x3numberThe position of the third vertex of the control polygon on the x-axis.
y3numberThe position of the third vertex of the control polygon on the y-axis.
...numberAdditional vertices.

love.math.newRandomGenerator

他の RandomGenerator オブジェクトおよび乱数の関数とは完全に独立した RandomGenerator オブジェクトを新規作成します。

rng = love.math.newRandomGenerator()

rngRandomGenerator新規の乱数生成器オブジェクト。

rng = love.math.newRandomGenerator( seed )

rngRandomGenerator新規の乱数生成器オブジェクト。
seednumberこのオブジェクトで使用する初期の種の数値。

rng = love.math.newRandomGenerator( low, high )

rngRandomGenerator新規の乱数生成器オブジェクト。
lownumberこのオブジェクトで使用する下位 32 bit の種の数値。
highnumberこのオブジェクトで使用する上位 32 bit の種の数値。

love.math.noise

1~4次元によるシンプレックスまたはパーリンノイズの値を生成します。返値は同一引数を与えられても、常に同じです。

シンプレックスノイズはパーリンノイズと密接な関係があります。これは手続き内容の生成に対して幅広く使用されます。

こちらにパーリンおよびシンプレックスノイズに関する詳細な議論は多数のウェブ・ページ にあります。

value = love.math.noise( x )

Generates Simplex noise from 1 dimension.

valuenumber1 の範囲におけるノイズ値。
xnumberノイズ値の生成に使用する数値。

value = love.math.noise( x, y )

Generates Simplex noise from 2 dimensions.

valuenumber1 の範囲におけるノイズ値。
xnumber第一の値としてノイズ値を生成するために使用される2次元ベクトル。
ynumber第二の値としてノイズ値を生成するために使用される2次元ベクトル。

value = love.math.noise( x, y, z )

Generates Perlin noise (Simplex noise in version 0.9.2 and older) from 3 dimensions.

valuenumber1 の範囲におけるノイズ値。
xnumber第一の値としてノイズ値を生成するために使用される3次元ベクトル。
ynumber第二の値としてノイズ値を生成するために使用される3次元ベクトル。
znumber第三の値としてノイズ値を生成するために使用される3次元ベクトル。

value = love.math.noise( x, y, z, w )

Generates Perlin noise (Simplex noise in version 0.9.2 and older) from 4 dimensions.

valuenumber1 の範囲におけるノイズ値。
xnumber第一の値としてノイズ値を生成するために使用される4次元ベクトル。
ynumber第二の値としてノイズ値を生成するために使用される4次元ベクトル。
znumber第三の値としてノイズ値を生成するために使用される4次元ベクトル。
wnumber第四の値としてノイズ値を生成するために使用される4次元ベクトル。

love.math.random

プラットフォームに依存しない方法で疑似乱数を生成します。

number = love.math.random()

Get uniformly distributed pseudo-random real number within [0, 1].

numbernumber疑似乱数。

number = love.math.random( max )

Get a uniformly distributed pseudo-random integer within [1, max].

numbernumber疑似乱数の整数。
maxnumber返すことができる最大値。

number = love.math.random( min, max )

Get uniformly distributed pseudo-random integer within [min, max].

numbernumber疑似乱数の整数。
minnumber返すことができる最小値。
maxnumber返すことができる最大値。

love.math.randomNormal

正規分布による疑似乱数を取得します。

number = love.math.randomNormal( stddev, mean )

numbernumber指定された平均および偏差 (stddev)² により返された正規分布の乱数。
stddev (1)number分布の標準偏差。
mean (0)number平均分布値。

love.math.setRandomSeed

指定された整数値を使用して乱数生成器の種を設定します。

love.math.setRandomSeed( seed )

seednumber無作為に抽出する種として整数の数値。必ず 2^53 - 1 の範囲内にしてください。

love.math.setRandomSeed( low, high )

lownumber下位 32 bit の種の数値。必ず 2^32 - 1 の範囲内にしてください。
highnumber上位 32 bit の種の数値。必ず 2^32 - 1 の範囲内にしてください。

love.math.setRandomState

Gets the current state of the random number generator. This returns an opaque implementation-dependent string which is only useful for later use with RandomGenerator:setState.

This is different from RandomGenerator:getSeed in that getState gets the RandomGenerator's current state, whereas getSeed gets the previously set seed number.

The value of the state string does not depend on the current operating system.

love.math.setRandomState( state )

statestringThe current state of the RandomGenerator object, represented as a string.

love.math.triangulate

単一の凸面または凹面の多角形を三角形へ分解します。

triangles = love.math.triangulate( polygon )

trianglestable多角形として構成されていた三角形の一覧であり、形式は <nowiki>{{x1, y1, x2, y2, x3, y3}, {x1, y1, x2, y2, x3, y3}, ...}</nowiki> です。
polygontable三角形に分けたい多角形。それ自体と交差してはいけません。

triangles = love.math.triangulate( x1, y1, x2, y2, x3, y3, ... )

trianglestableList of triangles the polygon is composed of, in the form of {{x1, y1, x2, y2, x3, y3}, {x1, y1, x2, y2, x3, y3}, ...}.
x1numberThe position of the first vertex of the polygon on the x-axis.
y1numberThe position of the first vertex of the polygon on the y-axis.
x2numberThe position of the second vertex of the polygon on the x-axis.
y2numberThe position of the second vertex of the polygon on the y-axis.
x3numberThe position of the third vertex of the polygon on the x-axis.
y3numberThe position of the third vertex of the polygon on the y-axis.
...numberAdditional vertices.

CompressedDataFormat

lz4

LZ4 法による圧縮形式。圧縮、および展開は非常に高速ですが、圧縮率は最悪です。圧縮率 9 が指定された時は LZ4-HC 法を使用します。こちらに性能測定結果の一部があります。

zlib

zlib 形式は小型の 1 bit ヘッダデータを有する DEFLATE (デフレート) 法により圧縮されたデータです。圧縮は幾分遅めであり、展開は適度に早く、そして圧縮率はまともです。

gzip

gzip 形式は zlib より少し大きいヘッダデータを有する DEFLATE 法により圧縮されたデータです。 DEFLATE 法を使用しているため、 zlib 形式と同じ圧縮特性があります。

BezierCurve

ベジェ曲線オブジェクトは任意の次数でベジェ曲線の評価および表示を行います。ベジェ曲線についての詳細な情報は Wikipedia にあるこの素晴らしい記事を調べてみてください。

Constructors

Functions

Supertypes

BezierCurve:evaluate

Evaluate Bézier curve at parameter t. The parameter must be between 0 and 1 (inclusive).

This function can be used to move objects along paths or tween parameters. However it should not be used to render the curve, see BezierCurve:render for that purpose.

x, y = BezierCurve:evaluate( t )

xnumberx coordinate of the curve at parameter t.
ynumbery coordinate of the curve at parameter t.
tnumberWhere to evaluate the curve.

BezierCurve:getControlPoint

第 i 番目における制御点の座標を取得します。索引は 1 から始まります。

x, y = BezierCurve:getControlPoint( i )

xnumberx 軸からの制御点の位置。
ynumbery 軸からの制御点の位置。
inumber制御点の索引

BezierCurve:getControlPointCount

ベジェ曲線にある制御点の個数を取得します。

count = BezierCurve:getControlPointCount()

countnumberベジェ曲線にある制御点の個数。

BezierCurve:getDegree

ベジェ曲線の次数(階数)を取得します。次数は制御点の個数 - 1 と等価です。

degree = BezierCurve:getDegree()

degreenumberベジェ曲線の次数(階数)。

BezierCurve:getDerivative

ベジェ曲線の派生物を取得します。

この関数は移動の方向として曲線に沿って回転移動するスプライトおよび、ある引数 t に対する曲線の垂直方向を計算するために使用できます。

derivative = BezierCurve:getDerivative()

derivativeBezierCurve曲線の派生物。

BezierCurve:getSegment

現在の BezierCurve で指定された線分に対応する BezierCurve を取得します。

curve = BezierCurve:getSegment( startpoint, endpoint )

curveBezierCurve指定された線分に対応する BezierCurve です。
startpointnumber曲線からの始点。 0 から 1 までの範囲内にする必要があります。
endpointnumber線分の終点。 0 から 1 までの範囲内にする必要があります。

BezierCurve:insertControlPoint

第 i 番目の制御点へ制御点を新規挿入します。既存の制御点は i から前方へ 1 つ移動します。負数の索引は丸め込みます: -1 は最後の制御点、 -2 は最後から一つ前、など。

BezierCurve:insertControlPoint( x, y, i )

xnumberx 軸からの制御点の位置。
ynumbery 軸からの制御点の位置。
i (-1)number制御点の索引。

BezierCurve:removeControlPoint

指定された制御点を削除します。

BezierCurve:removeControlPoint( index )

indexnumber削除を行う制御点の索引。

BezierCurve:render

love.graphics.line で使用される座標の一覧を取得します。

この関数は再帰的に再分割を行いベジェ曲線を標本化します。再帰の深さは depth 引数を使用して制御できます。

引数に与えられた曲線ついての位置を知ることに興味があるならば、 BezierCurve:evaluate を使用してください。

coordinates = BezierCurve:render( depth )

coordinatestable曲線状にある点における対の x, y 座標の一覧。
depth (5)number再起的に再分割された階数。

BezierCurve:renderSegment

love.graphics.line で使用するために、特定の曲線部分に関する座標の一覧を取得します。

この関数は再帰的細分を使用してベジェ曲線の標本を取得します。 引数 depth を使用して再帰の深度を制御することができます。

与えられた引数に関する曲線位置を知る必要があるだけならば、 BezierCurve:evaluate を使用してください。

coordinates = BezierCurve:renderSegment( startpoint, endpoint, depth )

coordinatestable指定された曲線部分に関する地点における x, y 座標対の一覧。
startpointnumber曲線からの始点。 0 から 1 までの範囲内にする必要があります。
endpointnumber表示を行う線分の終点。 0 から 1 までの範囲内にする必要があります。
depth (5)number再帰的細分刻み幅の数。

BezierCurve:rotate

角度によりベジェ曲線を回転します。

BezierCurve:rotate( angle, ox, oy )

anglenumber弧度による回転角度。
ox (0)number回転の中心点における X 軸。
oy (0)number回転の中心点における Y 軸。

BezierCurve:scale

係数によりベジェ曲線の尺度を変更します。

BezierCurve:scale( s, ox, oy )

snumber尺度変更係数。
ox (0)number尺度変更における中心の X 座標。
oy (0)number尺度変更における中心の Y 座標。

BezierCurve:setControlPoint

第 i 番目における制御点の座標を設定します。索引は 1 から始まります。

BezierCurve:setControlPoint( i, ox, oy )

inumber制御点の索引。
oxnumberx 軸からの制御点の位置。
oynumbery 軸からの制御点の位置。

BezierCurve:translate

ベジェ曲線を支距により移動します。

BezierCurve:translate( dx, dy )

dxnumberx 軸からの支距。
dynumbery 軸からの支距。

CompressedData

特定のアルゴリズムを使用して圧縮されたバイトデータを表します。

love.math.decompress はデータの展開に使用することができます。

Constructors

Functions

Supertypes

CompressedData:getFormat

CompressedData の圧縮形式を取得します。

format = CompressedData:getFormat()

formatCompressedDataFormatCompressedData の圧縮形式です。

RandomGenerator

単独で乱数の状態を保持している乱数生成オブジェクトです。

Constructors

Functions

Supertypes

RandomGenerator:getSeed

乱数生成器オブジェクトの種を取得します。

種は Lua の全ての数値に対して倍精度浮動小数点数を使用することにより二つの数値へ分割されます ― 倍数において 2 の 53 乗以上の整数値を正確に表現できませんが、種値の範囲では 0, 2 の 64 乗 -1 まで整数値の表現になります。

low, high = RandomGenerator:getSeed()

lownumberRandomGenerator の 64 bit 種値のうち下位 32 bit の整数表現。
highnumberRandomGenerator の 64 bit 種値のうち上位 32 bit の整数表現。

RandomGenerator:getState

乱数生成器の現在状態を取得します。これは以後に使用する RandomGenerator:setState でのみ有用であり不透過な実装依存の文字列を返します。

'''RandomGenerator:getState''' は RandomGenerator の現在状態を取得しますが RandomGenerator:getSeed とは動作が異なり、 RandomGenerator:getSeed では以前に設定された種の数値を取得します。

state = RandomGenerator:getState()

statestring文字列で表現した RandomGenerator オブジェクトの現在状態。

RandomGenerator:random

プラットフォームに依存しない方法で疑似乱数を生成します。

number = RandomGenerator:random()

Get uniformly distributed pseudo-random number within [0, 1].

numbernumber疑似乱数。

number = RandomGenerator:random( max )

Get uniformly distributed pseudo-random integer number within [1, max].

numbernumber疑似乱数。
maxnumber返すことができる最大値。

number = RandomGenerator:random( min, max )

Get uniformly distributed pseudo-random integer number within [min, max].

numbernumber疑似乱数。
minnumber返すことができる最小値。
maxnumber返すことができる最大値。

RandomGenerator:randomNormal

正規分布による疑似乱数を取得します。

number = RandomGenerator:randomNormal( stddev, mean )

numbernumber指定された平均および偏差 (stddev)² により返された正規分布の乱数。
stddev (1)number分布の標準偏差。
mean (0)number平均分布値。

RandomGenerator:setSeed

指定された整数値を使用して乱数生成器の種を設定します。

RandomGenerator:setSeed( seed )

seednumber無作為に抽出する種として整数の数値。必ず 2^53 の範囲内にして下さい。

RandomGenerator:setSeed( low, high )

lownumber下位 32 bit の種の数値。必ず 2^32 - 1 の範囲内にして下さい。
high (0)number上位 32 bit の種の数値。必ず 2^32 - 1 の範囲内にして下さい。

RandomGenerator:setState

乱数生成器の現在状態を設定します。この関数で引数として使用される値は不透過な実装依存の文字列であり以前の呼び出しから RandomGenerator:getState までのみ発生します。

'''RandomGenerator:setState''' は RandomGenerator の現在の実装依存状態を直接設定しますが RandomGenerator:setSeed とは動作が異なり、 RandomGenerator:setSeed では新しい種の数値を与えます。

RandomGenerator:setState( state )

statestring文字列で表現した RandomGenerator オブジェクトの新規状態。これは以前の呼び出しから RandomGenerator:getState まで発生します。

love.mouse

Types

Functions

Enums

love.mouse.getCursor

現在のカーソルを取得します。

cursor = love.mouse.getCursor()

cursorCursor現在のカーソル、または nil ならばカーソルは設定されていません。

love.mouse.getPosition

マウスの現在座標を返します。

x, y = love.mouse.getPosition()

xnumberマウスの x-軸座標。
ynumberマウスの y-軸座標。

love.mouse.getRelativeMode

マウスに対する相対方式が有効かどうかを取得します。

相対方式が有効な場合は、カーソルは非表示となりマウスによる移動は行われませんが、相対的なマウスの移動は love.mousemoved イベントを経由して常に生成されます。これはマウスで画面端で身動きが取れなくなるカーソルの移動制限を無くすことであらゆる方向に動かせます。

相対的なマウスの移動イベントが生成される場合であっても、相対方式を有効にしている場合は更新されたマウスの位置は報告されません。

enabled = love.mouse.getRelativeMode()

enabledbooleantrue ならば相対方式は有効であり、 false ならば無効です。

love.mouse.getSystemCursor

システムで提供されているハードウェアカーソルを Cursor オブジェクトとして取得します。

ハードウェアカーソルはフレームレート非依存であり、オペレーティングシステムの通常のシステムカーソルと同様の動作をします。マウスの現在座標に画像を描画するのとは異なり、低フレームレートであろうと、マウスの移動による遅延の間にハードウェアカーソルが表示されなくても現在座標は更新されます。

cursor = love.mouse.getSystemCursor( ctype )

cursorCursorCursor オブジェクトへ取得したシステムカーソルを返します。
ctypeCursorType取得を行うシステムカーソルの種類。

love.mouse.getX

マウスの現在の X 位置を返します。

x = love.mouse.getX()

xnumberマウスの x-軸 の新しい位置が返されます。

love.mouse.getY

マウスの現在の Y 位置を返します。

y = love.mouse.getY()

ynumberマウスの Y-軸 の新しい位置が返されます。

love.mouse.hasCursor

カーソルの機能性に対応しているかどうかを取得します。

非対応の場合は、 love.mouse.newCursor および love.mouse.getSystemCursorを呼び出すとエラーが発生します。カーソルは携帯機器では非対応です。

hascursor = love.mouse.hasCursor()

hascursorbooleanシステムはカーソルの機能性に対応しているかどうか。

love.mouse.isDown

特定のマウスボタンが押されたかどうか検出します。

この関数はマウスホイールのスクロールを検出しません。マウスホイールを検出したいときは love.wheelmoved (または version love.mousepressed) コールバックを必ず使用してください。

down = love.mouse.isDown( button, ... )

downbooleanTrue ならば指定されたボタンは押されています。
buttonnumber検出したいボタンの索引。 1 は第一マウスボタンであり、 2 は第二マウスボタンおよび 3 は中央のボタンです。追加的なボタンはマウスの機種に依存します。
...number検出したい追加ボタンの番号。

love.mouse.isGrabbed

マウスが捕獲されているか確認します。

grabbed = love.mouse.isGrabbed()

grabbedbooleanTrue ならばカーソルは捕獲されており、それ以外は false です。

love.mouse.isVisible

カーソルが表示されているか確認します。

visible = love.mouse.isVisible()

visiblebooleanTrue ならばカーソルは表示されており、 false ならば、カーソルは非表示です。

love.mouse.newCursor

ハードウェア Cursor オブジェクトを画像ファイルまたは ImageData から新規作成します。

ハードウェアカーソルはフレームレート非依存であり、オペレーティングシステムの通常のシステムカーソルと同様の動作をします。マウスの現在座標に画像を描画するのとは異なり、低フレームレートであろうと、マウスの移動による遅延の間にハードウェアカーソルが表示されなくても現在座標は更新されます。

ホットスポットはどこをクリックしているのかマウスカーソルが何処の座標にあるのかをオペレーティングシステムが判断するための使用する地点の事です。例えば、通常は一般の矢印ポインタにおいて画像の左上にホットスポットがありますが、領域選択カーソルにおいては中央にあります。

cursor = love.mouse.newCursor( imageData, hotx, hoty )

cursorCursor新規 Cursor オブジェクト。
imageDataImageDataImageData を新規カーソルとして使用します。
hotx (0)numberカーソルのホットスポットとして ImageData の X-座標を指定します。
hoty (0)numberカーソルのホットスポットとして ImageData の Y-座標を指定します。

cursor = love.mouse.newCursor( filepath, hotx, hoty )

cursorCursor新規 Cursor オブジェクト。
filepathstringパスで指定された画像を新規カーソルとして使用します。
hotx (0)numberカーソルのホットスポットとして画像の X-座標を指定します。
hoty (0)numberカーソルのホットスポットとして画像の Y-座標を指定します。

cursor = love.mouse.newCursor( fileData, hotx, hoty )

cursorCursor新規 Cursor オブジェクト。
fileDataFileDataData 表現を新規カーソルとして使用します。
hotx (0)numberカーソルのホットスポットとして画像の X-座標を指定します。
hoty (0)numberカーソルのホットスポットとして画像の Y-座標を指定します。

love.mouse.setCursor

現在のマウスカーソルを設定します。

love.mouse.setCursor()

love.mouse.setCursor( cursor )

cursorCursor現在のマウスカーソルとして使用する Cursor オブジェクト を指定します。

love.mouse.setGrabbed

マウスを捕獲してからウィンドウ内に閉じこめて移動制限をします。

love.mouse.setGrabbed( grab )

grabbooleanTrue ならばマウスの移動制限を行い、 false ならばウィンドウ内から解放します。

love.mouse.setPosition

マウスの現在位置を設定します。非整数値は切り捨てられます。

love.mouse.setPosition( x, y )

xnumberマウスの x-軸の新しい位置を指定します。
ynumberマウスの y-軸の新しい位置を指定します。

love.mouse.setRelativeMode

マウスに対する相対方式を有効にするかどうかを設定します。

相対方式を有効にした時は、カーソルは非表示となりマウスによる移動は行われませんが、相対的なマウスの移動は love.mousemoved イベントを経由して常に生成されます。画面の端で身動きが取れないカーソルの範囲を超えた任意の方向へマウスの移動制限を無くします。

相対的なマウスの移動イベント生成される場合であっても、相対方式を有効にしている場合は更新されたマウスの位置は報告されません。

love.mouse.setRelativeMode( enable )

enablebooleanTrue ならば相対方式を有効にして、 false ならば無効にします。

love.mouse.setVisible

現在のカーソルにおける可視性を設定します。

love.mouse.setVisible( visible )

visiblebooleanTrue ならばカーソルを表示、 false ならば、カーソルを非表示にします。

love.mouse.setX

マウスの現在の X 位置を設定します。

非整数値は切り捨てられます。

love.mouse.setX( x )

xnumberマウスの x-軸の新しい位置を指定します。

love.mouse.setY

マウスの現在の Y 位置を設定します。

非整数値は切り捨てられます。

love.mouse.setY( y )

ynumberマウスの y-軸の新しい位置を指定します。

CursorType

image

指定された画像をカーソルとして使用します。

arrow

矢印ポインタ。

ibeam

I-ビームは、通常は編集可能または選択可能なテキストへマウスを重ねたときに使用されます。

wait

処理待ちの画像

waitarrow

矢印ポインタ付きの小型処理待ちカーソル。

crosshair

領域選択シンボル。

sizenwse

左上および右下を指す2対の矢印。

sizenesw

右上および左下を指す2対の矢印。

sizewe

左右を指す2対の矢印。

sizens

上下を指す2対の矢印。

sizeall

左右上下を指す4点矢印。

no

斜線入りの円またはバツ印。

hand

手のシンボル。

Cursor

ハードウェアカーソルを意味します。

Constructors

Functions

Supertypes

Cursor:getType

カーソルの種類を取得します。

cursortype = Cursor:getType()

cursortypeCursorTypeカーソルの種類。

love.physics

Types

Functions

Enums

love.physics.getDistance

二つの取付具およびそれらの距離間で最も近接している二つの地点を返します。

distance, x1, y1, x2, y2 = love.physics.getDistance( fixture1, fixture2 )

distancenumber二地点間での距離。
x1number第一地点の x 座標。
y1number第一地点の y 座標。
x2number第二地点の x 座標。
y2number第二地点の y 座標。
fixture1Fixture第一取付具。
fixture2Fixture第二取付具。

love.physics.getMeter

メートル尺度係数を返します。

物理演算モジュールの全座標は本係数で除算され、グラフィックスの変換なしで画面へオブジェクトを直接描画するのに便利な方法で作成します。

形状は10倍以下の大きさで作成することが推奨されます。これは Box2D が 0.1 から 10 メートルまでの形状の大きさに上手く調整するために重要です。

scale = love.physics.getMeter()

scalenumber整数による尺度変更係数。

love.physics.newBody

物体の新規作成を行います。

物体は三種類あります。

* 静止物体 (static) は不動で、質量は無限であり、段階的境界に対して使用できます。

* 動的物体 (dynamic) は模擬において主役であり、全ての物体と衝突します。

* 運動物体 (kinematic) は力に対して反応せず動的な物体に対してのみ衝突します。

物体の質量は取付具が取り付けられるか取り外されたときに計算が行われますが、物体は Body:setMass または Body:resetMassData により何時でも変更することができます。

body = love.physics.newBody( world, x, y, type )

bodyBody新規の物体。
worldWorld物体に対して作成先の世界。
x (0)number物体の x 座標。
y (0)number物体の y 座標。
type ("static")BodyType物体の種類。

love.physics.newChainShape

ChainShape の新規作成。

shape = love.physics.newChainShape( loop, x1, y1, x2, y2, ... )

shapeChainShape新規の形状。
loopboolean鎖が第一地点の自閉線へ回帰するかどうか。
x1number第一地点の x 座標。
y1number第一地点の y 座標。
x2number第二地点の x 座標。
y2number第二地点の y 座標。
...number追加の地点座標。

shape = love.physics.newChainShape( loop, points )

shapeChainShape新規の形状。
loopboolean鎖が第一地点の自閉線へ回帰するかどうか。
pointstable{x1, y1, x2, y2, ...} 形式で、 ChainShape を構築するための地点一覧。

love.physics.newCircleShape

CircleShape の新規作成。

shape = love.physics.newCircleShape( radius )

shapeCircleShape新規形状。
radiusnumber円の半径。

shape = love.physics.newCircleShape( x, y, radius )

shapeCircleShape新規形状。
xnumber円の x 位置。
ynumber円の y 位置。
radiusnumber円の半径。

love.physics.newDistanceJoint

二つの物体間に対して DistanceJoint を作成します。

この関節は二つの物体において二地点間が一定距離になるよう強制します。これらの二地点は世界座標にて指定を行い、この関節の作成時に二つの物体は配置されていると見なされます。第一錨地点は第一物体および第二物体の接続を行い、地点により距離関節の長さを定義します。

File:physicsJointDistance.PNG

joint = love.physics.newDistanceJoint( body1, body2, x1, y1, x2, y2, collideConnected )

jointDistanceJoint新規の距離関節。
body1Body関節へ取り付ける第一物体。
body2Body関節へ取り付ける第二物体。
x1number第一錨地点の x 位置 (世界空間)。
y1number第一錨地点の y 位置 (世界空間)。
x2number第二錨地点の x 位置 (世界空間)。
y2number第二錨地点の y 位置 (世界空間)。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。

love.physics.newEdgeShape

EdgeShape の新規作成を行います。

shape = love.physics.newEdgeShape( x1, y1, x2, y2 )

shapeEdgeShape新規形状。
x1number第一地点の x 位置。
y1number第二地点の y 位置。
x2number第一地点の x 位置。
y2number第二地点の y 位置。

love.physics.newFixture

物体へ Fixture を作成して取り付けます。

取付具の作成時に、リファレンスとして保持されるのではなく Shape オブジェクトがコピーされることに注意してください。取付具が所有する Shape オブジェクトを取得するには Fixture:getShape を使用してください。

fixture = love.physics.newFixture( body, shape, density )

fixtureFixture新規の取付具。
bodyBody取付具を取り付ける物体。
shapeShape取付具の形状。
density (1)number取付具の密度。

love.physics.newFrictionJoint

二つの物体間における関節の摩擦を作成します。 FrictionJoint は物体に摩擦を適用します。

joint = love.physics.newFrictionJoint( body1, body2, x, y, collideConnected )

jointFrictionJoint新規 FrictionJoint です。
body1Body関節に取り付ける第一の物体。
body2Body関節に取り付ける第二の物体。
xnumber錨地点の x 位置。
ynumber錨地点の y 位置。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。

love.physics.newGearJoint

二つの関節を接続するために GearJoint を作成します。

伝動装置に対する二つの関節として必ず直動または回転関節のいずれかのみ接続してください。この関節を使用するには、関節で使用する各自の物体を基礎へ接続するのと第一物体に基礎があることが必要です。物体および関節を破棄する場合は、伝動装置の関節を破棄する前に他の関節が破棄されているか必ず確認してください。

伝動装置の関節には比率があり接続された関節において互いに関連する角度または距離の値により比率が決定されます。 coordinate1 + ratio * coordinate2 の数式は伝動装置の関節が作成される場合に設定されるため常に定数値になります。

joint = love.physics.newGearJoint( joint1, joint2, ratio, collideConnected )

jointGearJoint新規の伝動装置の関節。
joint1Joint伝動装置の関節へ接続する第一関節。
joint2Joint伝動装置の関節へ接続する第二関節。
ratio (1)number伝動装置における比率。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。

love.physics.newMotorJoint

相対運動を制御するために二つの物体間に関節を作成します。

対象の支距に到達するために適用される発動機の最大力量および力矩と同様に、 MotorJoint 作成時に位置および回転支距を同時指定できます。

joint = love.physics.newMotorJoint( body1, body2, correctionFactor, collideConnected )

jointMotorJoint新規の MotorJoint です。
body1Body関節へ取り付ける第一物体。
body2Body関節へ取り付ける第二物体。
correctionFactor (0.3)number1 の範囲内による関節の初期位置補正係数です。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。

love.physics.newMouseJoint

物体およびマウス間の関節を作成します。

この関節は世界に存在する固定地点へ物体を接続します。マウスに追従させるために、固定地点は時間刻みごとに必ず更新されます(下記の用例)。

物体の位置を直接変更する代わりに MouseJoint を使用する利点は他の関節への衝突および反応が物理演算エンジンによって扱われることです。

joint = love.physics.newMouseJoint( body, x, y )

jointMouseJoint新規のマウス関節。
bodyBodyマウスに取り付ける物体。
xnumber接続地点の x 位置。
ynumber接続地点の y 位置。

love.physics.newPolygonShape

PolygonShape の新規作成。

この形状は八つ以上の頂点を保持でき、形状は必ず凸面形状になります。

shape = love.physics.newPolygonShape( x1, y1, x2, y2, ... )

shapePolygonShapeA new PolygonShape.
x1numberThe position of first point on the x-axis.
y1numberThe position of first point on the y-axis.
x2numberThe position of second point on the x-axis.
y2numberThe position of second point on the y-axis.
...numberYou can continue passing more point positions to create the PolygonShape.

shape = love.physics.newPolygonShape( vertices )

shapePolygonShape新規の PolygonShape です。
verticestable{x1, y1, x2, y2, x3, y3, ...} 形式で、多角形を構築するために使用する頂点の一覧。

love.physics.newPrismaticJoint

二つの物体間に対して PrismaticJoint を作成します。

直動関節は二つの物体へ互いに関連する指定された軸の移動を強制します。相対的な回転は使用できません。定義および操作は回転関節と似ていますが、角度および力矩に対して代わりに並進移動および力量が使用されます。

joint = love.physics.newPrismaticJoint( body1, body2, x1, y1, x2, y2, ax, ay, collideConnected, referenceAngle )

jointPrismaticJoint新規の直動関節。
body1Body直動関節へ接続する第一物体。
body2Body直動関節へ接続する第二物体。
x1number第一錨地点の x 座標。
y1number第一錨地点の y 座標。
x2number第二錨地点の x 座標。
y2number第二錨地点の y 座標。
axnumber軸単位ベクトルの x 座標。
aynumber軸単位ベクトルの y 座標。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。
referenceAngle (0)numberbody1 および body2 間においての弧度による基準角。

love.physics.newPulleyJoint

基礎と二つの物体を互いに接続するために PulleyJoint を作成します。

滑車関節は任意のブロック(滑車)とタックル(滑車装置、巻き上げ装置)がある滑車の模擬を行います。引数 ratio が異なる値であるならば、模擬を行う縄は他の側面より早く伸びます。滑車関節において模擬を行う縄の合計長は <tt>length1 + ratio * length2</tt> の定数であり、車輪関節の作成時に設定されます。

片側が完全に拡張される場合は滑車関節は予測不能の動作になります。各側面の到達可能な最大長を制限するために PulleyJoint:setMaxLengths メソッドの使用を推奨します。

joint = love.physics.newPulleyJoint( body1, body2, gx1, gy1, gx2, gy2, x1, y1, x2, y2, ratio, collideConnected )

jointPulleyJointThe new pulley joint.
body1BodyThe first body to connect with a pulley joint.
body2BodyThe second body to connect with a pulley joint.
gx1numberThe x coordinate of the first body's ground anchor.
gy1numberThe y coordinate of the first body's ground anchor.
gx2numberThe x coordinate of the second body's ground anchor.
gy2numberThe y coordinate of the second body's ground anchor.
x1numberThe x coordinate of the pulley joint anchor in the first body.
y1numberThe y coordinate of the pulley joint anchor in the first body.
x2numberThe x coordinate of the pulley joint anchor in the second body.
y2numberThe y coordinate of the pulley joint anchor in the second body.
ratio (1)numberThe joint ratio.
collideConnected (true)booleanSpecifies whether the two bodies should collide with each other.

love.physics.newRectangleShape

長方形の PolygonShape を作成するための速記法です。

標準では、局所の原点はグラフィックに対して左上に向かい合った長方形の'''中心'''に位置します。

shape = love.physics.newRectangleShape( width, height )

shapePolygonShape新規 PolygonShape です。
widthnumber長方形の幅。
heightnumber長方形の高さ。

shape = love.physics.newRectangleShape( x, y, width, height, angle )

shapePolygonShape新規 PolygonShape です。
xnumberx-軸からの支距。
ynumbery-軸からの支距。
widthnumber長方形の幅。
heightnumber長方形の高さ。
angle (0)number長方形の初期角度。

love.physics.newRevoluteJoint

二つの物体間で車軸関節を作成します。

この関節は回転可能な点へ二つの物体を接続します。

joint = love.physics.newRevoluteJoint( body1, body2, x, y, collideConnected )

jointRevoluteJoint新規の回転関節。
body1Body第一物体。
body2Body第二物体。
xnumber接続地点の x 位置。
ynumber接続地点の y 位置。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。

joint = love.physics.newRevoluteJoint( body1, body2, x1, y1, x2, y2, collideConnected, referenceAngle )

jointRevoluteJoint新規の回転関節。
body1Body第一物体。
body2Body第二物体。
x1number第一接続地点の x 位置。
y1number第一接続地点の y 位置。
x2number第二接続地点の x 位置。
y2number第二接続地点の y 位置。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。
referenceAngle (0)numberbody1 および body2 間においての弧度による基準角。

love.physics.newRopeJoint

二つの物体間における関節を作成します。この関数は物体間の最大距離のみを延長します。

joint = love.physics.newRopeJoint( body1, body2, x1, y1, x2, y2, maxLength, collideConnected )

jointRopeJoint新規の RopeJoint です。
body1Body関節へ接触する第一物体。
body2Body関節へ接触する第二物体。
x1number第一錨地点の x 位置。
y1number第一錨地点の y 位置。
x2number第二錨地点の x 位置。
y2number第二錨地点の y 位置。
maxLengthnumber物体に対する最大距離。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。

love.physics.newWeldJoint

二つの物体間に対して拘束具を作成します。本質的に WeldJoint は二つの物体を接着します。しかしながら、拘束条件は Box2D における反復の解釈より、少し柔軟です。

joint = love.physics.newWeldJoint( body1, body2, x1, y1, x2, y2, collideConnected, referenceAngle )

jointWeldJoint新規 WeldJoint です。
body1Body関節に取り付ける第一物体。
body2Body関節に取り付ける第二物体。
x1number錨における第一地点の x 位置 (世界空間)。
y1number錨における第一地点の y 位置 (世界空間)。
x2number錨における第二地点の x 位置 (世界空間)。
y2number錨における第二地点の y 位置 (世界空間)。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。
referenceAngle (0)numberbody1 および body2 間においての弧度による基準角。

love.physics.newWheelJoint

車輪関節を作成します。

joint = love.physics.newWheelJoint( body1, body2, x, y, ax, ay, collideConnected )

jointWheelJoint新規 WheelJoint です。
body1Body第一物体。
body2Body第二物体。
xnumber錨地点の x 位置。
ynumber錨地点の y 位置。
axnumber軸単位ベクトルの x 位置。
aynumber軸単位ベクトルの y 位置。
collideConnected (false)boolean二つの物体が互いに衝突するかどうか指定します。

love.physics.newWorld

世界の新規作成。

world = love.physics.newWorld( xg, yg, sleep )

worldWorld素晴らしき新世界。
xg (0)numberx 成分の重力。
yg (0)numbery 成分の重力。
sleep (true)booleanこの世界における物体は休止が許可されているかどうか。

love.physics.setMeter

メートル尺度係数をピクセルへ設定します。

物理演算モジュールの全座標は本係数で除算されてからメートルへ変換され、グラフィックスの変換なしで画面へオブジェクトを直接描画するのに便利な方法を作成します。

形状は 10 倍以下の大きさで作成することが推奨されます。これは Box2D が 0.1 から 10 メートルまでの形状の大きさに上手く調整するために重要です。省略時のメートル尺度は 30 です。

love.physics.setMeter はオブジェクトの作成まで遡及(そきゅう)して適用しません。作成されたオブジェクトはメートル座標を保持しますが、尺度係数はピクセルの座標に影響します。

love.physics.setMeter( scale )

scalenumber整数による尺度係数。

BodyType

static

静止物体であり不動です。

dynamic

動的物体であり全ての物体と衝突します。

kinematic

運動物体は動的な物体に対してのみ衝突します。

JointType

distance

DistanceJoint です。

gear

GearJoint です。

mouse

MouseJoint です。

prismatic

PrismaticJoint です。

pulley

PulleyJoint です。

revolute

RevoluteJoint です。

friction

FrictionJoin です。

weld

WeldJoint です。

rope

RopeJoint です。

ShapeType

circle

形状は CircleShape です。

polygon

形状は PolygonShape です。

edge

形状は EdgeShape です。

chain

形状は ChainShape です。

Body

物体は速度と位置を持つオブジェクトです。

Constructors

Functions

Supertypes

Body:applyAngularImpulse

物体に対する角力積を適用します。これは単に単一の運動量を即時追加します。

物体の大規模質量には反応しません。反応は時間刻みに'''依存しないため'''、一秒間に力量を連続して適用するのと等価になります。力積は単一の物体を押し出すために使用する最良の方法です。物体を連続して押し出すには Body:applyForce を使用するほうが良いです。

Body:applyAngularImpulse( impulse )

impulsenumber一秒あたりのキログラム平方メートル単位による力積。

Body:applyForce

物体に力量を適用します。

力量は方向へ物体を押し出します。物体の大規模質量には反応しません。反応については適用された力量の長さに依存します:力量は全ての時間刻みにて連続的に作用するため、短い時間刻みは物体を短時間だけ押し出します。従って、物体を連続的に押し出すには(重力のように)、より多くの時間刻みを使用することが最良の方法です。時間刻みに依存しない一度だけの押し出しについては Body:applyLinearImpulse を使用した方がよいです。

力量を適用する位置が指定されない場合は、物体にある重心へ作用します。重心方向へ向けられない力量の一部は物体を回転(は回転の慣性に依存します)させます。

力量の要素および位置は必ず世界座標で指定するよう注意してください。

Body:applyForce( fx, fy )

fxnumber重心へ適用する力量の x 要素。
fynumber重心へ適用する力量の y 要素。

Body:applyForce( fx, fy, x, y )

fxnumber適用する力量の x 要素。
fynumber適用する力量の y 要素。
xnumber力量へ適用する x 位置。
ynumber力量へ適用する y 位置。

Body:applyLinearImpulse

物体に対して力積を適用します。

これは単一の物体運動量を即時追加して作成します。

力積は方向へ物体を押し出します。物体の大規模質量には反応しません。反応については時間刻みに'''依存せず'''、一秒間に力量を連続で適用することと等価です。力積は物体に一度だけ押し出すのに最良の方法です。物体への連続的な押し出しについては Body:applyForce を使用した方がよいです。

力積を適用する位置が指定されない場合は、物体にある重心へ作用します。重心方向へ向けられない力積の一部は物体を回転(は回転の慣性に依存します)させます。

力積の要素および位置は必ず世界座標で指定するよう注意してください。

Body:applyLinearImpulse( ix, iy )

ixnumber重心へ適用する力積の x 要素。
iynumber重心へ適用する力積の y 要素。

Body:applyLinearImpulse( ix, iy, x, y )

ixnumber力積の x 要素。
iynumber力積の y 要素。
xnumber力積を適用する x 位置。
ynumber力積を適用する y 位置。

Body:applyTorque

物体へ力矩 (トルク、ねじりモーメント) を適用します。

力矩は物体の角運動速度(回転)を変更する力と類似しています。効果は物体が持つ回転の慣性に依存します。

Body:applyTorque( torque )

torquenumber適用する力矩。

Body:destroy

物体および接触している取付具と関節を明示的に破棄します。

この関数の呼び出し後に破壊された任意のオブジェクトを使用しようとすればエラーが発生します。 LÖVE 0.7.2 では、ガーベージ・コレクションの処理待ち時間がないため、この関数はオブジェクトを直ちに解放するために使用できます。

Body:destroy()

Body:getAngle

物体の角度を取得します。

角度は 弧度により計測されます。 次数を変形する必要がある場合は、 math.deg を使用してください。

弧度の値が 0 のときは"右側に面している"ことを意味します。弧度は左回りに増進しますが、人間の視点から見て''右回り''になるようにするためには Y 軸の下を指します。

angle = Body:getAngle()

anglenumber弧度による角度。

Body:getAngularDamping

物体の傾斜減衰を取得します。

傾斜減衰とは''時間経過後の角度運動速度における減少率です'':無減衰と外部からの加力がない回転物体は無限に回転します。減衰がある回転物体は徐々に回転しなくなるでしょう。

減衰は摩擦と同機能ではありません。 ― それらはモデル化することができます。しかし、減衰のみ Box2D (および LOVE) により提供されます。

引数 damping は 0 および 無限大の間であり、0 の場合は無減衰を意味し、無限大の場合は最大減衰を意味します。通常は 0 および 0.1 の間の減衰値を使用します。

damping = Body:getAngularDamping()

dampingnumber傾斜減衰の値。

Body:getAngularVelocity

物体の角速度を取得します。

角速度とは''時間経過後の角度における変動率''です。

力矩、中心の力量/力積、および傾斜減衰は World:update により適用と変更が行われます。それは Body:setAngularVelocity にて直接設定することができます。

''時間経過後の位置における変動率を変更する''必要がある場合は、 Body:getLinearVelocity (日本語)|Body:getLinearVelocity を使用してください。

w = Body:getAngularVelocity()

wnumber弧度/秒単位による角速度。

Body:getContactList

物体に接触している全ての接点を一覧として取得します。

contacts = Body:getContactList()

contactstable物体に関連付けられている全接点の一覧。

Body:getFixtureList

全ての取付具をテーブルで返します。

fixtures = Body:getFixtureList()

fixturestable全ての取付具を シーケンス として表したもの。

Body:getGravityScale

重力規模係数を返します。

scale = Body:getGravityScale()

scalenumber重力規模係数。

Body:getInertia

物体の回転の慣性を取得します。

回転の慣性はどのくらいの強さで物体の回転を行うかどうか指定します。これは Body:setMass の第四引数、または Body:setMassFromShapes により自動的に設定されます。

inertia = Body:getInertia()

inertianumber物体の回転の慣性。

Body:getJointList

この物体に取り付けられている関節を内包するテーブルを返します。

joints = Body:getJointList()

jointstable物体に取り付けられている関節を sequence で表したもの。

Body:getLinearDamping

物体の線形減衰を取得します。

線形減衰は''時間経過後における線形速度の減衰率です。''空間にある場合、減衰と外部力量がない物体は無制限に移動し続けます。減衰のある物体は徐々に移動しなくなります。

減衰は摩擦と同一ではありません ― それらは共にモデル化することができます。

damping = Body:getLinearDamping()

dampingnumber線形減衰の値。

Body:getLinearVelocity

中心質量から物体の線形速度を取得します。

線形速度は''時間経過後の位置の変動率です。''

''時間経過後の角の変動率'' を変更する必要がある場合は、 Body:getAngularVelocity を使用してください。 中心の質量から異なる地点の線形速度を取得する必要がある場合は:

* Body:getLinearVelocityFromLocalPoint は局所座標での地点指定を可能にします。

* Body:getLinearVelocityFromWorldPoint は世界座標での地点指定を可能にします。

局所および世界座標の定義については "Essential Mathematics for Games and Interactive Applications の 136 ページ" を参照してください。

x, y = Body:getLinearVelocity()

xnumber速度ベクトルの x 要素。
ynumber速度ベクトルの y 要素。

Body:getLinearVelocityFromLocalPoint

物体の局所地点における線形速度を取得します。

物体にある地点に対する線形速度は物体の中心質量の速度を加えた物体の回転かから地点の速度です。

物体上の地点は必ず局所座標で指定してください。世界座標は Body:getLinearVelocityFromWorldPoint にて指定してください。

vx, vy = Body:getLinearVelocityFromLocalPoint( x, y )

vxnumber地点 (x,y) の x 速度要素。
vynumber地点 (x,y) の y 速度要素。
xnumber基準速度の x 位置。
ynumber基準速度の y 位置。

Body:getLinearVelocityFromWorldPoint

物体の世界地点における線形速度を取得します。

物体にある地点に対する線形速度は物体の中心質量の速度を加えた物体の回転かから地点の速度です。

物体上の地点は必ず世界座標で指定してください。局所座標は Body:getLinearVelocityFromLocalPoint にて指定してください。

vx, vy = Body:getLinearVelocityFromWorldPoint( x, y )

vxnumber地点 (x,y) の x 速度要素。
vynumber地点 (x,y) の y 速度要素。
xnumber基準速度の x 位置。
ynumber基準速度の y 位置。

Body:getLocalCenter

局所座標の中心にある質量の位置を取得します。

世界座標における重心を取得するには Body:getWorldCenter を使用してください。

x, y = Body:getLocalCenter()

xnumber座標の中心にある質量の x 座標。
ynumber座標の中心にある質量の y 座標。

Body:getLocalPoint

地点を世界座標から局所座標へ変換します。

localX, localY = Body:getLocalPoint( worldX, worldY )

localXnumber局所座標における地点の x 要素。
localYnumber局所座標における地点の y 要素。
worldXnumber世界座標における地点の x 要素。
worldYnumber世界座標における地点の y 要素。

Body:getLocalVector

ベクトルを世界座標から局所座標へ変換します。

localX, localY = Body:getLocalVector( worldX, worldY )

localXnumber局所座標におけるベクトルの x 要素。
localYnumber局所座標におけるベクトルの y 要素。
worldXnumber世界座標におけるベクトルの x 要素。
worldYnumber世界座標におけるベクトルの y 要素。

Body:getMass

物体の質量を取得します。

静的物体の質量は常に 0 です。

mass = Body:getMass()

massnumber物体の質量 (キログラム単位)。

Body:getMassData

中心の質量および回転の慣性を返します。

x, y, mass, inertia = Body:getMassData()

xnumber中心の質量にある x 位置。
ynumber中心の質量にある y 位置。
massnumber物体の質量。
inertianumber回転の慣性。

Body:getPosition

物体の位置を取得します。

物体の中心にある質量ではないことに注意してください。

x, y = Body:getPosition()

xnumberx 位置。
ynumbery 位置。

Body:getType

物体の種類を返します。

type = Body:getType()

typeBodyType物体の種類。

Body:getUserData

この物体へ関連付けられた Lua の値を返します。

value = Body:getUserData()

valueany物体へ関連付けられた Lua の値。

Body:getWorld

世界において生存している物体を取得します。

world = Body:getWorld()

worldWorld世界において生存している物体。

Body:getWorldCenter

世界座標の中心にある質量の位置を取得します。

局所座標における重心を取得するには Body:getLocalCenter を使用してください。

x, y = Body:getWorldCenter()

xnumber座標の中心にある質量の x 座標。
ynumber座標の中心にある質量の y 座標。

Body:getWorldPoint

地点を局所座標から世界座標へ変換します。

worldX, worldY = Body:getWorldPoint( localX, localY )

worldXnumber世界座標における地点の x 要素。
worldYnumber世界座標における地点の y 要素。
localXnumber局所座標における地点の x 要素。
localYnumber局所座標における地点の y 要素。

Body:getWorldPoints

複数の地点を局所座標から世界座標へ変換します。

x1, y1, x2, y2, ... = Body:getWorldPoints( x1, y1, x2, y2, ... )

x1numberThe transformed x position of the first point.
y1numberThe transformed y position of the first point.
x2numberThe transformed x position of the second point.
y2numberThe transformed y position of the second point.
...numberThe transformed x and y positions of additional points.
x1numberThe x position of the first point.
y1numberThe y position of the first point.
x2numberThe x position of the second point.
y2numberThe y position of the second point.
...numberMore x and y points.

Body:getWorldVector

ベクトルを局所座標から世界座標へ変換します。

worldX, worldY = Body:getWorldVector( localX, localY )

worldXnumber世界座標におけるベクトルの x 要素。
worldYnumber世界座標におけるベクトルの y 要素。
localXnumber世界座標におけるベクトルの y 要素。
localYnumber局所座標におけるベクトルの y 要素。

Body:getX

世界座標にある物体の x 位置を取得します。

x = Body:getX()

xnumber世界座標にある x 位置。

Body:getY

世界座標にある物体の y 位置を取得します。

y = Body:getY()

ynumber世界座標にある y 位置。

Body:isActive

物体が模擬において活動中として使用されているかどうかを返します。

status = Body:isActive()

statusbooleantrue ならば物体は活動中ですが、それ以外は false です。

Body:isAwake

物体の活動休止状態を返します。

status = Body:isAwake()

statusbooleantrue ならば物体は覚醒しており、それ以外は false です。

Body:isBullet

物体の弾丸状態を取得します。

物体の衝突を確認する方法は二種類あります:

* 世界更新時の位置 (標準)

* 連続的な衝突検出 ('''C'''ontinuous '''C'''ollision '''D'''etection: CCD) の使用。

標準の方法は効率的ですが、非常に高速度移動する物体は時々に衝突生成を行わず別の物体上を通過する場合があります。弾丸として設定される物体は CCD を使用します。これは非効的率ですが、高速移動時に通過しないことが保証されます。

静的物体(質量 0)は常に CCD を使用しているため、従って弾丸でなくても壁を高速移動している物体を通過しないことに注意してください。

status = Body:isBullet()

statusboolean物体の弾丸状態。

Body:isDestroyed

物体が破棄されたかどうかを取得します。破棄された物体は再利用できません。

destroyed = Body:isDestroyed()

destroyedboolean物体が破棄されたかどうか。

Body:isFixedRotation

物体の回転が固定されているかどうか返します。

fixed = Body:isFixedRotation()

fixedbooleantrue ならば物体の回転は固定されており、それ以外は false です。

Body:isSleepingAllowed

休止を行う物体の性質を取得します。

status = Body:isSleepingAllowed()

statusbooleantrue ならば物体の休止は許可されており、それ以外は false です。

Body:resetMassData

取付具の質量特性から再計算を行うことにより物体の質量を初期設定へ戻します。

Body:resetMassData()

Body:setActive

世界において物体が活動するかどうかを設定します。

不活性の物体に対して模擬を行いません。さらに不動であり衝突を行いません。

Body:setActive( active )

activeboolean物体を活動させるか否か。

Body:setAngle

物体の角度を設定します。

角度は 弧度により計測されます。 次数を変形する必要がある場合は、 math.deg を使用してください。

弧度の値が 0 のときは&quot;右側に面している&quot;ことを意味します。弧度は左回りに増進しますが、人間の視点から見て''右回り''になるようにするためには Y 軸の下を指します。

角度を変更することにより別の物体と衝突させることができます。

Body:setAngle( angle )

anglenumber弧度による角度。

Body:setAngularDamping

物体の傾斜減衰を設定します。

傾斜減衰の定義については Body:getAngularDamping を参照してください。

傾斜減衰は 0 から無限大の任意の値にすることができます。しかし、 0 および 0.1 までの間にすることが推奨されます。その他の値は非現実的な様子になるでしょう。

Body:setAngularDamping( damping )

dampingnumber新規の傾斜減衰。

Body:setAngularVelocity

物体の角速度を設定します。

角速度とは''時間経過後の角度における変動率''です。

この関数は一切の蓄積を行いません。以前の World:update の呼び出しにより適用された一切の力積は破棄されます。

Body:setAngularVelocity( w )

wnumber一秒当たりの弧度単位による新規角速度。

Body:setAwake

物体の覚醒または休止します。

Body:setAwake( awake )

awakeboolean物体の休止状態。

Body:setBullet

物体の弾丸状態を設定します。

物体の衝突を確認する方法は二種類あります:

* 世界更新時の位置 (標準)

* 連続的な衝突検出 ('''C'''ontinuous '''C'''ollision '''D'''etection: CCD) の使用。

標準の方法は効率的ですが、非常に高速度移動する物体は時々に衝突生成を行わず別の物体上を通過する場合があります。弾丸として設定される物体は CCD を使用します。これは非効的率ですが、高速移動時に通過しないことが保証されます。

静的物体 (質量 0) は常に CCD を使用しているため、従って弾丸でなくても壁を高速移動している物体を通過しないことに注意してください。

Body:setBullet( status )

statusboolean物体の弾丸状態。

Body:setFixedRotation

物体の回転を固定するかどうか設定します。

回転が固定された物体において回転速度は変動しません。

警告: LÖVE 0.6.2 では、この関数の引数が false にて呼ばれたときに不具合があります。

Body:setFixedRotation( fixed )

fixedboolean物体の回転を固定するかどうか。

Body:setGravityScale

物体に対する新しい重力規模係数を設定します。

Body:setGravityScale( scale )

scalenumber新しい重力規模係数を設定。

Body:setInertia

物体の慣性を設定します。

この値は Body:setMass の第四引数でも設定できます(LOVE 0.8.0 以前のみ)。

Body:setInertia( inertia )

inertianumberキログラム単位 × 一平方ピクセルによる新規の慣性モーメント。

Body:setLinearDamping

物体の線形減衰を設定します。

線形減衰の定義については Body:getLinearDamping を参照してください。

線形減衰は 0 から無限大の値を扱うことができます。しかし、 0 から 0.1 までの間に止めておくことが推奨されます。その他の値はオブジェクトが "浮かんだ" ように見えるでしょう (重力が有効であれば)。

Body:setLinearDamping( ld )

ldnumber物体の新規線形減衰。

Body:setLinearVelocity

物体に対する線形速度を新規設定します。

この関数は一切の蓄積を行いません。以前の World:update の最後の呼び出しにより適用された一切の力積は破棄されます。

Body:setLinearVelocity( x, y )

xnumber速度ベクトルの x 要素。
ynumber速度ベクトルの y 要素。

Body:setMass

物体の質量を新規設定します。

Body:setMass( mass )

massnumberキログラム単位による質量。

Body:setMassData

計算された質量データをオーバーライド(上書き)します。

Body:setMassData( x, y, mass, inertia )

xnumber中心の質量にある x 位置。
ynumber中心の質量にある y 位置。
massnumber物体の質量。
inertianumber回転の慣性。

Body:setPosition

物体の位置を設定します。

これは物体の中心にある質量ではないことに注意してください。

この関数では物体を起こすことはできません。

Body:setPosition( x, y )

xnumberx 座標。
ynumbery 座標。

Body:setSleepingAllowed

物体の活動休止について設定します。休止が許可されるならば、物体は自動的に休止します。休止中の物体は衝突して物体が覚醒しない限り模擬を行いません。床面が除去された場合は浮動している休止中の物体のような状態では終了できることに用心してください。

Body:setSleepingAllowed( allowed )

allowedbooleantrue ならば物体の休止を許可しますが、それ以外は false です。

Body:setType

新しい物体の種類を設定します。

Body:setType( type )

typeBodyType物体の種類。

Body:setUserData

物体へ Lua の値を関連付けます。

参照を削除するには、明示的に nil を渡してください。

Body:setUserData( value )

valueany物体へ関連付ける Lua の値。

Body:setX

物体の x 位置を設定します。

この関数では物体を起こすことができません。

Body:setX( x )

xnumber物体の x 位置。

Body:setY

物体の y 位置を設定します。

この関数では物体を起こすことができません。

Body:setY( y )

ynumber物体の y 位置。

ChainShape

ChainShape は複数の線分から構成されています。これは地形の境界を作成するために使用することができます。形状には体積がなく PolygonShape および CircleShape のみ衝突することができます。

PolygonShape とは異なり ChainShape には頂点の制限がないか凸面の形状である必要がありますが、自己交差には非対応です。

Constructors

Functions

Supertypes

ChainShape:getChildEdge

EdgeShape として形状の子を返します。

EdgeShape = ChainShape:getChildEdge( index )

EdgeShapenumberThe child as an EdgeShape.
indexnumberThe index of the child.

ChainShape:getNextVertex

次の形状と接続を設置している頂点を取得します。

次および前の ChainShape に対する頂点を設定することは、平面の形状が角に沿って移動する時、および新しい形状へ移動する時に、希望しない衝突を阻止するために有用です。

ChainShape:getNextVertex( x, y )

x (nil)numberThe x-component of the vertex, or nil if ChainShape:setNextVertex hasn't been called.
y (nil)numberThe y-component of the vertex, or nil if ChainShape:setNextVertex hasn't been called.

ChainShape:getPoint

形状の地点を返します。

x, y = ChainShape:getPoint( index )

xnumber地点 x の座標。
ynumber地点 y の座標。
indexnumber返された地点の索引。

ChainShape:getPoints

形状における全ての地点を返します。

x1, y1, x2, y2, ... = ChainShape:getPoints()

x1numberThe x-coordinate of the first point.
y1numberThe y-coordinate of the first point.
x2numberThe x-coordinate of the second point.
y2numberThe y-coordinate of the second point.
...numberAdditional x and y values.

ChainShape:getPreviousVertex

前の形状と接続を設置している頂点を取得します。

次および前の ChainShape に対する頂点を設定することは、平面の形状が角に沿って移動する時、および新しい形状へ移動する時に、希望しない衝突を阻止するために有用です。

x, y = ChainShape:getPreviousVertex()

x (nil)number頂点の x 要素、または ChainShape:setPreviousVertex が呼び出されていない場合は nil です。
y (nil)number頂点の y 要素、または ChainShape:setPreviousVertex が呼び出されていない場合は nil です。

ChainShape:getVertexCount

形状が保持している頂点の数を返します。

count = ChainShape:getVertexCount()

countnumber頂点の数。

ChainShape:setNextVertex

次の形状へ接続を設置するために頂点を設定します。

これは平面の形状が角に沿って移動する時、および新しい形状の間を移動する時に希望しない衝突を阻止するために有用です。

ChainShape:setNextVertex( x, y )

xnumber頂点の x 要素。
ynumber頂点の y 要素。

ChainShape:setPreviousVertex

前の形状へ接続を設置するために頂点を設定します。

これは平面の形状が角に沿って移動および新しい形状の間を移動するときに希望しない衝突を阻止するために有用です。

ChainShape:setPreviousVertex( x, y )

xnumber頂点の x 要素。
ynumber頂点の y 要素。

CircleShape

円形は形状を拡張して半径および局所座標を追加します。

Constructors

Functions

Supertypes

CircleShape:getPoint

円形の中心点を取得します。

x, y = CircleShape:getPoint()

xnumber円形の中心点における x-要素。
ynumber円形の中心点における y-要素。

CircleShape:getRadius

円の半径を取得します。

radius = CircleShape:getRadius()

radiusnumber円の半径。

CircleShape:setPoint

円形の中心位置を設定します。

CircleShape:setPoint( x, y )

xnumber円形の中心点における新規 x-要素。
ynumber円形の中心点における新規 y-要素。

CircleShape:setRadius

円の半径を設定します。

CircleShape:setRadius( radius )

radiusnumber円の半径。

Contact

接点は世界において作成されたオブジェクトの衝突を管理します。

Functions

Supertypes

Contact:getFixtures

接点の形状が保持する二つの取付具を取得します。

fixtureA, fixtureB = Contact:getFixtures()

fixtureAFixture第一取付具。
fixtureBFixture第二取付具。

Contact:getFriction

二つの形状間における接点の摩擦を取得します。

friction = Contact:getFriction()

frictionnumber接点の摩擦。

Contact:getNormal

二つの形状間における接点の通常ベクトルを取得します。

この関数は第一から第二までの形状における地点のベクトル単位の座標を返します。

nx, ny = Contact:getNormal()

nxnumber通常ベクトルの x 要素。
nynumber通常ベクトルの y 要素。

Contact:getPositions

二つの取付具の衝突における接点の地点を返します。点は一つまたは二つです。

x1, y1, x2, y2 = Contact:getPositions()

x1number一番目の接点における x 座標。
y1number一番目の接点における y 座標。
x2number二番目の接点における x 座標。
y2number二番目の接点における y 座標。

Contact:getRestitution

二つの形状間における接点の復元を取得します。

restitution = Contact:getRestitution()

restitutionnumber二つの形状間における接点の復元。

Contact:isEnabled

接点が有効かどうか返します。preSolve (事前解決) コールバックにおいて取得する接点が無効であるならば衝突は無視されます。

enabled = Contact:isEnabled()

enabledbooleantrue ならば有効、それ以外は false です。

Contact:isTouching

二つの取付具の衝突において互いに接触しているかどうか返します。

touching = Contact:isTouching()

touchingbooleantrue ならば接触しており、それ以外は false です。

Contact:resetFriction

二つの取付具の混合値における接点摩擦を破棄して初期設定に戻します。

Contact:resetFriction()

Contact:resetRestitution

二つの取付具の混合値における接点の復元を破棄して初期設定に戻します。

Contact:resetRestitution()

Contact:setEnabled

接点を無効または有効にします。

Contact:setEnabled( enabled )

enabledbooleantrue ならば有効または false ならば無効です。

Contact:setFriction

接点の摩擦を設定します。

Contact:setFriction( friction )

frictionnumber接点の摩擦。

Contact:setRestitution

接点の復元を設定します。

Contact:setRestitution( restitution )

restitutionnumber接点の復元。

EdgeShape

EdgeShape は線分です。地形へ境界を作成するために使用できます。形状は体積が存在せず PolygonShape および CircleShape のみと衝突することができます。

Constructors

Functions

Supertypes

EdgeShape:getPoints

角地点の局所座標を返します。

x1, y1, x2, y2 = EdgeShape:getPoints()

x1number第一頂点の x 要素。
y1number第一頂点の y 要素。
x2number第二頂点の x 要素。
y2number第二頂点の y 要素。

EdgeShape:getNextVertex

次の形状と接続を設置している頂点を取得します。

次および前の EdgeShape に対する頂点を設定することは、平面の形状が角に沿って移動する時、および新しい形状へ移動する時に、希望しない衝突を阻止するために有用です。

x, y = EdgeShape:getNextVertex()

xnumber頂点の x 要素、または EdgeShape:setNextVertex が呼び出されていない場合は nil です。
ynumber頂点の y 要素、または EdgeShape:setNextVertex が呼び出されていない場合は nil です。

EdgeShape:getPreviousVertex

前の形状と接続を設置している頂点を取得します。

次および前の EdgeShape に対する頂点を設定することは、平面の形状が角に沿って移動する時、および新しい形状へ移動する時に、希望しない衝突を阻止するために有用です。

x, y = EdgeShape:getPreviousVertex()

xnumber頂点の x 要素、または EdgeShape:setPreviousVertex が呼び出されていない場合は nil です。
ynumber頂点の y 要素、または EdgeShape:setPreviousVertex が呼び出されていない場合は nil です。

EdgeShape:setNextVertex

次の形状へ接続を設置するために頂点を設定します。

これは平面の形状が角に沿って移動する時、および新しい形状の間を移動する時に希望しない衝突を阻止するために有用です。

EdgeShape:setNextVertex( x, y )

xnumber頂点の x 要素。
ynumber頂点の y 要素。

EdgeShape:setPreviousVertex

前の形状へ接続を設置するために頂点を設定します。

これは平面の形状が角に沿って移動および新しい形状の間を移動するときに希望しない衝突を阻止するために有用です。

EdgeShape:setPreviousVertex( x, y )

xnumber頂点の x 要素。
ynumber頂点の y 要素。

DistanceJoint

二つの物体において同一距離を維持します。

File:physicsJointDistance.PNG

Constructors

Functions

Supertypes

DistanceJoint:getDampingRatio

減衰比を取得します。

ratio = DistanceJoint:getDampingRatio()

rationumber減衰比。

DistanceJoint:getFrequency

応答速度を取得します。

Hz = DistanceJoint:getFrequency()

Hznumber応答速度。

DistanceJoint:getLength

二つの物体間の平衡距離を取得します。

l = DistanceJoint:getLength()

lnumber二つの物体間の長さ。

DistanceJoint:setDampingRatio

減衰比を設定します。

DistanceJoint:setDampingRatio( ratio )

rationumber減衰比。

DistanceJoint:setFrequency

応答速度を設定します。

DistanceJoint:setFrequency( Hz )

Hznumber応答速度。

DistanceJoint:setLength

二つの物体間の平衡距離を設定します。

DistanceJoint:setLength( l )

lnumber二つの物体間の長さ。

Fixture

Fixture (取付具) は物体へ形状を取り付けます。

Constructors

Functions

Supertypes

Fixture:destroy

取付具を破棄します。

Fixture:destroy()

Fixture:getBody

取付具が取り付けられている物体を返します。

body = Fixture:getBody()

bodyBody親の物体。

Fixture:getBoundingBox

取付具における境界ボックスの地点を返します。取付具に複数の子がある場合は、索引には 1 を基数として指定できます。 例えば、取り付け具は鎖形状による多数の子を有しています。

topLeftX, topLeftY, bottomRightX, bottomRightY = Fixture:getBoundingBox( index )

topLeftXnumber左上の地点として x 位置。
topLeftYnumber左上の地点として y 位置。
bottomRightXnumber右下の地点として x 位置。
bottomRightYnumber右下の地点として y 位置。
index (1)number取付具における境界ボックス。

Fixture:getCategory

取付具の所属する分類を返します。

category1, category2, ... = Fixture:getCategory()

category1numberThe first category.
category2numberThe second category.
...numberAdditional categories.

Fixture:getDensity

取付具の密度を返します。

density = Fixture:getDensity()

densitynumber1平方メートル当たりのキログラム単位による取付具の密度。

Fixture:getFilterData

取付具のフィルタ・データを返します。

分類とマスクは 16 bit 整数をビット化したものとして符号化されます。

categories, mask, group = Fixture:getFilterData()

categoriesnumber分類として 0 から 65535 までの整数。
masknumberマスクとして 0 から 65535 までの整数。
groupnumber群として -32768 から 32767 までの整数。

Fixture:getFriction

取付具の摩擦を返します。

friction = Fixture:getFriction()

frictionnumber取付具の摩擦。

Fixture:getGroupIndex

取付具の所属する群を返します。群が正数であり取付具が同じ群に所属しているならば常に衝突しますが負数であれば衝突しません。群の数 0 である場合は群は存在しないことを意味します。

群の範囲は -32768 から 32767 までです。

group = Fixture:getGroupIndex()

groupnumber取付具の群。

Fixture:getMask

この取付具は'''衝突しない'''ものに分類されているかどうかを返します。

mask1, mask2, ... = Fixture:getMask()

mask1numberThe first category selected by the mask.
mask2numberThe second category selected by the mask.
...numberAdditional categories selected by the mask.

Fixture:getMassData

中心の質量および回転の慣性を返します。

x, y, mass, inertia = Fixture:getMassData()

xnumber中心の質量にある x 位置。
ynumber中心の質量にある y 位置。
massnumber取付具の質量。
inertianumber回転の慣性。

Fixture:getRestitution

取付具の復元を返します。

restitution = Fixture:getRestitution()

restitutionnumber取付具の復元。

Fixture:getShape

取付具の形状を返します。この形状は模擬中に使用される実際のデータへの参照です。時間を刻んでいる間に値を変更することは可能です。

shape = Fixture:getShape()

shapeShape取付具の形状

Fixture:getUserData

取付具へ関連付けられた Lua の値を返します。

value = Fixture:getUserData()

valueany取付具へ関連付けられた Lua の値。

Fixture:isDestroyed

取付具が破棄されたかどうかを取得します。破棄された取付具は再利用できません。

destroyed = Fixture:isDestroyed()

destroyedboolean取付具が破棄されたかどうか。

Fixture:isSensor

取付具は感知装置であるかどうか返します。

sensor = Fixture:isSensor()

sensorboolean取付具は感知装置であるか。

Fixture:rayCast

取付具の形状に対する斜線計算および表面法線のベクトル、さらに斜線により線が当たった位置を返します。斜線が形状を外れている場合は nil を返します。

斜線は入力線の第一地点を出発して線のある第二地点へ移動します。第五引数は入力線の長さであり尺度変更係数として斜線が移動する最大距離です。

引数 childIndex は ChainShape といった親形状に対して、どの子が斜線計算されるか指定するために使用されます。ChainShapes において、索引 1 が鎖においての最初の角です。親形状の斜線計算では指定された子に対してのみ検査されるために、すべての親形状を調査したいのであれば、その子ら全てに対して反復する必要があります。

力積における世界位置は行ベクトルへ第三引数の返値を乗算して行の始点へ加算をすることで計算できます。

hitx, hity = x1 + (x2 - x1) * fraction, y1 + (y2 - y1) * fraction

x, y, fraction = Fixture:rayCast( x1, y1, x2, y1, maxFraction, childIndex )

xnumber斜線が形状に当たった場所での角の通常ベクトルにおける x 要素。
ynumber斜線が形状に当たった場所での角の通常ベクトルにおける y 要素。
fractionnumber線の長さを係数として公差が発生した入力線上の位置。
x1number入力線の始点として x 位置。
y1number入力線の始点として y 位置。
x2number入力線の終点として x 位置。
y1number入力線の終点として y 位置。
maxFractionnumber斜線の長さにおける引数。
childIndex (1)number斜線計算が行われる子の索引。

Fixture:setCategory

取付具の所属する分類を設定します。 1 から 16 までの数値で最大 16 までの分類を表現できます。

全取付具においてデフォルトの分類は 1 です。

Fixture:setCategory( category1, category2, ... )

category1numberThe first category.
category2numberThe second category.
...numberAdditional categories.

Fixture:setDensity

取付具の密度を設定します。この効果を直ちに使用する必要がある場合は Body:resetMassData を呼び出します。

Fixture:setDensity( density )

densitynumber1平方メートル当たりのキログラム単位による取付具の密度。

Fixture:setFilterData

取付具のフィルタ・データを設定します。

群、分類、およびマスクは取付具における衝突時の挙動を定義するために使用することができます。

二つの取付具が同じ群にある場合は、いずれかの群が正数であれば衝突しますが、負数であれば衝突しません。取付具がマスクを持つ別の取付具の分類を選択するとき、群 0 または不一致ならば接点フィルタを確認します。この場合は取付具は衝突しません。各々の分類が設定されない場合は接点フィルタが返値の値として使用されます。いずれも設定されなかった場合は常に衝突します。

分類は 16 まで使用できます。分類とマスクは 16 bit 整数をビット化したものとして符号化されます。

Fixture:setFilterData( categories, mask, group )

categoriesnumberThe categories as an integer from 0 to 65535.
masknumberThe mask as an integer from 0 to 65535.
groupnumberThe group as an integer from -32768 to 32767.

Fixture:setFriction

取付具の摩擦を設定します。

摩擦は他の形状に沿って"滑る"場合に、どのように形状が反応するか決定します。低摩擦は氷の様に滑りやすい表面を示しており、高摩擦はコンクリートの様に、ざらざらした滑りにくい表示面を示します。範囲は 0.0 ~ 1.0 です。

Fixture:setFriction( friction )

frictionnumber取付具の摩擦。

Fixture:setGroupIndex

取付具の所属する群を設定します。群が正数であり取付具が同じ群に所属しているならば常に衝突しますが負数であれば衝突しません。群の数 0 である場合は群は存在しないことを意味します。

群の範囲は -32768 から 32767 までです。

Fixture:setGroupIndex( group )

groupnumber群は -32768 から 32767 までの整数です。

Fixture:setMask

Fixture:setMask の動作において'''選択されていない'''分類は、この取付具と'''衝突しません'''。この動作にしたいときは Box2D のマスク動作ではなく Fixture:setFilterData を使用してください。}}

取付具の分類マスクを設定します。分類は 1 から 16 までの数値表現です。

この取付具は別の取付具がさらにこの取付具を選択した場合は選択された分類と衝突'''しません'''。

Fixture:setMask( mask1, mask2, ... )

mask1numberThe first category.
mask2numberThe second category.
...numberAdditional categories.

Fixture:setRestitution

取付具の復元を設定します。

Fixture:setRestitution( restitution )

restitutionnumber取付具の復元。

Fixture:setSensor

取付具が感知装置として作動するかどうか設定します。

感知装置は衝突応答は発生しませんが、この取付具に対して World コールバック による接点の開始および接点の終了では呼ばれたままになります。

Fixture:setSensor( sensor )

sensorboolean感知装置の状態。

Fixture:setUserData

取付具へ Lua の値を関連付けます。

参照を削除するには、明示的に nil を渡してください。

Fixture:setUserData( value )

valueany取付具へ関連付ける Lua の値。

Fixture:testPoint

取付具の形状において地点は内側にあるかどうか確認します。

isInside = Fixture:testPoint( x, y )

isInsidebooleantrue ならば地点は内側にあり、 false ならば外側にあります。
xnumber地点の x 座標。
ynumber地点の y 座標。

FrictionJoint

FrictionJoint は物体へ摩擦を適用します。

Constructors

Functions

Supertypes

FrictionJoint:getMaxForce

最大摩擦力をニュートン単位で取得します。

force = FrictionJoint:getMaxForce()

forcenumberニュートン単位での最大力量。

FrictionJoint:getMaxTorque

ニュートン・メートル単位による最大摩擦力矩を取得します。

torque = FrictionJoint:getMaxTorque()

torquenumberニュートン・メートル単位による最大摩擦力矩。

FrictionJoint:setMaxForce

最大摩擦力をニュートン単位で設定します。

FrictionJoint:setMaxForce( maxForce )

maxForcenumberニュートン単位での最大力量。

FrictionJoint:setMaxTorque

ニュートン・メートル単位による最大摩擦力矩を取得します。

FrictionJoint:setMaxTorque( torque )

torquenumberニュートン・メートル単位による最大摩擦力矩。

GearJoint

伝動装置の動作と同様の方法で物体を協調させます。

Constructors

Functions

Supertypes

GearJoint:getJoints

この GearJoint により接続されている関節を取得します。

joint1, joint2 = GearJoint:getJoints()

joint1Joint最初に接続されている関節。
joint2Joint次に接続されている関節。

GearJoint:getRatio

伝動装置の関節における比率を取得します。

ratio = GearJoint:getRatio()

rationumber関節の比率。

GearJoint:setRatio

伝動装置の関節における比率を設定します。

GearJoint:setRatio( ratio )

rationumber関節の新規比率。

Joint

独自の方法で相互作用を行うために複数の物体と接触します。

Functions

Supertypes

Subtypes

Joint:destroy

関節を明示的に破棄します。この関数の呼び出し後に破壊された任意のオブジェクトを使用しようとすればエラーが発生します。

LOVE 0.7.2 では、ガベージ・コレクションの待ち時間がないため、この関数はオブジェクトを直ちに解放するために使用できます。

Joint:destroy()

Joint:getAnchors

関節における錨(固定具)の地点を取得します。

x1, y1, x2, y2 = Joint:getAnchors()

x1number物体 1 における錨 x の要素。
y1number物体 1 における錨 y の要素。
x2number物体 2 における錨 x の要素。
y2number物体 2 における錨 y の要素。

Joint:getBodies

関節が取り付けられている物体を返します。

bodyA, bodyB = Joint:getBodies()

bodyABody第一物体。
bodyBBody第二物体。

Joint:getCollideConnected

接続されている物体が衝突するかどうか取得します。

c = Joint:getCollideConnected()

cbooleantrue ならば衝突しますが、それ以外は false です。

Joint:getReactionForce

第二物体においての反作用力を返します。

x, y = Joint:getReactionForce()

xnumberThe x component of the force.
ynumberThe y component of the force.

Joint:getReactionTorque

第二物体においての反作用力矩(トルク)を返します。

torque = Joint:getReactionTorque( invdt )

torquenumber第二物体においての反作用力矩。
invdtnumber力を適用する時間の長さ。通常は反転された時間刻みまたは 1/dt (デルタ時間)です。

Joint:getType

関節の種類を文字列表現で取得します。

type = Joint:getType()

typeJointType関節における文字列による種類の名称。

Joint:getUserData

この関節へ関連付けられた Lua の値を返します。

value = Joint:getUserData()

valueany関節へ関連付けられた Lua の値。

Joint:isDestroyed

関節が破棄されたかどうかを取得します。破棄された関節は再利用できません。

destroyed = Joint:isDestroyed()

destroyedboolean関節が破棄されたかどうか。

Joint:setUserData

関節へ Lua の値を関連付けます。

参照を削除するには、明示的に nil を渡してください。

Joint:setUserData( value )

valueany関節へ関連付ける Lua の値。

MotorJoint

二つの物体間における相対運動を制御します。対象の支距に到達するために適用される発動機の最大力量および力矩と同様に、位置および回転支距を指定できます。

Constructors

Functions

Supertypes

MotorJoint:getAngularOffset

二つの物体に間取り付けられた関節における対象の角度で弧度による支距を取得します。

angularoffset = MotorJoint:getAngularOffset()

angularoffsetnumber対象の角度は弧度による支距です:最初の物体における角度は第二物体の角度を差し引いたものです。

MotorJoint:getLinearOffset

関節が取り付けられた二つの物体間にある対象の線形支距を取得します。

x, y = MotorJoint:getLinearOffset()

xnumber第一物体と関連する対象にある線形支距離の x 要素。
ynumber第一物体と関連する対象にある線形支距離の y 要素。

MotorJoint:setAngularOffset

二つの物体に間取り付けられた関節における対象の角度で弧度による支距を設定します。

MotorJoint:setAngularOffset( angularoffset )

angularoffsetnumber対象の角度は弧度による支距です:最初の物体における角度は第二物体の角度を差し引いたものです。

MotorJoint:setLinearOffset

関節が取り付けられた二つの物体間にある対象の線形支距を設定します。

MotorJoint:setLinearOffset( x, y )

xnumber第一物体と関連する対象にある線形支距離の x 要素。
ynumber第一物体と関連する対象にある線形支距離の y 要素。

MouseJoint

マウスにより操作するオブジェクトです。

Constructors

Functions

Supertypes

MouseJoint:getDampingRatio

減衰比を取得します。

ratio = MouseJoint:getDampingRatio()

rationumber減衰比。

MouseJoint:getFrequency

振動数を返します。

freq = MouseJoint:getFrequency()

freqnumberHz (ヘルツ) 単位での振動数。

MouseJoint:getMaxForce

最高許容力量を取得します。

f = MouseJoint:getMaxForce()

fnumber最高許容力量。

MouseJoint:getTarget

対象の位置を取得します。

x, y = MouseJoint:getTarget()

xnumber対象の x-要素。
ynumber対象の y-要素。

MouseJoint:setDampingRatio

新規の減衰比を設定します。

MouseJoint:setDampingRatio( ratio )

rationumber減衰比。

MouseJoint:setFrequency

新規の振動数を設定します。

MouseJoint:setFrequency( freq )

freqnumberHz (ヘルツ) 単位での新規振動数。

MouseJoint:setMaxForce

最高許容力量を設定します。

MouseJoint:setMaxForce( f )

fnumber最高許容力量。

MouseJoint:setTarget

対象の位置を設定します。

MouseJoint:setTarget( x, y )

xnumber対象の x-要素。
ynumber対象の y-要素。

PolygonShape

PolygonShape は八辺までの頂点を有する凸面の多角形です。

Constructors

Functions

Supertypes

PolygonShape:getPoints

多角形の頂点における局所座標を取得します。

この関数の返値は変数値です。この関数は love.graphics.polygon にて入れ子にするための方法として使用することができます。

x1, y1, x2, y2, ... = PolygonShape:getPoints()

x1numberThe x component of the first vertex.
y1numberThe y component of the first vertex.
x2numberThe x component of the second vertex.
y2numberThe y component of the second vertex.
...numberAdditional x and y values.

PrismaticJoint

共有軸において物体間の相対運動を制限します。

Constructors

Functions

Supertypes

PrismaticJoint:getAxis

直動関節において世界空間の軸ベクトルを取得します。

x, y = PrismaticJoint:getAxis()

xnumber世界空間における軸ベクトルの x 軸座標。
ynumber世界空間における軸ベクトルの y 軸座標。

PrismaticJoint:getJointSpeed

現在の関節における速度角を取得します。

s = PrismaticJoint:getJointSpeed()

snumber関節における弧度での速度角/秒数です。

PrismaticJoint:getJointTranslation

現在の関節における並進移動を取得します。

t = PrismaticJoint:getJointTranslation()

tnumber通常のメートル単位による関節における並進移動。

PrismaticJoint:getLimits

関節の制限を取得します。

lower, upper = PrismaticJoint:getLimits()

lowernumber通常のメートル単位による下限。
uppernumber通常のメートル単位による上限。

PrismaticJoint:getLowerLimit

下限を取得します。

lower = PrismaticJoint:getLowerLimit()

lowernumber通常のメートル単位による下限。

PrismaticJoint:getMaxMotorForce

発動機の最大力量を取得します。

f = PrismaticJoint:getMaxMotorForce()

fnumber通常の N (ニュートン)単位による発動機の最大力量。

PrismaticJoint:getMotorForce

発動機における現在の力量を返します。

f = PrismaticJoint:getMotorForce()

fnumberThe current motor force, usually in N.

PrismaticJoint:getMotorSpeed

発動機の速度を取得します。

s = PrismaticJoint:getMotorSpeed()

snumber1秒あたりの通常メートル単位による発動機の速度。

PrismaticJoint:getUpperLimit

上限を取得します。

upper = PrismaticJoint:getUpperLimit()

uppernumber通常のメートル単位による上限。

PrismaticJoint:hasLimitsEnabled

制限が有効かどうか確認します。

enabled = PrismaticJoint:hasLimitsEnabled()

enabledbooleantrue ならば有効であり、それ以外は false です。

PrismaticJoint:isMotorEnabled

発動機が作動しているか確認します。

enabled = PrismaticJoint:isMotorEnabled()

enabledbooleantrue ならば有効、 false ならば無効です。

PrismaticJoint:setLimits

制限を設定します。

PrismaticJoint:setLimits( lower, upper )

lowernumber弧度による上限。
uppernumber弧度による下限。

PrismaticJoint:setLimitsEnabled

関節の制限を有効・無効にします。

PrismaticJoint:setLimitsEnabled( enable )

enablebooleanTrue to enable, false to disable.

PrismaticJoint:setLowerLimit

下限を設定します。

PrismaticJoint:setLowerLimit( lower )

lowernumber通常のメートル単位による下限。

PrismaticJoint:setMaxMotorForce

発動機の最大力量を設定します。

PrismaticJoint:setMaxMotorForce( f )

fnumber通常の N (ニュートン)単位による発動機の最大力量。

PrismaticJoint:setMotorEnabled

接合部にある発動機の開始と停止を行います。

PrismaticJoint:setMotorEnabled( enable )

enablebooleanTrue to enable, false to disable.

PrismaticJoint:setMotorSpeed

発動機の速度を設定します。

PrismaticJoint:setMotorSpeed( s )

snumber1秒あたりの通常メートル単位による発動機の速度。

PrismaticJoint:setUpperLimit

上限を設定します。

PrismaticJoint:setUpperLimit( upper )

uppernumber通常のメートル単位による上限。

PulleyJoint

滑車を通して接続されている物体の模擬を可能にします。

Constructors

Functions

Supertypes

PulleyJoint:getConstant

縄の全長を取得します。

length = PulleyJoint:getConstant()

lengthnumber関節における縄の長さ。

PulleyJoint:getGroundAnchors

世界座標において基礎にある錨の位置を取得します。

a1x, a1y, a2x, a2y = PulleyJoint:getGroundAnchors()

a1xnumber第一錨の x 座標。
a1ynumber第一錨の y 座標。
a2xnumber第二錨の x 座標。
a2ynumber第二錨の y 座標。

PulleyJoint:getLengthA

第一物体に接触している縄の線分において現在の長さを取得します。

length = PulleyJoint:getLengthA()

lengthnumber縄の線分においての長さ。

PulleyJoint:getLengthB

第二物体に接触している縄の線分において現在の長さを取得します。

length = PulleyJoint:getLengthB()

lengthnumber縄の線分においての長さ。

PulleyJoint:getMaxLengths

縄の線分における最大長を取得します。

len1, len2 = PulleyJoint:getMaxLengths()

len1number第一線分における新規最大長。
len2number第二線分における新規最大長。

PulleyJoint:getRatio

滑車の比率を取得します。

ratio = PulleyJoint:getRatio()

rationumber関節における滑車の比率。

PulleyJoint:setConstant

縄の全長を設定します。

縄に対して新しい長さを設定すると関節における最大長の値が更新されます。

PulleyJoint:setConstant( length )

lengthnumber関節における縄の新しい長さ。

PulleyJoint:setMaxLengths

縄の線分における最大長を設定します。

物理演算モジュールは縄の線分に対して最大値を強制します。引数での値が超過する場合は、要求された値の代わりに最大値を設定します。

PulleyJoint:setMaxLengths( max1, max2 )

max1number第一線分における新規最大長。
max2number第二線分における新規最大長。

PulleyJoint:setRatio

滑車の比率を設定します。

PulleyJoint:setRatio( ratio )

rationumber関節における滑車の新規比率。

RevoluteJoint

二つの物体にて共有される地点を中心として回転できるようにします。

Constructors

Functions

Supertypes

RevoluteJoint:setLimitsEnabled

関節の制限を有効・無効にします。

RevoluteJoint:setLimitsEnabled( enable )

enablebooleantrue ならば有効、 false ならば無効です。

RevoluteJoint:setMotorEnabled

関節の発動機において開始および停止をします。

RevoluteJoint:setMotorEnabled( enable )

enablebooleantrue ならば有効、 false ならば無効です。

RevoluteJoint:getJointAngle

関節の現在角度を取得します。

angle = RevoluteJoint:getJointAngle()

anglenumber弧度による関節の角度。

RevoluteJoint:getJointSpeed

現在の関節における速度角を取得します。

s = RevoluteJoint:getJointSpeed()

snumber関節における弧度での速度角/秒数。

RevoluteJoint:getLimits

関節の制限を取得します。

lower, upper = RevoluteJoint:getLimits()

lowernumber弧度による上限。
uppernumber弧度による下限。

RevoluteJoint:getLowerLimit

下限を取得します。

lower = RevoluteJoint:getLowerLimit()

lowernumber弧度による下限。

RevoluteJoint:getMaxMotorTorque

発動機の最大力矩を返します。

f = RevoluteJoint:getMaxMotorTorque()

fnumberNm (ニュートン・メートル) 単位での発動機の最大力矩。

RevoluteJoint:getMotorSpeed

発動機の速度を取得します。

s = RevoluteJoint:getMotorSpeed()

snumber1秒あたりの弧度による発動機の速度。

RevoluteJoint:getMotorTorque

発動機の現在力矩を返します。

f = RevoluteJoint:getMotorTorque()

fnumberNm (ニュートン・メートル) 単位による発動機の現在力矩。

RevoluteJoint:getUpperLimit

上限を取得します。

upper = RevoluteJoint:getUpperLimit()

uppernumber弧度による上限。

RevoluteJoint:hasLimitsEnabled

制限が有効かどうか確認します。

enabled = RevoluteJoint:hasLimitsEnabled()

enabledbooleantrue ならば有効であり、それ以外は false です。

RevoluteJoint:isMotorEnabled

発動機が作動しているか確認します。

enabled = RevoluteJoint:isMotorEnabled()

enabledbooleantrue ならば有効、 false ならば無効です。

RevoluteJoint:setLimits

制限を設定します。

RevoluteJoint:setLimits( lower, upper )

lowernumber弧度による上限。
uppernumber弧度による下限。

RevoluteJoint:setLowerLimit

下限を設定します。

RevoluteJoint:setLowerLimit( lower )

lowernumber弧度による下限。

RevoluteJoint:setMaxMotorTorque

発動機の最大力矩を設定します。

RevoluteJoint:setMaxMotorTorque( f )

fnumberNm (ニュートン・メートル) 単位での発動機の最大力矩。

RevoluteJoint:setMotorSpeed

発動機の速度を設定します。

RevoluteJoint:setMotorSpeed( s )

snumber1秒あたりの弧度による発動機の速度。

RevoluteJoint:setUpperLimit

Sets the upper limit.

RevoluteJoint:setUpperLimit( upper )

uppernumberThe upper limit, in radians.

RopeJoint

RopeJoint は二つの物体上にある二地点間の最大距離を延長します。それ以外の効果はありません。

Constructors

Functions

Supertypes

RopeJoint:getMaxLength

RopeJoint の最大長を取得します。

maxLength = RopeJoint:getMaxLength()

maxLengthnumberRopeJoint の最大長。

Shape

形状は love.physics にて使用される物体にある固体の質量および衝突を扱うための二次元的な幾何学のオブジェクトです。

'''形状'''は Fixture を通して Body へ取り付けられます。このときに'''形状'''オブジェクトのコピーが行われます。

'''形状'''の位置は取り付けられた物体の位置と関連性があります。

Constructors