Lua scripting

From MaratisWiki

(Difference between revisions)

Jump to: navigation, search

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

vec3(x, y, z)
length(vec3)
normalize(vec3)
dot(vecA, vecB)
cross(vecA, vecB)

Input

isKeyPressed(key)
onKeyDown(key)
onKeyUp(key)
getAxis(axis)
getProperty("propertyName")
getTouchPosition(touchId)
getLastTouchPosition(touchId)
getTouchPhase(touchId)

Scene

getScene("sceneName")
changeScene(scene)
getCurrentSceneId()
getScenesNumber()

Level

loadLevel("levelName")

System

centerCursor()
hideCursor()
showCursor()
getWindowScale()
getSystemTick()
quit()
dofile("filename.lua")

Animation

getCurrentAnimation(object)
changeAnimation(object, animationId)
isAnimationOver(object)
getAnimationSpeed(object)
setAnimationSpeed(object, speed)
getCurrentFrame(object)
setCurrentFrame(object, frame)

Sound

playSound(object)
pauseSound(object)
stopSound(object)
getSoundGain(object)
setSoundGain(object, gain)

Text

setText(object , "text")
getText(object)
getTextColor(object)
setTextColor(object, {r, g, b, a})

Camera

changeCurrentCamera(object)
getCurrentCamera()

getCameraClearColor(object)
getCameraFov(object)
getCameraNear(object)
getCameraFar(object)
getCameraFogDistance(object)
isCameraOrtho(object)
isCameraFogEnabled(object)
setCameraClearColor(object, {r, g, b})
setCameraFov(object, fov)
setCameraNear(object, near)
setCameraFar(object, far)
setCameraFogDistance(object, fogDistance)
enableCameraOrtho(object, ortho)
enableCameraFog(object, fog)

enableCameraLayer(object, scene)
disableCameraLayer(object)
enableRenderToTexture(object, "textureName", renderWith, renderHeight)
disableRenderToTexture(object)

getProjectedPoint(object, point)
getUnProjectedPoint(object, point)

Object

getObject("objectName")
getParent(object)
getChilds(object)
getClone(object)
setParent(object, parent)
getName(object)
activate(object)
deactivate(object)
isVisible(object)
isActive(object)

enableShadow(object, shadow)
isCastingShadow(object)

Transformation

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

getPosition(object)
getRotation(object)
getScale(object)
setPosition(object, {x, y, z})
setRotation(object, {x, y, z})
setScale(object, {x, y, z})

updateMatrix(object)
getMatrix(object)

Behavior

getBehaviorVariable(object, behaviorId, "variableName")
setBehaviorVariable(object, behaviorId, "variableName", value)

Physics

setGravity({x, y, z})
getGravity()
getLinearDamping(object)
setLinearDamping(object, damping)
getAngularDamping(object)
setAngularDamping(object, damping)
getLinearFactor(object)
setLinearFactor(object, {x, y, z})
getAngularFactor(object)
setAngularFactor(object, factor)
getMass(object)
setMass(object, mass)
getFriction(object)
setFriction(object, friction)
getRestitution(object)
setRestitution(object, restitution)

clearForces(object)
addCentralForce(object, {x, y, z}, "local")
addTorque(object, {x, y, z}, "local")
getCentralForce(object)
getTorque(object)
isCollisionTest(object)
isCollisionBetween(object1, object2)
getNumCollisions(object)
rayHit(start, end)

Light

getLightColor(object)
getLightRadius(object)
getLightIntensity(object)
getLightShadowQuality(object)
getLightShadowBias(object)
getLightShadowBlur(object)
getLightSpotAngle(object)
getLightSpotExponent(object)
setLightColor(object, {r, g, b})
setLightRadius(object, radius)
setLightIntensity(object, intensity)
setLightShadowQuality(object, quality)
setLightShadowBias(object, bias)
setLightShadowBlur(object, blur)
setLightSpotAngle(object, spotAngle)
setLightSpotExponent(object, exponent)

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

Lua scripting

Latest revision as of 12:43, 11 February 2014

Welcome to the Maratis Scripting Reference

Functions

3D Math

Input

Scene

Level

System

Animation

Sound

Text

Camera

Object

Transformation

Behavior

Physics

Light

Key literals

Keyboard

Mouse

Joystick 1

Joystick 2

Axis literals

Accelerometer

Mouse

Joystick 1

Joystick 2

Lua

Lua Documentation

Tools

Code Snippets

Personal tools

Namespaces

Variants

Views

Actions

Search

Navigation

Toolbox

@@ Line 1: / Line 1: @@
-[[Lua functions list]]
+__NOTOC__ __NOEDITSECTION__
-[[Lua keys]]
+{{begin-box|Welcome to the [http://maratis3d.org Maratis] Scripting Reference|h=2}}
-[[Lua axis]]
+Maratis uses Lua as internal scripting language.
+{{end-box}}
-== Language : ==
+<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>
-Lua : http://www.lua.org
+==Functions==
+{{:Lua functions list}}
+<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>
-== Functions list : ==
+==Key literals==
+{{:Keys}}
-====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/>
+==Axis literals==
-rotate(object, {x, y, z}, angle, « local »)<br/>
+{{:Axis}}
-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/>
+==Lua==
-setBehaviorVariable(object, behaviorId, « variableName », value)<br/>
+{{column-box-begin}}
-====Animation====
+{{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}}
-getCurrentAnimation(object)<br/>
+{{begin-box|Tools}}
-changeAnimation(object, animationId)<br/>
+* [http://unknownworlds.com/decoda/download/ Decoda] - Lua IDE and debugger
-isAnimationOver(object)<br/>
+{{end-box}}
-====Physics====
+{{column-box-breaker}}
-setGravity({x, y, z})<br/>
+{{begin-box|Code Snippets}}
-getGravity()<br/>
+* [[Lua Hello World example|Hello World]]
-addCentralForce(object, {x, y, z}, « local »)<br/>
+* [[Lua object programming example|Object programming]]
-addTorque(object, {x, y, z}, « local »)<br/>
+* [[Object Oriented Programming in Maratis]]
-getLinearDamping(object)<br/>
+* [[Timers]]
-setLinearDamping(object, {x, y, z})<br/>
+{{end-box}}
-getAngularDamping(object)<br/>
-setAngularDamping(object, damping)<br/>
-isCollisionTest(object)<br/>
-isCollisionBetween(object1, object2)<br/>
-clearForces(object)<br/>
-getNumCollisions(object)<br/>
-====Inputs====
+{{column-box-end}}
-isKeyPressed(« key »)<br/>
+[[Category:Lua scripting]]
-onKeyDown(« key »)<br/>
-onKeyUp(« key »)<br/>
-getAxis(« axis »)<br/>
-====Sound====
-playSound(object)<br/>
-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/>