Lua scripting

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}) getTransformedPosition(object) getTransformedRotation(object) getTransformedScale(object) getInverseRotatedVector(object) getRotatedVector(object) getInverseVector(object) getTransformedVector(object) 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 Lua official website Programming in Lua ebook All LUA in one page LUA syntax overview by Nick Gammon Tools Decoda - Lua IDE and debugger

Code Snippets Hello World Object programming Object Oriented Programming in Maratis