Lua scripting

From MaratisWiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "== Language : == Lua : http://www.lua.org == Functions list : == ====Object==== getObject(« objectName »)<br/> rotate(object, {x, y, z}, angle, « local »)<br/> transl...")
 
(Lua)
 
(26 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Language : ==
+
__NOTOC__ __NOEDITSECTION__
 +
{{begin-box|Welcome to the [http://maratis3d.org Maratis] Scripting Reference|h=2}}
 +
Maratis uses Lua as internal scripting language.
 +
{{end-box}}
  
Lua : http://www.lua.org
 
  
 +
<div style="margin: -3px auto 0.2em; text-align: center; font-size: 95%;">
 +
[[#Functions|Functions]] - [[#Key literals|Key literals]] - [[#Axis literals|Axis literals]] - [[#Lua|Lua]]
 +
</div>
  
== Functions list : ==
+
==Functions==
 +
{{:Lua functions list}}
  
====Object====
+
<div style="margin: -3px auto 0.2em; text-align: center; font-size: 95%;">
 +
[[#top|Back to top]] - [[#Functions|Functions]] - [[#Key literals|Key literals]] - [[#Axis literals|Axis literals]] - [[#Lua|Lua]]
 +
</div>
  
getObject(« objectName »)<br/>
+
==Key literals==
rotate(object, {x, y, z}, angle, « local »)<br/>
+
{{:Keys}}
translate(object, {x, y, z}, « local »)<br/>
+
getPosition(object)<br/>
+
getRotation(object)<br/>
+
getScale(object)<br/>
+
setPosition(object, {x, y, z})<br/>
+
setRotation(object, {x, y, z})<br/>
+
setScale(object, {x, y, z})<br/>
+
isVisible(object)<br/>
+
activate(object)<br/>
+
deactivate(object)<br/>
+
  
====Behavior====
+
<div style="margin: -3px auto 0.2em; text-align: center; font-size: 95%;">
 +
[[#top|Back to top]] - [[#Functions|Functions]] - [[#Key literals|Key literals]] - [[#Axis literals|Axis literals]] - [[#Lua|Lua]]
 +
</div>
  
getBehaviorVariable(object, behaviorId, « variableName »)<br/>
+
==Axis literals==
setBehaviorVariable(object, behaviorId, « variableName », value)<br/>
+
{{:Axis}}
  
====Animation====
+
<div style="margin: -3px auto 0.2em; text-align: center; font-size: 95%;">
 +
[[#top|Back to top]] - [[#Functions|Functions]] - [[#Key literals|Key literals]] - [[#Axis literals|Axis literals]] - [[#Lua|Lua]]
 +
</div>
  
getCurrentAnimation(object)<br/>
+
==Lua==
changeAnimation(object, animationId)<br/>
+
{{column-box-begin}}
isAnimationOver(object)<br/>
+
  
====Physics====
+
{{begin-box|Lua Documentation}}
 +
* [http://www.lua.org Lua official website]
 +
* [http://www.lua.org/pil/ Programming in Lua ebook]
 +
* [http://www.lua.org/gems/ Lua Programming Gems ebook]
 +
* [http://coffeeghost.net/2010/11/01/lua-cheat-sheet-for-programmers/ All Lua in one page]
 +
* [http://www.gammon.com.au/scripts/doc.php?general=lua_syntax Lua syntax overview] by Nick Gammon
 +
{{end-box}}
  
setGravity({x, y, z})<br/>
+
{{begin-box|Tools}}
getGravity()<br/>
+
* [http://unknownworlds.com/decoda/download/ Decoda] - Lua IDE and debugger
addCentralForce(object, {x, y, z}, « local »)<br/>
+
{{end-box}}
addTorque(object, {x, y, z}, « local »)<br/>
+
getLinearDamping(object)<br/>
+
setLinearDamping(object, {x, y, z})<br/>
+
getAngularDamping(object)<br/>
+
setAngularDamping(object, damping)<br/>
+
isCollisionTest(object)<br/>
+
isCollisionBetween(object1, object2)<br/>
+
clearForces(object)<br/>
+
getNumCollisions(object)<br/>
+
  
====Inputs====
+
{{column-box-breaker}}
  
isKeyPressed(« key »)<br/>
+
{{begin-box|Code Snippets}}
onKeyDown(« key »)<br/>
+
* [[Lua Hello World example|Hello World]]
onKeyUp(« key »)<br/>
+
* [[Lua object programming example|Object programming]]
getAxis(« axis »)<br/>
+
* [[Object Oriented Programming in Maratis]]
 +
* [[Timers]]
 +
{{end-box}}
  
====Sound====
+
{{column-box-end}}
  
playSound(object)<br/>
+
[[Category:Lua scripting]]
pauseSound(object)<br/>
+
stopSound(object)<br/>
+
getSoundGain(object)<br/>
+
setSoundGain(object, gain)<br/>
+
 
+
====Scene====
+
 
+
changeScene(sceneId)<br/>
+
 
+
====Level====
+
 
+
loadLevel(« levelName »)<br/>
+
 
+
====Light====
+
 
+
getLightColor(object)<br/>
+
getLightRadius(object)<br/>
+
getLightIntensity(object)<br/>
+
setLightColor(object, {r, g, b})<br/>
+
setLightRadius(object, radius)<br/>
+
setLightIntensity(object, intensity)<br/>
+
 
+
====Camera====
+
 
+
changeCurrentCamera(object)<br/>
+
getCameraClearColor(object)<br/>
+
getCameraFov(object)<br/>
+
getCameraNear(object)<br/>
+
getCameraFar(object)<br/>
+
getCameraFogDistance(object)<br/>
+
isCameraOrtho(object)<br/>
+
isCameraFogEnabled(object)<br/>
+
setCameraClearColor(object, {r, g, b})<br/>
+
setCameraFov(object, fov)<br/>
+
setCameraNear(object, near)<br/>
+
setCameraFar(object, far)<br/>
+
setCameraFogDistance(object, fogDistance)<br/>
+
enableCameraOrtho(object, ortho)<br/>
+
enableCameraFog(object, fog)<br/>
+
 
+
====Text====
+
 
+
setText(object , « text »)<br/>
+
getText(object)<br/>
+
getTextColor(object)<br/>
+
setTextColor(object, {r, g, b, a})<br/>
+
 
+
====Cursor====
+
 
+
centerCursor()<br/>
+
 
+
 
+
 
+
== Keys : ==
+
 
+
====Keyboard====
+
 
+
"A" to "Z"<br/>
+
"0″ to "9"<br/>
+
"F1" to "F12"<br/>
+
« BACKSPACE »<br/>
+
« TAB »<br/>
+
« ESCAPE »<br/>
+
« SPACE »<br/>
+
« DELETE »<br/>
+
« ENTER »<br/>
+
« UP »<br/>
+
« DOWN »<br/>
+
« LEFT »<br/>
+
« RIGHT »<br/>
+
« RSHIFT »<br/>
+
« LSHIFT »<br/>
+
« RCONTROL »<br/>
+
« LCONTROL »<br/>
+
« RALT »<br/>
+
« LALT »<br/>
+
 
+
====Mouse====
+
 
+
« MOUSE_BUTTON1″<br/>
+
« MOUSE_BUTTON2″<br/>
+
« MOUSE_BUTTON3″<br/>
+
 
+
====Joystick 1====
+
 
+
« JOY1_BUTTON1″<br/>
+
« JOY1_BUTTON2″<br/>
+
« JOY1_BUTTON3″<br/>
+
« JOY1_BUTTON4″<br/>
+
« JOY1_BUTTON5″<br/>
+
« JOY1_BUTTON6″<br/>
+
« JOY1_BUTTON7″<br/>
+
« JOY1_BUTTON8″<br/>
+
 
+
====Joystick 2====
+
 
+
« JOY2_BUTTON1″<br/>
+
« JOY2_BUTTON2″<br/>
+
« JOY2_BUTTON3″<br/>
+
« JOY2_BUTTON4″<br/>
+
« JOY2_BUTTON5″<br/>
+
« JOY2_BUTTON6″<br/>
+
« JOY2_BUTTON7″<br/>
+
« JOY2_BUTTON8″<br/>
+
 
+
 
+
 
+
== Axis : ==
+
 
+
====Mouse====
+
 
+
« MOUSE_X »<br/>
+
« MOUSE_Y »<br/>
+
 
+
====Joystick 1====
+
 
+
« JOY1_X »<br/>
+
« JOY1_Y »<br/>
+
« JOY1_Z »<br/>
+
« JOY1_R »<br/>
+
« JOY1_U »<br/>
+
« JOY1_V »<br/>
+
 
+
====Joystick 2====
+
 
+
« JOY2_X »<br/>
+
« JOY2_Y »<br/>
+
« JOY2_Z »<br/>
+
« JOY2_R »<br/>
+
« JOY2_U »<br/>
+
« JOY2_V »<br/>
+

Latest revision as of 12:43, 11 February 2014

Welcome to the Maratis Scripting Reference

Maratis uses Lua as internal scripting language.


Functions - Key literals - Axis literals - Lua

Functions

3D Math

Input

Scene

Level

System

Animation

Sound

Text

Camera

Object

Transformation

  • rotate(object, {x, y, z}, angle, "local")
  • translate(object, {x, y, z}, "local")

Behavior

Physics

Light


Back to top - Functions - Key literals - Axis literals - Lua

Key literals

Keyboard

  • A to Z
  • 0 to 9
  • F1 to F12
  • BACKSPACE
  • TAB
  • ESCAPE
  • SPACE
  • DELETE
  • ENTER
  • UP
  • DOWN
  • LEFT
  • RIGHT
  • RSHIFT
  • LSHIFT
  • RCONTROL
  • LCONTROL
  • RALT
  • LALT

Mouse

  • MOUSE_BUTTON1
  • MOUSE_BUTTON2
  • MOUSE_BUTTON3

Joystick 1

  • JOY1_BUTTON1
  • JOY1_BUTTON2
  • JOY1_BUTTON3
  • JOY1_BUTTON4
  • JOY1_BUTTON5
  • JOY1_BUTTON6
  • JOY1_BUTTON7
  • JOY1_BUTTON8

Joystick 2

  • JOY2_BUTTON1
  • JOY2_BUTTON2
  • JOY2_BUTTON3
  • JOY2_BUTTON4
  • JOY2_BUTTON5
  • JOY2_BUTTON6
  • JOY2_BUTTON7
  • JOY2_BUTTON8


Back to top - Functions - Key literals - Axis literals - Lua

Axis literals

Accelerometer

  • MOTION_X
  • MOTION_Y
  • MOTION_Z
  • ACCEL_X
  • ACCEL_Y
  • ACCEL_Z
  • GRAVITY_X
  • GRAVITY_Y
  • GRAVITY_Z
  • YAW
  • PITCH
  • ROLL

Mouse

  • MOUSE_X
  • MOUSE_Y

Joystick 1

  • JOY1_X
  • JOY1_Y
  • JOY1_Z
  • JOY1_R
  • JOY1_U
  • JOY1_V

Joystick 2

  • JOY2_X
  • JOY2_Y
  • JOY2_Z
  • JOY2_R
  • JOY2_U
  • JOY2_V


Back to top - Functions - Key literals - Axis literals - Lua

Lua

Lua Documentation

Tools

  • Decoda - Lua IDE and debugger

Code Snippets

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox