Difference between revisions of "love.load"

m (1 revision: Imported docs from potato.)
m (Arguments: Remove # from link text)
 
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
+
This function is called exactly once at the beginning of the game.
 
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.load( )
+
love.load( arg, unfilteredArg )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
None.
+
{{param|table|arg|Command-line arguments given to the game.}}
 +
{{New feature|11.0|
 +
{{param|table|unfilteredArg|Unfiltered command-line arguments given to the executable (see [[#Notes|Notes]]).}}
 +
|110}}
 +
 
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
== Notes ==
 +
In LÖVE 11.0, the passed arguments excludes the game name and the fused command-line flag (if exist) when runs from non-fused LÖVE executable. Previous version pass the argument as-is without any filtering.
 +
== Examples ==
 +
Establish some variables/resources on the game load, so that they can be used repeatedly in other functions (such as [[love.draw]]).
 +
 +
Run love with arguments to see them displayed: ''love . --hello''.
 +
<source lang="lua">
 +
local text, pos
 +
 +
function love.load(args)
 +
  local msg = args[1] or 'no arguments'
 +
  text = love.graphics.newText(love.graphics.getFont(), msg)
 +
  pos = {
 +
      x = 50,
 +
      y = 50,
 +
  }
 +
end
 +
 +
function love.update(dt)
 +
  if love.keyboard.isDown('right') then
 +
      pos.x = pos.x + 1
 +
  end
 +
end
 +
 +
function love.draw()
 +
  love.graphics.draw(text, pos.x, pos.y)
 +
end
 +
</source>
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love]]
 
* [[parent::love]]
 
[[Category:Callbacks]]
 
[[Category:Callbacks]]
{{#set:Description=}}
+
{{#set:Description=This function is called exactly once at the beginning of the game.}}
 +
{{#set:Subcategory=General}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|love.load}}

Latest revision as of 14:32, 11 July 2022

This function is called exactly once at the beginning of the game.

Function

Synopsis

love.load( arg, unfilteredArg )

Arguments

table arg
Command-line arguments given to the game.
Available since LÖVE 11.0
table unfilteredArg
Unfiltered command-line arguments given to the executable (see Notes).


Returns

Nothing.

Notes

In LÖVE 11.0, the passed arguments excludes the game name and the fused command-line flag (if exist) when runs from non-fused LÖVE executable. Previous version pass the argument as-is without any filtering.

Examples

Establish some variables/resources on the game load, so that they can be used repeatedly in other functions (such as love.draw).

Run love with arguments to see them displayed: love . --hello.

local text, pos

function love.load(args)
   local msg = args[1] or 'no arguments'
   text = love.graphics.newText(love.graphics.getFont(), msg)
   pos = {
       x = 50,
       y = 50,
   }
end

function love.update(dt)
   if love.keyboard.isDown('right') then
      pos.x = pos.x + 1
   end
end

function love.draw()
   love.graphics.draw(text, pos.x, pos.y)
end

See Also


Other Languages