OxeyeWiki - User contributions [en]

Main Page

2011-10-23T19:11:30Z

Thewreck:

== Welcome ==

Welcome to [http://www.oxeyegames.com Oxeye Game Studio's] wiki! In this wiki you will find information about Oxeye's games and tools. Feel free to register and collaborate!

Please note that this wiki is a knowledge base, and though you may use the discussion pages to talk about article issues, we strongly recommend using [http://reddit.oxeyegames.com/ our sub-reddit] instead.

File Objects

2010-02-07T23:24:25Z

Thewreck:

{{File}}

DaisyMoon contains classes for writing and reading binary files. These can be useful if you want to have greater control over the file structure, as Lua generally only works with strings and doubles in normal cases.

If you only want to write text to the file, it is recommended that you use the standard IO Lua library instead: [http://lua-users.org/wiki/IoLibraryTutorial Lua IO Tutorial]

== File Modes ==

The file objects can handle three different modes of writing and reading. This is chosen by giving different settings when creating the file objects.

=== File on Disk (f) ===

This is the default behaviour. The data will be written or read from a binary file on disk.

=== Compressed on Disk (z) ===

When writing a compressed file, all data will first be written into memory and then compressed (as a zip) before being written to disk. When reading a compressed file, the whole file will be read into memory and then unpacked.

=== In Memory (m) ===

You can also use the file objects to serialize things in memory (without writing to disk).

Engine Suggestions

2010-02-06T22:11:58Z

Thewreck:

== Under Evaluation ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|daisy|feature|A way to get the current daisymoon version.|}}
{{EngineSuggestion|video|feature|A way to enable/disable/get fullscreen from lua.|}}
{{EngineSuggestion|video|feature|A way to enable/disable/get v-sync from lua.|}}
{{EngineSuggestion|video|feature|A way to get a list of available screen modes.|}}
|}

== Implemented ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|physics|bug/feature|Re-use of body id's within the physics engine. An app will after long usage with creation and deletion of bodies start to print out warning messages|Fixed in DaisyMoon 1.1.0}}
{{EngineSuggestion|gui|feature|A way to set focus to an element|Added [[setFocus|element:setFocus()]] for edit fields in DaisyMoon 1.1.0}}
{{EngineSuggestion|daisy|feature|A way to restart the app from a command.|Added [[resetGame|daisy.resetGame()]] in DaisyMoon 1.1.0}}
{{EngineSuggestion|daisy|feature|output from print cannot be removed without restarting game. Would be awesome with a function to clear that printout|Added [[clearPrint|daisy.clearPrint()]] in DaisyMoon 1.1.0}}
{{EngineSuggestion|network|missing functionality|Hosts cannot disconnect individual clients|Added [[disconnectClient|network:disconnectClient(id)]] in DaisyMoon 1.1.0}}
|}

== Discarded ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}

Engine Suggestions

2010-02-06T22:10:56Z

Thewreck:

== Under Evaluation ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|daisy|feature|A way to get the current daisymoon version.|}}
{{EngineSuggestion|video|feature|A way to set fullscreen from lua.|}}
{{EngineSuggestion|video|feature|A way to enable/disable v-sync from lua.|}}
{{EngineSuggestion|video|feature|A way to get a list of available screen modes.|}}
|}

== Implemented ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|physics|bug/feature|Re-use of body id's within the physics engine. An app will after long usage with creation and deletion of bodies start to print out warning messages|Fixed in DaisyMoon 1.1.0}}
{{EngineSuggestion|gui|feature|A way to set focus to an element|Added [[setFocus|element:setFocus()]] for edit fields in DaisyMoon 1.1.0}}
{{EngineSuggestion|daisy|feature|A way to restart the app from a command.|Added [[resetGame|daisy.resetGame()]] in DaisyMoon 1.1.0}}
{{EngineSuggestion|daisy|feature|output from print cannot be removed without restarting game. Would be awesome with a function to clear that printout|Added [[clearPrint|daisy.clearPrint()]] in DaisyMoon 1.1.0}}
{{EngineSuggestion|network|missing functionality|Hosts cannot disconnect individual clients|Added [[disconnectClient|network:disconnectClient(id)]] in DaisyMoon 1.1.0}}
|}

== Discarded ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}

Engine Suggestions

2010-02-06T19:52:24Z

Thewreck:

== Under Evaluation ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|daisy|feature|A way to get the current daisymoon version.|}}
|}

== Implemented ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|physics|bug/feature|Re-use of body id's within the physics engine. An app will after long usage with creation and deletion of bodies start to print out warning messages|Fixed in DaisyMoon 1.1.0}}
{{EngineSuggestion|gui|feature|A way to set focus to an element|Added [[setFocus|element:setFocus()]] for edit fields in DaisyMoon 1.1.0}}
{{EngineSuggestion|daisy|feature|A way to restart the app from a command.|Added [[resetGame|daisy.resetGame()]] in DaisyMoon 1.1.0}}
{{EngineSuggestion|daisy|feature|output from print cannot be removed without restarting game. Would be awesome with a function to clear that printout|Added [[clearPrint|daisy.clearPrint()]] in DaisyMoon 1.1.0}}
{{EngineSuggestion|network|missing functionality|Hosts cannot disconnect individual clients|Added [[disconnectClient|network:disconnectClient(id)]] in DaisyMoon 1.1.0}}
|}

== Discarded ==
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}

Engine Suggestions

2010-02-06T17:09:16Z

Thewreck:

= Under Evaluation =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|physics|bug/feature|Re-use of body id's within the physics engine. An app will after long usage with creation and deletion of bodies start to print out warning messages|}}
{{EngineSuggestion|gui|feature|A way to set focus to an element|}}
{{EngineSuggestion|daisy|feature|A way to restart the app from a command.|}}
{{EngineSuggestion|daisy|feature|output from print cannot be removed without restarting game. Would be awesome with a function to clear that printout|}}
{{EngineSuggestion|network|missing functionality|Hosts cannot disconnect individual clients|}}
|}
= Implemented =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}
= Solved / Discarded =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}

Engine Suggestions

2010-02-06T17:06:45Z

Thewreck:

= Under Evaluation =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|gui|feature|A way to set focus to an element|}}
{{EngineSuggestion|daisy|feature|A way to restart the app from a command.|}}
{{EngineSuggestion|daisy|feature|output from print cannot be removed without restarting game. Would be awesome with a function to clear that printout|}}
{{EngineSuggestion|network|missing functionality|Hosts cannot disconnect individual clients|}}
|}
= Implemented =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}
= Solved / Discarded =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}

Engine Suggestions

2010-02-06T17:01:40Z

Thewreck:

= Under Evaluation =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-
{{EngineSuggestion|daisy|feature|A way to restart the app from a command.|}}
{{EngineSuggestion|daisy|feature|output from print cannot be removed without restarting game. Would be awesome with a function to clear that printout|}}
{{EngineSuggestion|network|missing functionality|Hosts cannot disconnect individual clients|}}
|}
= Implemented =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}
= Solved / Discarded =
{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#c7c7e0"| '''Library'''
|style="background:#c7c7e0"| '''Type'''
|style="background:#c7c7e0"| '''Problem/Suggestion'''
|style="background:#c7c7e0"| '''Comment'''
|-

|}

Engine Suggestions

2010-02-06T16:15:19Z

Thewreck:

Engine Suggestions

2010-02-06T16:15:04Z

Thewreck: Created page with '= Under Evaluation = {| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;" |- |style="background:#c7c7e0"| '''Library''' |style="backgro...'

Template:EngineSuggestion

2010-02-06T16:14:36Z

Thewreck:

|{{{1}}} || {{{2}}} || {{{3}}} || {{{4}}}
|-

Template:EngineSuggestion

2010-02-06T16:00:45Z

Thewreck: Created page with '|{{{1}}} || {{{2}}} || {{{3}}} |-'

|{{{1}}} || {{{2}}} || {{{3}}}
|-

Category:Daisymoon

2010-02-06T15:30:44Z

Thewreck: /* Daisymoon API */

== Getting Started ==

* [[Introduction to Daisymoon]]
** [[Projects Using Daisymoon]]
** [[DaisyMoon License]]
* [[Daisymoon Tools|Tools]]
* '''Tutorials'''
* '''Examples'''
** [[SimpleBreak]] - Super simple break-out game

== Daisymoon API ==

* [[DaisyMoon Application]]
* [[Daisy Library]]
** [[Engine Hooks]]
* [[Video Library]]
* [[Audio Library]]
* [[Physics Object]]
* [[File Objects]]
* [[Network Library]]
* [[GUI Library]]
** [[GUI Artwork]]

== Getting Involved ==

* [[Engine Suggestions]]

== Oxeye Game Studio Texture Packages ==

* [[Texture Builder]]

== Other Resources ==

* [http://lua-users.org/ Lua Users Wiki]
* [http://lua-users.org/wiki/MathLibraryTutorial Lua Math Library]
* [http://lua-users.org/wiki/StringLibraryTutorial Lua String Library]

GetMousePosition

2010-01-29T14:01:14Z

Thewreck:

{{DaisyMethod |
daisy.getMousePosition()
|
This method returns the X and Y position of the mouse, relative to the top-left corner of the application's active surface.
|
{{NoParams}}
|
Returns two values to the stack, X and Y values of the mouse.
}}
=== Example ===
<pre>
local x, y = daisy.getMousePosition()
</pre>

SetScissorClip

2010-01-25T02:05:42Z

Thewreck:

{{VideoMethod
|
video.setScissorClip(left, top, right, bottom)
|
Sets the video device's "scissor clip" area. This area is a rectangle on the screen in which rendering should be allowed. All pixels that are rendered outside of this rectangle will not be displayed.

The scissor clip can be used, for example, to create split-screen multiplayer. To do this, render the whole game twice, using an on-screen off-set for the second half. See the example below.

Use [[clearScissorClip]] to reset the clip again.
|
{{MethodParam|left|An integer|The left edge of the rectangle (inclusive).}}
{{MethodParam|top|An integer|The top edge of the rectangle (inclusive).}}
{{MethodParam|right|An integer|The right edge of the rectangle (exclusive).}}
{{MethodParam|bottom|An integer|The bottom edge of the rectangle (exclusive).}}
|
Returns nothing.
}}
=== Example ===
<pre>
local function renderSplit(offsetX, offsetY)
-- render all sprites etc
end

local function renderAll()

local screenW, screenH = video.getScreenSize()

-- split vertically (one view on the left and one on the right)
local halfWidth = screenW / 2

-- render player A's view
video.setScissorClip(0, 0, halfWidth, screenH)
renderSplit(0, 0)

-- render player B's view
video.setScissorClip(halfWidth, 0, screenW, screenH)
renderSplit(halfWidth, 0)

-- reset clip
video.clearScissorClip()

-- render shared stuff here, such as top layer GUI etc
end
</pre>

JoystickButtonPressed

2010-01-19T20:16:02Z

Thewreck: Created page with '{{EngineHook| joystickButtonPressed | This hook is called when a joystick button changes state from not pressed to pressed. | {{MethodParam|joystick|A number|This is the joystick...'

{{EngineHook|
joystickButtonPressed
|
This hook is called when a joystick button changes state from not pressed to pressed.
|
{{MethodParam|joystick|A number|This is the joystick Id of the joystick the button belongs to.}}
{{MethodParam|button|A number|This is button number on the joystick.}}
}}
=== Example ===
<pre>
local function joystickButtonHasBeenPressed(joy, btn)
print("joystick "..joy.. " button "..btn.. " pressed.")
end

hook.add("joystickButtonPressed", joystickButtonHasBeenPressed)
</pre>

GameInit

2010-01-19T20:12:08Z

Thewreck: Created page with '{{EngineHook| gameInit | This hook is called when the game is started. | {{NoParams}} }} === Example === <pre> local function myGameHasStarted() --initialize stuff! end ...'

{{EngineHook|
gameInit
|
This hook is called when the game is started.
|
{{NoParams}}
}}
=== Example ===
<pre>
local function myGameHasStarted()
--initialize stuff!
end

hook.add("gameInit", myGameHasStarted)
</pre>

GameClose

2010-01-19T12:54:12Z

Thewreck: Created page with '{{EngineHook| gameClose | This hook is called when the game is closed, either by Alt+f4 (Windows), Cmd+Q (Mac), or by the function daisy.exitGame | {{NoParams}} }} === Exampl...'

{{EngineHook|
gameClose
|
This hook is called when the game is closed, either by Alt+f4 (Windows), Cmd+Q (Mac), or by the function daisy.[[exitGame]]
|
{{NoParams}}
}}
=== Example ===
<pre>
local function myGameIsClosing()
--do some cleanup
end

hook.add("gameClose", myGameIsClosing)
</pre>

FrameUpdate

2010-01-19T12:44:50Z

Thewreck: Created page with '{{EngineHook| frameUpdate | This hook is called everytime the game needs to be updated. Things that change over time should be performed here. | {{MethodParam|time|A number|This ...'

{{EngineHook|
frameUpdate
|
This hook is called everytime the game needs to be updated. Things that change over time should be performed here.
|
{{MethodParam|time|A number|This is the time passed since the last frameUpdate, in seconds.}}
}}
=== Example ===
<pre>
local totalPassedTime = 0

local function updateMyGame(time)
totalPassedTime = totalPassedTime + time
end

hook.add("frameUpdate", updateMyGame)
</pre>

Template:EngineHook

2010-01-19T12:41:14Z

Thewreck:

{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#cab6dd; font-size:150%;" colspan="3"| '''{{{1}}}'''
|-
|colspan="3"| {{{2}}}
|-
|style="background:#cab6dd"| '''Parameter'''
|style="background:#cab6dd"| '''Type'''
|style="background:#cab6dd"| '''Description'''
|-
{{{3}}}
|-
|} {{Daisy}}
<noinclude>
{{EngineHook|
hookName
|
This is an example usage of the DaisyMethod template. Daisy library methods should contain this template, with the
paramters for method name, description, parameter list and return values, and then an example of how the
method is used.
|
{{MethodParam|time|A number|This is a parameter using the MethodParam template.}}
}}
</noinclude>

FrameRender

2010-01-19T12:39:07Z

Thewreck: Created page with '{{EngineHook| frameRender | This hook is called everytime the game is rendered. No changes to the game should be made during this call, thus, no time variable is included. | {{No...'

{{EngineHook|
frameRender
|
This hook is called everytime the game is rendered. No changes to the game should be made during this call, thus, no time variable is included.
|
{{NoParams}}
}}
=== Example ===
<pre>
local function renderMyGame()
end

hook.add("frameRender", renderMyGame)
</pre>

Template:EngineHook

2010-01-19T12:36:02Z

Thewreck:

{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#cab6dd; font-size:150%;" colspan="3"| '''{{{1}}}'''
|-
|colspan="3"| {{{2}}}
|-
|style="background:#cab6dd"| '''Parameter'''
|style="background:#cab6dd"| '''Type'''
|style="background:#cab6dd"| '''Description'''
|-
{{{3}}}
|-
|} {{Daisy}}
<noinclude>
{{EngineHook|
gameRender
|
This is an example usage of the DaisyMethod template. Daisy library methods should contain this template, with the
paramters for method name, description, parameter list and return values, and then an example of how the
method is used.
|
{{MethodParam|time|A number|This is a parameter using the MethodParam template.}}
}}
</noinclude>

Template:EngineHook

2010-01-19T12:34:25Z

Thewreck:

{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#cab6dd; font-size:150%;" colspan="3"| '''{{{1}}}'''
|-
|colspan="3"| {{{2}}}
|-
|style="background:#cab6dd"| '''Parameter'''
|style="background:#cab6dd"| '''Type'''
|style="background:#cab6dd"| '''Description'''
|-
{{{3}}}
|} {{Daisy}}
<noinclude>

{{EngineHook|
gameRender
|
This is an example usage of the DaisyMethod template. Daisy library methods should contain this template, with the
paramters for method name, description, parameter list and return values, and then an example of how the
method is used.
|
{{MethodParam|time|A number|This is a parameter using the MethodParam template.}}
}}
</noinclude>

Template:EngineHook

2010-01-19T12:32:36Z

Thewreck:

{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#cab6dd; font-size:150%;" colspan="3"| '''{{{1}}}'''
|-
|colspan="3"| {{{2}}}
|-
|style="background:#cab6dd"| '''Parameter'''
|style="background:#cab6dd"| '''Type'''
|style="background:#cab6dd"| '''Description'''
|-
|colspan="3"| {{{3}}}
|} {{Daisy}}
<noinclude>

{{EngineHook|
gameRender
|
This is an example usage of the DaisyMethod template. Daisy library methods should contain this template, with the
paramters for method name, description, parameter list and return values, and then an example of how the
method is used.
|
{{MethodParam|time|A number|This is a parameter using the MethodParam template.}}
}}
</noinclude>

Template:EngineHook

2010-01-19T12:32:21Z

Thewreck:

{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#cab6dd; font-size:150%;" colspan="3"| '''{{{1}}}'''
|-
|colspan="3"| {{{2}}}
|-
|style="background:#cab6dd"| '''Parameter'''
|style="background:#cab6dd"| '''Type'''
|style="background:#cab6dd"| '''Description'''
|- '''Callback parameters'''
|colspan="3"| {{{3}}}
|} {{Daisy}}
<noinclude>

{{EngineHook|
gameRender
|
This is an example usage of the DaisyMethod template. Daisy library methods should contain this template, with the
paramters for method name, description, parameter list and return values, and then an example of how the
method is used.
|
{{MethodParam|time|A number|This is a parameter using the MethodParam template.}}
}}
</noinclude>

Template:EngineHook

2010-01-19T12:30:13Z

Thewreck:

{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#cab6dd; font-size:150%;" colspan="3"| '''{{{1}}}'''
|-
|colspan="3"| {{{2}}}
|-
|style="background:#cab6dd"| '''Parameter'''
|style="background:#cab6dd"| '''Type'''
|style="background:#cab6dd"| '''Description'''
|-
|colspan="3"| Callback parameters: {{{3}}}
|} {{Daisy}}
<noinclude>

{{EngineHook|
gameRender
|
This is an example usage of the DaisyMethod template. Daisy library methods should contain this template, with the
paramters for method name, description, parameter list and return values, and then an example of how the
method is used.
|
{{MethodParam|time|A number|This is a parameter using the MethodParam template.}}
}}
</noinclude>

Template:EngineHook

2010-01-19T12:28:59Z

Thewreck: Created page with '{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;" |- |style="background:#cab6dd; font-size:150%;" colspan="3"|"'''{{{1}}}'''" |- |co...'

{| border=2 cellpadding=3 cellspacing=0 style="margin: 0 0 1em 1em; border-collapse: collapse;"
|-
|style="background:#cab6dd; font-size:150%;" colspan="3"|"'''{{{1}}}'''"
|-
|colspan="3"| {{{2}}}
|-
|style="background:#cab6dd"| '''Parameter'''
|style="background:#cab6dd"| '''Type'''
|style="background:#cab6dd"| '''Description'''
|-
|colspan="3"| Callback parameters: {{{3}}}
|} {{Daisy}}
<noinclude>

{{EngineHook|
gameRender
|
This is an example usage of the DaisyMethod template. Daisy library methods should contain this template, with the
paramters for method name, description, parameter list and return values, and then an example of how the
method is used.
|
{{MethodParam|time|A number|This is a parameter using the MethodParam template.}}
}}
</noinclude>

SetMousePosition

2010-01-19T12:15:19Z

Thewreck: Created page with '{{DaisyMethod | daisy.setMousePosition(x,y) | This method sets the mouse position. | {{MethodParam|x|A number|0 is the left edge of the application. Value is in pixels.}} {{Meth...'

{{DaisyMethod |
daisy.setMousePosition(x,y)
|
This method sets the mouse position.
|
{{MethodParam|x|A number|0 is the left edge of the application. Value is in pixels.}}
{{MethodParam|y|A number|0 is the top edge of the application. Value is in pixels.}}
|
Returns nothing.
}}
=== Example ===
<pre>
daisy.setMousePosition(10,10)
</pre>

IsMouseButtonPressed

2010-01-19T12:13:28Z

Thewreck: Created page with '{{DaisyMethod | daisy.isMouseButtonPressed(button) | This method returns true if the specified button is pressed down. | {{MethodParam|button|A number|0 being left, 1 being right...'

{{DaisyMethod |
daisy.isMouseButtonPressed(button)
|
This method returns true if the specified button is pressed down.
|
{{MethodParam|button|A number|0 being left, 1 being right.}}
|
Returns one Boolean, true if button is pressed, false otherwise.
}}
=== Example ===
<pre>
local leftMouseButtonDown = daisy.isMouseButtonPressed(0)
</pre>

IsMac

2010-01-18T17:20:47Z

Thewreck: Created page with '{{DaisyMethod | daisy.isMac() | This method checks if the application is ran on a Mac OS X. | {{NoParams}} | Returns one Boolean, true if Mac OS X, false otherwise. }} === Exampl...'

{{DaisyMethod |
daisy.isMac()
|
This method checks if the application is ran on a Mac OS X.
|
{{NoParams}}
|
Returns one Boolean, true if Mac OS X, false otherwise.
}}
=== Example ===
<pre>
local onAMac = daisy.isMac()
</pre>

KeyCodes

2010-01-18T17:18:59Z

Thewreck:

Taken from: [http://msdn.microsoft.com/en-us/library/aa243025%28VS.60%29.aspx Microsoft Key-code Constans]
<pre>
Key Codes
Constant keyCode Description
vbKeyLButton 1 Left mouse button
vbKeyRButton 2 Right mouse button
vbKeyCancel 3 CANCEL key
vbKeyMButton 4 Middle mouse button
vbKeyBack 8 BACKSPACE key
vbKeyTab 9 TAB key
vbKeyClear 12 CLEAR key
vbKeyReturn 13 ENTER key
vbKeyShift 16 SHIFT key
vbKeyControl 17 CTRL key
vbKeyMenu 18 MENU key
vbKeyPause 19 PAUSE key
vbKeyCapital 20 CAPS LOCK key
vbKeyEscape 27 ESC key
vbKeySpace 32 SPACEBAR key
vbKeyPageUp 33 PAGE UP key
vbKeyPageDown 34 PAGE DOWN key
vbKeyEnd 35 END key
vbKeyHome 36 HOME key
vbKeyLeft 37 LEFT ARROW key
vbKeyUp 38 UP ARROW key
vbKeyRight 39 RIGHT ARROW key
vbKeyDown 40 DOWN ARROW key
vbKeySelect 41 SELECT key
vbKeyPrint 42 PRINT SCREEN key
vbKeyExecute 43 EXECUTE key
vbKeySnapshot 44 SNAPSHOT key
vbKeyInsert 45 INS key
vbKeyDelete 46 DEL key
vbKeyHelp 47 HELP key
vbKeyNumlock 144 NUM LOCK key

KeyA Through KeyZ Are the Same as Their ASCII Equivalents: 'A' Through 'Z'
Constant keyCode Description
vbKeyA 65 A key
vbKeyB 66 B key
vbKeyC 67 C key
vbKeyD 68 D key
vbKeyE 69 E key
vbKeyF 70 F key
vbKeyG 71 G key
vbKeyH 72 H key
vbKeyI 73 I key
vbKeyJ 74 J key
vbKeyK 75 K key
vbKeyL 76 L key
vbKeyM 77 M key
vbKeyN 78 N key
vbKeyO 79 O key
vbKeyP 80 P key
vbKeyQ 81 Q key
vbKeyR 82 R key
vbKeyS 83 S key
vbKeyT 84 T key
vbKeyU 85 U key
vbKeyV 86 V key
vbKeyW 87 W key
vbKeyX 88 X key
vbKeyY 89 Y key
vbKeyZ 90 Z key

Key0 Through Key9 Are the Same as Their ASCII Equivalents: '0' Through '9
Constant keyCode Description
vbKey0 48 0 key
vbKey1 49 1 key
vbKey2 50 2 key
vbKey3 51 3 key
vbKey4 52 4 key
vbKey5 53 5 key
vbKey6 54 6 key
vbKey7 55 7 key
vbKey8 56 8 key
vbKey9 57 9 key

Keys on the Numeric Keypad
Constant keyCode Description
vbKeyNumpad0 96 0 key
vbKeyNumpad1 97 1 key
vbKeyNumpad2 98 2 key
vbKeyNumpad3 99 3 key
vbKeyNumpad4 100 4 key
vbKeyNumpad5 101 5 key
vbKeyNumpad6 102 6 key
vbKeyNumpad7 103 7 key
vbKeyNumpad8 104 8 key
vbKeyNumpad9 105 9 key
vbKeyMultiply 106 MULTIPLICATION SIGN (*) key
vbKeyAdd 107 PLUS SIGN (+) key
vbKeySeparator 108 ENTER (keypad) key
vbKeySubtract 109 MINUS SIGN (-) key
vbKeyDecimal 110 DECIMAL POINT(.) key
vbKeyDivide 111 DIVISION SIGN (/) key

Function Keys
Constant keyCode Description
vbKeyF1 112 F1 key
vbKeyF2 113 F2 key
vbKeyF3 114 F3 key
vbKeyF4 115 F4 key
vbKeyF5 116 F5 key
vbKeyF6 117 F6 key
vbKeyF7 118 F7 key
vbKeyF8 119 F8 key
vbKeyF9 120 F9 key
vbKeyF10 121 F10 key
vbKeyF11 122 F11 key
vbKeyF12 123 F12 key
vbKeyF13 124 F13 key
vbKeyF14 125 F14 key
vbKeyF15 126 F15 key
vbKeyF16 127 F16 key
</pre>

KeyCodes

2010-01-18T17:18:21Z

Thewreck:

Taken from: [http://msdn.microsoft.com/en-us/library/aa243025%28VS.60%29.aspx Microsoft Key-code Constans]
<pre>
Key Codes
Constant Value Description
vbKeyLButton 1 Left mouse button
vbKeyRButton 2 Right mouse button
vbKeyCancel 3 CANCEL key
vbKeyMButton 4 Middle mouse button
vbKeyBack 8 BACKSPACE key
vbKeyTab 9 TAB key
vbKeyClear 12 CLEAR key
vbKeyReturn 13 ENTER key
vbKeyShift 16 SHIFT key
vbKeyControl 17 CTRL key
vbKeyMenu 18 MENU key
vbKeyPause 19 PAUSE key
vbKeyCapital 20 CAPS LOCK key
vbKeyEscape 27 ESC key
vbKeySpace 32 SPACEBAR key
vbKeyPageUp 33 PAGE UP key
vbKeyPageDown 34 PAGE DOWN key
vbKeyEnd 35 END key
vbKeyHome 36 HOME key
vbKeyLeft 37 LEFT ARROW key
vbKeyUp 38 UP ARROW key
vbKeyRight 39 RIGHT ARROW key
vbKeyDown 40 DOWN ARROW key
vbKeySelect 41 SELECT key
vbKeyPrint 42 PRINT SCREEN key
vbKeyExecute 43 EXECUTE key
vbKeySnapshot 44 SNAPSHOT key
vbKeyInsert 45 INS key
vbKeyDelete 46 DEL key
vbKeyHelp 47 HELP key
vbKeyNumlock 144 NUM LOCK key

KeyA Through KeyZ Are the Same as Their ASCII Equivalents: 'A' Through 'Z'
Constant Value Description
vbKeyA 65 A key
vbKeyB 66 B key
vbKeyC 67 C key
vbKeyD 68 D key
vbKeyE 69 E key
vbKeyF 70 F key
vbKeyG 71 G key
vbKeyH 72 H key
vbKeyI 73 I key
vbKeyJ 74 J key
vbKeyK 75 K key
vbKeyL 76 L key
vbKeyM 77 M key
vbKeyN 78 N key
vbKeyO 79 O key
vbKeyP 80 P key
vbKeyQ 81 Q key
vbKeyR 82 R key
vbKeyS 83 S key
vbKeyT 84 T key
vbKeyU 85 U key
vbKeyV 86 V key
vbKeyW 87 W key
vbKeyX 88 X key
vbKeyY 89 Y key
vbKeyZ 90 Z key

Key0 Through Key9 Are the Same as Their ASCII Equivalents: '0' Through '9
Constant Value Description
vbKey0 48 0 key
vbKey1 49 1 key
vbKey2 50 2 key
vbKey3 51 3 key
vbKey4 52 4 key
vbKey5 53 5 key
vbKey6 54 6 key
vbKey7 55 7 key
vbKey8 56 8 key
vbKey9 57 9 key

Keys on the Numeric Keypad
Constant Value Description
vbKeyNumpad0 96 0 key
vbKeyNumpad1 97 1 key
vbKeyNumpad2 98 2 key
vbKeyNumpad3 99 3 key
vbKeyNumpad4 100 4 key
vbKeyNumpad5 101 5 key
vbKeyNumpad6 102 6 key
vbKeyNumpad7 103 7 key
vbKeyNumpad8 104 8 key
vbKeyNumpad9 105 9 key
vbKeyMultiply 106 MULTIPLICATION SIGN (*) key
vbKeyAdd 107 PLUS SIGN (+) key
vbKeySeparator 108 ENTER (keypad) key
vbKeySubtract 109 MINUS SIGN (-) key
vbKeyDecimal 110 DECIMAL POINT(.) key
vbKeyDivide 111 DIVISION SIGN (/) key

Function Keys
Constant Value Description
vbKeyF1 112 F1 key
vbKeyF2 113 F2 key
vbKeyF3 114 F3 key
vbKeyF4 115 F4 key
vbKeyF5 116 F5 key
vbKeyF6 117 F6 key
vbKeyF7 118 F7 key
vbKeyF8 119 F8 key
vbKeyF9 120 F9 key
vbKeyF10 121 F10 key
vbKeyF11 122 F11 key
vbKeyF12 123 F12 key
vbKeyF13 124 F13 key
vbKeyF14 125 F14 key
vbKeyF15 126 F15 key
vbKeyF16 127 F16 key
</pre>

KeyCodes

2010-01-18T17:17:30Z

Thewreck: Created page with '<pre> Key Codes Constant Value Description vbKeyLButton 1 Left mouse button vbKeyRButton 2 Right mouse button vbKeyCancel 3 CANCEL key vbKeyMButton 4 Middle mouse butto...'

<pre>
Key Codes
Constant Value Description
vbKeyLButton 1 Left mouse button
vbKeyRButton 2 Right mouse button
vbKeyCancel 3 CANCEL key
vbKeyMButton 4 Middle mouse button
vbKeyBack 8 BACKSPACE key
vbKeyTab 9 TAB key
vbKeyClear 12 CLEAR key
vbKeyReturn 13 ENTER key
vbKeyShift 16 SHIFT key
vbKeyControl 17 CTRL key
vbKeyMenu 18 MENU key
vbKeyPause 19 PAUSE key
vbKeyCapital 20 CAPS LOCK key
vbKeyEscape 27 ESC key
vbKeySpace 32 SPACEBAR key
vbKeyPageUp 33 PAGE UP key
vbKeyPageDown 34 PAGE DOWN key
vbKeyEnd 35 END key
vbKeyHome 36 HOME key
vbKeyLeft 37 LEFT ARROW key
vbKeyUp 38 UP ARROW key
vbKeyRight 39 RIGHT ARROW key
vbKeyDown 40 DOWN ARROW key
vbKeySelect 41 SELECT key
vbKeyPrint 42 PRINT SCREEN key
vbKeyExecute 43 EXECUTE key
vbKeySnapshot 44 SNAPSHOT key
vbKeyInsert 45 INS key
vbKeyDelete 46 DEL key
vbKeyHelp 47 HELP key
vbKeyNumlock 144 NUM LOCK key

KeyA Through KeyZ Are the Same as Their ASCII Equivalents: 'A' Through 'Z'
Constant Value Description
vbKeyA 65 A key
vbKeyB 66 B key
vbKeyC 67 C key
vbKeyD 68 D key
vbKeyE 69 E key
vbKeyF 70 F key
vbKeyG 71 G key
vbKeyH 72 H key
vbKeyI 73 I key
vbKeyJ 74 J key
vbKeyK 75 K key
vbKeyL 76 L key
vbKeyM 77 M key
vbKeyN 78 N key
vbKeyO 79 O key
vbKeyP 80 P key
vbKeyQ 81 Q key
vbKeyR 82 R key
vbKeyS 83 S key
vbKeyT 84 T key
vbKeyU 85 U key
vbKeyV 86 V key
vbKeyW 87 W key
vbKeyX 88 X key
vbKeyY 89 Y key
vbKeyZ 90 Z key

Key0 Through Key9 Are the Same as Their ASCII Equivalents: '0' Through '9
Constant Value Description
vbKey0 48 0 key
vbKey1 49 1 key
vbKey2 50 2 key
vbKey3 51 3 key
vbKey4 52 4 key
vbKey5 53 5 key
vbKey6 54 6 key
vbKey7 55 7 key
vbKey8 56 8 key
vbKey9 57 9 key

Keys on the Numeric Keypad
Constant Value Description
vbKeyNumpad0 96 0 key
vbKeyNumpad1 97 1 key
vbKeyNumpad2 98 2 key
vbKeyNumpad3 99 3 key
vbKeyNumpad4 100 4 key
vbKeyNumpad5 101 5 key
vbKeyNumpad6 102 6 key
vbKeyNumpad7 103 7 key
vbKeyNumpad8 104 8 key
vbKeyNumpad9 105 9 key
vbKeyMultiply 106 MULTIPLICATION SIGN (*) key
vbKeyAdd 107 PLUS SIGN (+) key
vbKeySeparator 108 ENTER (keypad) key
vbKeySubtract 109 MINUS SIGN (-) key
vbKeyDecimal 110 DECIMAL POINT(.) key
vbKeyDivide 111 DIVISION SIGN (/) key

Function Keys
Constant Value Description
vbKeyF1 112 F1 key
vbKeyF2 113 F2 key
vbKeyF3 114 F3 key
vbKeyF4 115 F4 key
vbKeyF5 116 F5 key
vbKeyF6 117 F6 key
vbKeyF7 118 F7 key
vbKeyF8 119 F8 key
vbKeyF9 120 F9 key
vbKeyF10 121 F10 key
vbKeyF11 122 F11 key
vbKeyF12 123 F12 key
vbKeyF13 124 F13 key
vbKeyF14 125 F14 key
vbKeyF15 126 F15 key
vbKeyF16 127 F16 key
</pre>

IsKeyPressed

2010-01-18T17:15:44Z

Thewreck:

{{DaisyMethod |
daisy.isKeyPressed(keyCode)
|
This method returns true if the specified key is pressed down.
|
{{MethodParam|keyCode|A number| A keyCode representing a key, see [[keyCodes]]}}
|
Returns one Boolean, true if key is pressed, false otherwise.
}}
=== Example ===
<pre>
local enterPressed = daisy.isKeyPressed(13)
</pre>

IsKeyPressed

2010-01-18T17:15:12Z

Thewreck: Created page with '{{DaisyMethod | daisy.isKeyPressed(keyCode) | This method returns true if the specified key is pressed down. | {{MethodParam|keyCode|A number representing a key, see keyCodes...'

{{DaisyMethod |
daisy.isKeyPressed(keyCode)
|
This method returns true if the specified key is pressed down.
|
{{MethodParam|keyCode|A number representing a key, see [[keyCodes]]}}
|
Returns one Boolean, true if key is pressed, false otherwise.
}}
=== Example ===
<pre>
local enterPressed = daisy.isKeyPressed(13)
</pre>

GetUserFolderPath

2010-01-18T17:04:17Z

Thewreck: Created page with '{{DaisyMethod | daisy.getUserFolderPath(pathName) | This method returns the absolute path to the computers "user" path. On Mac OS X this is located in the user library. This meth...'

{{DaisyMethod |
daisy.getUserFolderPath(pathName)
|
This method returns the absolute path to the computers "user" path. On Mac OS X this is located in the user library. This method also creates a sub folder if specified. On many systems, the game cannot create new files outside of this folder.
|
{{MethodParam|pathName|A string|Additional path relative to the user folder, this folder will be created if it doesn't exist.}}
|
Returns one String, the absolute complete path on the system to the user folder with the added pathName.
}}
=== Example ===
<pre>
local userFolderPath = daisy.getUserFolderPath()
local saveGamePath = daisy.getUserFolderPath("saves")
</pre>

GetMousePosition

2010-01-18T16:58:16Z

Thewreck: Created page with '{{DaisyMethod | daisy.getMousePosition() | This method returns the X and Y position of the mouse, relative to the top-left corner of the application's active surface. | {{NoParam...'

{{DaisyMethod |
daisy.getMousePosition()
|
This method returns the X and Y position of the mouse, relative to the top-left corner of the application's active surface.
|
{{NoParams}}
|
Returns two values to the stack, X and Y values of the sticks, ranging from -1 to 1.
}}
=== Example ===
<pre>
local x, y = daisy.getMousePosition()
</pre>

GetJoystickAxises

2010-01-18T16:56:47Z

Thewreck: Created page with '{{DaisyMethod | daisy.getJoystickAxises(joystick, stick) | This method returns the X and Y component of a chosen joystick's specified stick. | {{MethodParam|joystick|A number|The...'

{{DaisyMethod |
daisy.getJoystickAxises(joystick, stick)
|
This method returns the X and Y component of a chosen joystick's specified stick.
|
{{MethodParam|joystick|A number|The joystick Id, for example gotten through the hook [[joystickButtonPressed]]. Starting at 1 }}
{{MethodParam|stick|A number|The stick to get axis data from. Starting at 1.}}
|
Returns two values to the stack, X and Y values of the sticks, ranging from -1 to 1.
}}
=== Example ===
<pre>
local xAxis, yAxis = daisy.getJoystickAxises(1, 1)
</pre>

GetFolderContents

2010-01-18T16:42:16Z

Thewreck: Created page with '{{DaisyMethod | daisy.getFolderContents(folderName [, extensionFilter]) | This method returns the contents of a folder as a lua table. | {{MethodParam|folderName|A string|The nam...'

{{DaisyMethod |
daisy.getFolderContents(folderName [, extensionFilter])
|
This method returns the contents of a folder as a lua table.
|
{{MethodParam|folderName|A string|The name of the folder to look in. Relative to the execution directory. The name is case sensitive on Mac OS X.}}
{{MethodParam|extensionFilter|A string|Specified to filter for a certain file extension type.}}
|
Returns a number indexed table containing the folder and file-names as strings.
}}
=== Example ===
<pre>
local sourceFiles = daisy.getFolderContents("daisyMoon")

local saveGames = daisy.getFolderContents("saves", "*.saveGame")
</pre>

ExitGame

2010-01-18T16:32:38Z

Thewreck:

{{DaisyMethod |
daisy.exitGame()
|
This method closes the application.
|
{{NoParams}}
|
Doesn't return anything.
}}
=== Example ===
<pre>
daisy.exitGame()
</pre>

ExitGame

2010-01-18T16:32:23Z

Thewreck: Created page with '{{DaisyMethod | daisy.exitGame() | This method closes the application. | {{NoParamas}} | Doesn't return anything. }} === Example === <pre> daisy.exitGame() </pre>'

{{DaisyMethod |
daisy.exitGame()
|
This method closes the application.
|
{{NoParamas}}
|
Doesn't return anything.
}}
=== Example ===
<pre>
daisy.exitGame()
</pre>

PlayOrientedSound

2010-01-18T16:26:24Z

Thewreck:

{{AudioMethod
|
audio.playOrientedSound(soundFilename [, gain [, modulation [, x, y, z, [speedX, speedY, speedZ])
|
Plays an audio file with a position in space, once. The volume and panning is then calculated based on the [[setSoundListenerPosition]].
|
{{MethodParam|soundFilename|A string|The name of the audio file, relative to the source folder. The name is case sensitive on Mac OS X.}}
{{MethodParam|gain|A number|The power at which the sound is emitted.}}
{{MethodParam|modulation|A number|How pitch shifted the sound should be. Original pitch is 1.}}
{{MethodParam|x|A number|Position in space, in meters.}}
{{MethodParam|y|A number|Position in space, in meters.}}
{{MethodParam|z|A number|Position in space, in meters.}}
{{MethodParam|speedX|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedY|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedZ|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
|
Returns nothing.
}}
=== Example ===
<pre>
local bomb = {x = 120, y = 200}
local res = 1/32 -- 32 pixels is one meter.
audio.playOrientedSound("boom.wav", 4, 1, bomb.x*res, bomb.y*res, 0)

--at center of the world, randomly pitched coins dance
audio.playOrientedSound("coin.wav", 1, 0.75+math.random()*0.5, 0, 0, 0)
</pre>

PlayOrientedSound

2010-01-18T13:55:43Z

Thewreck:

{{AudioMethod
|
audio.playOrientedSound(soundFilename, gain, modulation, x, y, z, [speedX, speedY, speedZ])
|
Plays an audio file with a position in space, once. The volume and panning is then calculated based on the [[setSoundListenerPosition]].
|
{{MethodParam|soundFilename|A string|The name of the audio file, relative to the source folder. The name is case sensitive on Mac OS X.}}
{{MethodParam|gain|A number|The power at which the sound is emitted.}}
{{MethodParam|modulation|A number|How pitch shifted the sound should be. Original pitch is 1.}}
{{MethodParam|x|A number|Position in space, in meters.}}
{{MethodParam|y|A number|Position in space, in meters.}}
{{MethodParam|z|A number|Position in space, in meters.}}
{{MethodParam|speedX|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedY|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedZ|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
|
Returns nothing.
}}
=== Example ===
<pre>
local bomb = {x = 120, y = 200}
local res = 1/32 -- 32 pixels is one meter.
audio.playOrientedSound("boom.wav", 4, 1, bomb.x*res, bomb.y*res, 0)

--at center of the world, randomly pitched coins dance
audio.playOrientedSound("coin.wav", 1, 0.75+math.random()*0.5, 0, 0, 0)
</pre>

StartTrackedSound

2010-01-18T13:55:12Z

Thewreck:

{{AudioMethod
|
audio.startTrackedSound(soundFilename [, gain [, modulation [, x, y, z, [speedX, speedY, speedZ]]]])
|
Plays an audio file with a position in space, but also returns an id for updating purposes. The volume and panning is then calculated based on the [[setSoundListenerPosition]]. '''The sound will loop until it is stopped.'''
|
{{MethodParam|soundFilename|A string|The name of the audio file, relative to the source folder. The name is case sensitive on Mac OS X.}}
{{MethodParam|gain|A number|The power at which the sound is emitted.}}
{{MethodParam|modulation|A number|How pitch shifted the sound should be. Original pitch is 1.}}
{{MethodParam|x|A number|Position in space, in meters.}}
{{MethodParam|y|A number|Position in space, in meters.}}
{{MethodParam|z|A number|Position in space, in meters.}}
{{MethodParam|speedX|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedY|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedZ|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
|
Returns one value, soundId, or nil in case the soundFilename doesn't exist.
}}
=== Example ===
<pre>
local mySound = audio.startTrackedSound("fireball.wav")
local fireBall = { x = 100 , y = 0 }
audio.updateTrackedSound(mySound, 1 ,1 , fireBall.x, fireBall.y, 0)
</pre>

UpdateTrackedSound

2010-01-18T13:54:14Z

Thewreck: Created page with '{{AudioMethod | audio.updateTrackedSound(soundId [, gain [, modulation [, x, y, z, [speedX, speedY, speedZ]]]]) | Updates a sound that has been started by audio.[[startTrackedSou...'

{{AudioMethod
|
audio.updateTrackedSound(soundId [, gain [, modulation [, x, y, z, [speedX, speedY, speedZ]]]])
|
Updates a sound that has been started by audio.[[startTrackedSound]].
|
{{MethodParam|soundId |A number|The sound id returned by audio.[[startTrackedSound]]}}
{{MethodParam|gain|A number|The power at which the sound is emitted.}}
{{MethodParam|modulation|A number|How pitch shifted the sound should be. Original pitch is 1.}}
{{MethodParam|x|A number|Position in space, in meters.}}
{{MethodParam|y|A number|Position in space, in meters.}}
{{MethodParam|z|A number|Position in space, in meters.}}
{{MethodParam|speedX|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedY|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedZ|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
|
Returns one value, soundId, or nil in case the soundFilename doesn't exist.
}}
=== Example ===
<pre>
local mySound = audio.startTrackedSound("fireball.wav")
local fireBall = { x = 100 , y = 0 }
audio.updateTrackedSound(mySound, 1 ,1 , fireBall.x, fireBall.y, 0)
</pre>

UpdateMusic

2010-01-18T13:51:48Z

Thewreck: /* Example */

{{AudioMethod
|
audio.updateMusic(musicFilename , volume)
|
Updates a music already playing started by audio.[[playMusic]].
|
{{MethodParam|musicFilename|A string|The name of the music file, relative to the source folder. The name is case sensitive on Mac OS X.}}
{{MethodParam|volume|A number|Volume of the played music file, maximum is 1.}}
|
Returns true is the sound was updated, false if the sound is no longer playing or could not be found.
}}
=== Example ===
<pre>
--simply change volume:
audio.playMusic("boss.ogg", 1)
audio.updateMusic("boss.ogg", 0.25)

-- or more complicated, for example...
-- start of game
audio.playMusic("intro.ogg")

-- during loop:
if not audio.updateMusic("intro.ogg", 0.5) then
if not audio.updateMusic("level.ogg", 1) then
audio.playMusic("level.ogg")
end
end
</pre>

UpdateMusic

2010-01-18T13:50:54Z

Thewreck: Created page with '{{AudioMethod | audio.updateMusic(musicFilename , volume) | Updates a music already playing started by audio.playMusic. | {{MethodParam|musicFilename|A string|The name of the...'

{{AudioMethod
|
audio.updateMusic(musicFilename , volume)
|
Updates a music already playing started by audio.[[playMusic]].
|
{{MethodParam|musicFilename|A string|The name of the music file, relative to the source folder. The name is case sensitive on Mac OS X.}}
{{MethodParam|volume|A number|Volume of the played music file, maximum is 1.}}
|
Returns true is the sound was updated, false if the sound is no longer playing or could not be found.
}}
=== Example ===
<pre>
-- start of game
audio.playMusic("intro.ogg")

-- during loop:
if not audio.updateMusic("intro.ogg", 0.5) then
if not audio.updateMusic("level.ogg", 1) then
audio.playMusic("level.ogg")
end
end
</pre>

PlayMusic

2010-01-18T13:46:41Z

Thewreck:

{{AudioMethod
|
audio.playMusic(musicFilename [, volume, [repeat]])
|
Plays an audio file, globally, once.
|
{{MethodParam|musicFilename|A string|The name of the music file, relative to the source folder. The name is case sensitive on Mac OS X.}}
{{MethodParam|volume|A number|Volume of the played music file, maximum is 1.}}
{{MethodParam|repeat|A boolean|true if the music should repeat.}}
|
Returns nothing.
}}
=== Example ===
<pre>
audio.playMusic("intro.ogg")

audio.playMusic("music/boss.ogg", 0.75, true)
</pre>

StopTrackedSound

2010-01-18T13:43:10Z

Thewreck:

{{AudioMethod
|
audio.stopTrackedSound(soundId)
|
Stops a tracked sound based on the soundId.
|
{{MethodParam|soundId|A number|The id number returned by audio.[[startTrackedSound]]}}
|
Returns nothing.
}}
=== Example ===
<pre>
local mySound = audio.startTrackedSound("bulletSwish.wav")
audio.stopTrackedSound(mySound)
</pre>

StopTrackedSound

2010-01-18T13:42:55Z

Thewreck: Created page with '{{AudioMethod | audio.stopTrackedSound(soundId) | Stops a tracked sound based on the soundId. | {{MethodParam|soundId|A number|The id number returned by daisy.[[startTrackedSound...'

{{AudioMethod
|
audio.stopTrackedSound(soundId)
|
Stops a tracked sound based on the soundId.
|
{{MethodParam|soundId|A number|The id number returned by daisy.[[startTrackedSound]]}}
|
Returns nothing.
}}
=== Example ===
<pre>
local mySound = audio.startTrackedSound("bulletSwish.wav")
audio.stopTrackedSound(mySound)
</pre>

StopAllTrackedSounds

2010-01-18T13:41:16Z

Thewreck: /* Example */

{{AudioMethod
|
audio.stopAllTrackedSounds()
|
Stops all audio started with audio.[[startTrackedSound]]
|
{{NoParams}}
|
Returns nothing.
}}
=== Example ===
<pre>
for i=1,20 do
audio.startTrackedSound("annoyingSound.wav")
end

audio.stopAllTrackedSounds()
</pre>