Lua functions list

From MaratisWiki
(Difference between revisions)
Jump to: navigation, search
m
 
(8 intermediate revisions by one user not shown)
Line 1: Line 1:
===3d Math===
+
__NOTOC__
  
* [[vec3]](x, y, z)
+
<onlyinclude>
* [[length]](vec3)
+
{{column-box-begin}}
* [[normalize]](vec3)
+
* [[dot]](vecA, vecB)
+
* [[cross]](vecA, vecB)<br><br>
+
===Object===
+
  
* [[getObject]](« objectName »)
+
{{begin-box|3D Math}}
* [[getParent]](object)
+
* <code>'''[[vec3]](x, y, z)'''</code>
* [[getChilds]](object)
+
* <code>'''[[length]](vec3)'''</code>
* [[getClone]](object)
+
* <code>'''[[normalize]](vec3)'''</code>
* [[setParent]](object, parent)
+
* <code>'''[[dot]](vecA, vecB)'''</code>
* [[getName]](object)
+
* <code>'''[[cross]](vecA, vecB)'''</code>
* [[activate]](object)
+
{{end-box}}
* [[deactivate]](object)
+
* [[isVisible]](object)
+
* [[isActive]](object)<br><br>
+
* [[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})<br><br>
+
* [[getTransformedPosition]](object)
+
* [[getTransformedRotation]](object)
+
* [[getTransformedScale]](object)
+
* [[getInverseRotatedVector]](object)
+
* [[getRotatedVector]](object)
+
* [[getInverseVector]](object)
+
* [[getTransformedVector]](object)
+
* [[updateMatrix]](object)
+
* [[getMatrix]](object)<br><br>
+
* [[enableShadow]](object, shadow)
+
* [[isCastingShadow]](object)<br><br>
+
===Behavior===
+
  
* [[getBehaviorVariable]](object, behaviorId, "variableName")
+
{{begin-box|Input}}
* [[setBehaviorVariable]](object, behaviorId, "variableName", value)<br><br>
+
* <code>'''[[isKeyPressed]]([[Keys|key]])'''</code>
===Animation===
+
* <code>'''[[onKeyDown]]([[Keys|key]])'''</code>
 +
* <code>'''[[onKeyUp]]([[Keys|key]])'''</code>
 +
* <code>'''[[getAxis]]([[Axis|axis]])'''</code>
 +
* <code>'''[[getProperty]]("propertyName")'''</code>
 +
* <code>'''[[getTouchPosition]](touchId)'''</code>
 +
* <code>'''[[getLastTouchPosition]](touchId)'''</code>
 +
* <code>'''[[getTouchPhase]](touchId)'''</code>
 +
{{end-box}}
  
* [[getCurrentAnimation]](object)
+
{{begin-box|Scene}}
* [[changeAnimation]](object, animationId)
+
* <code>'''[[getScene]]("sceneName")'''</code>
* [[isAnimationOver]](object)
+
* <code>'''[[changeScene]](scene)'''</code>
* [[getAnimationSpeed]](object)
+
* <code>'''[[getCurrentSceneId]]()'''</code>
* [[setAnimationSpeed]](object, speed)
+
* <code>'''[[getScenesNumber]]()'''</code>
* [[getCurrentFrame]](object)
+
{{end-box}}
* [[setCurrentFrame]](object, frame)<br><br>
+
===Physics===
+
  
* [[setGravity]]({x, y, z})
+
{{begin-box|Level}}
* [[getGravity]]()<br><br>
+
* <code>'''[[loadLevel]]("levelName")'''</code>
* [[getLinearDamping]](object)
+
{{end-box}}
* [[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)<br><br>
+
* [[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)<br><br>
+
===Inputs===
+
  
* [[isKeyPressed]]([[Keys|key]])
+
{{begin-box|System}}
* [[onKeyDown]]([[Keys|key]])
+
* <code>'''[[centerCursor]]()'''</code>
* [[onKeyUp]]([[Keys|key]])
+
* <code>'''[[hideCursor]]()'''</code>
* [[getAxis]]([[Axis|axis]])
+
* <code>'''[[showCursor]]()'''</code>
* [[getProperty]]("propertyName")
+
* <code>'''[[getWindowScale]]()'''</code>
* [[getTouchPosition]](touchId)
+
* <code>'''[[getSystemTick]]()'''</code>
* [[getLastTouchPosition]](touchId)
+
* <code>'''[[quit]]()'''</code>
* [[getTouchPhase]](touchId)<br><br>
+
* <code>'''[[dofile]]("filename.lua")'''</code>
===Sound===
+
{{end-box}}
  
* [[playSound]](object)
+
{{begin-box|Animation}}
* [[pauseSound]](object)
+
* <code>'''[[getCurrentAnimation]](object)'''</code>
* [[stopSound]](object)
+
* <code>'''[[changeAnimation]](object, animationId)'''</code>
* [[getSoundGain]](object)
+
* <code>'''[[isAnimationOver]](object)'''</code>
* [[setSoundGain]](object, gain)<br><br>
+
* <code>'''[[getAnimationSpeed]](object)'''</code>
===Scene===
+
* <code>'''[[setAnimationSpeed]](object, speed)'''</code>
 +
* <code>'''[[getCurrentFrame]](object)'''</code>
 +
* <code>'''[[setCurrentFrame]](object, frame)'''</code>
 +
{{end-box}}
  
* [[getScene]]("sceneName")
+
{{begin-box|Sound}}
* [[changeScene]](scene)
+
* <code>'''[[playSound]](object)'''</code>
* [[getCurrentSceneId]]()
+
* <code>'''[[pauseSound]](object)'''</code>
* [[getScenesNumber]]()<br><br>
+
* <code>'''[[stopSound]](object)'''</code>
===Level===
+
* <code>'''[[getSoundGain]](object)'''</code>
 +
* <code>'''[[setSoundGain]](object, gain)'''</code>
 +
{{end-box}}
  
* [[loadLevel]]("levelName")<br><br>
+
{{begin-box|Text}}
===Light===
+
* <code>'''[[setText]](object , "text")'''</code>
 +
* <code>'''[[getText]](object)'''</code>
 +
* <code>'''[[getTextColor]](object)'''</code>
 +
* <code>'''[[setTextColor]](object, {r, g, b, a})'''</code>
 +
{{end-box}}
  
* [[getLightColor]](object)
+
{{begin-box|Camera}}
* [[getLightRadius]](object)
+
* <code>'''[[changeCurrentCamera]](object)'''</code>
* [[getLightIntensity]](object)
+
* <code>'''[[getCurrentCamera]]()'''</code>
* [[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)<br><br>
+
===Camera===
+
  
* [[changeCurrentCamera]](object)
+
* <code>'''[[getCameraClearColor]](object)'''</code>
* [[getCurrentCamera]]()<br><br>
+
* <code>'''[[getCameraFov]](object)'''</code>
* [[getCameraClearColor]](object)
+
* <code>'''[[getCameraNear]](object)'''</code>
* [[getCameraFov]](object)
+
* <code>'''[[getCameraFar]](object)'''</code>
* [[getCameraNear]](object)
+
* <code>'''[[getCameraFogDistance]](object)'''</code>
* [[getCameraFar]](object)
+
* <code>'''[[isCameraOrtho]](object)'''</code>
* [[getCameraFogDistance]](object)
+
* <code>'''[[isCameraFogEnabled]](object)'''</code>
* [[isCameraOrtho]](object)
+
* <code>'''[[setCameraClearColor]](object, {r, g, b})'''</code>
* [[isCameraFogEnabled]](object)
+
* <code>'''[[setCameraFov]](object, fov)'''</code>
* [[setCameraClearColor]](object, {r, g, b})
+
* <code>'''[[setCameraNear]](object, near)'''</code>
* [[setCameraFov]](object, fov)
+
* <code>'''[[setCameraFar]](object, far)'''</code>
* [[setCameraNear]](object, near)
+
* <code>'''[[setCameraFogDistance]](object, fogDistance)'''</code>
* [[setCameraFar]](object, far)
+
* <code>'''[[enableCameraOrtho]](object, ortho)'''</code>
* [[setCameraFogDistance]](object, fogDistance)
+
* <code>'''[[enableCameraFog]](object, fog)'''</code>
* [[enableCameraOrtho]](object, ortho)
+
{{vspace}}
* [[enableCameraFog]](object, fog)<br><br>
+
* <code>'''[[enableCameraLayer]](object, scene)'''</code>
* [[enableCameraLayer]](object, scene)
+
* <code>'''[[disableCameraLayer]](object)'''</code>
* [[disableCameraLayer]](object)
+
* <code>'''[[enableRenderToTexture]](object, "textureName", renderWith, renderHeight)'''</code>
* [[enableRenderToTexture]](object, "textureName", renderWith, renderHeight)
+
* <code>'''[[disableRenderToTexture]](object)'''</code>
* [[disableRenderToTexture]](object)<br><br>
+
{{vspace}}
* [[getProjectedPoint]](object, point)
+
* <code>'''[[getProjectedPoint]](object, point)'''</code>
* [[getUnProjectedPoint]](object, point)<br><br>
+
* <code>'''[[getUnProjectedPoint]](object, point)'''</code>
===Text===
+
{{end-box}}
  
* [[setText]](object , "text")
+
{{column-box-breaker}}
* [[getText]](object)
+
* [[getTextColor]](object)
+
* [[setTextColor]](object, {r, g, b, a})<br><br>
+
===System===
+
  
* [[centerCursor]]()
+
{{begin-box|Object}}
* [[hideCursor]]()
+
* <code>'''[[getObject]]("objectName")'''</code>
* [[showCursor]]()
+
* <code>'''[[getParent]](object)'''</code>
* [[getWindowScale]]()
+
* <code>'''[[getChilds]](object)'''</code>
* [[getSystemTick]]()
+
* <code>'''[[getClone]](object)'''</code>
* [[quit]]()
+
* <code>'''[[setParent]](object, parent)'''</code>
* [[dofile]]("filename.lua")
+
* <code>'''[[getName]](object)'''</code>
 +
* <code>'''[[activate]](object)'''</code>
 +
* <code>'''[[deactivate]](object)'''</code>
 +
* <code>'''[[isVisible]](object)'''</code>
 +
* <code>'''[[isActive]](object)'''</code>
 +
{{vspace}}
 +
* <code>'''[[enableShadow]](object, shadow)'''</code>
 +
* <code>'''[[isCastingShadow]](object)'''</code>
 +
{{end-box}}
 +
 
 +
{{begin-box|Transformation}}
 +
* <code>'''[[rotate]](object, {x, y, z}, angle, ''"local"'')'''</code>
 +
* <code>'''[[translate]](object, {x, y, z}, ''"local"'')'''</code>
 +
{{vspace}}
 +
* <code>'''[[getPosition]](object)'''</code>
 +
* <code>'''[[getRotation]](object)'''</code>
 +
* <code>'''[[getScale]](object)'''</code>
 +
* <code>'''[[setPosition]](object, {x, y, z})'''</code>
 +
* <code>'''[[setRotation]](object, {x, y, z})'''</code>
 +
* <code>'''[[setScale]](object, {x, y, z})'''</code>
 +
{{vspace}}
 +
* <code>'''[[getTransformedPosition]](object)'''</code>
 +
* <code>'''[[getTransformedRotation]](object)'''</code>
 +
* <code>'''[[getTransformedScale]](object)'''</code>
 +
* <code>'''[[getInverseRotatedVector]](object)'''</code>
 +
* <code>'''[[getRotatedVector]](object)'''</code>
 +
* <code>'''[[getInverseVector]](object)'''</code>
 +
* <code>'''[[getTransformedVector]](object)'''</code>
 +
{{vspace}}
 +
* <code>'''[[updateMatrix]](object)'''</code>
 +
* <code>'''[[getMatrix]](object)'''</code>
 +
{{end-box}}
 +
 
 +
{{begin-box|Behavior}}
 +
* <code>'''[[getBehaviorVariable]](object, behaviorId, "variableName")'''</code>
 +
* <code>'''[[setBehaviorVariable]](object, behaviorId, "variableName", value)'''</code>
 +
{{end-box}}
 +
 
 +
{{begin-box|Physics}}
 +
* <code>'''[[setGravity]]({x, y, z})'''</code>
 +
* <code>'''[[getGravity]]()'''</code><br><br>
 +
* <code>'''[[getLinearDamping]](object)'''</code>
 +
* <code>'''[[setLinearDamping]](object, damping)'''</code>
 +
* <code>'''[[getAngularDamping]](object)'''</code>
 +
* <code>'''[[setAngularDamping]](object, damping)'''</code>
 +
* <code>'''[[getLinearFactor]](object)'''</code>
 +
* <code>'''[[setLinearFactor]](object, {x, y, z})'''</code>
 +
* <code>'''[[getAngularFactor]](object)'''</code>
 +
* <code>'''[[setAngularFactor]](object, factor)'''</code>
 +
* <code>'''[[getMass]](object)'''</code>
 +
* <code>'''[[setMass]](object, mass)'''</code>
 +
* <code>'''[[getFriction]](object)'''</code>
 +
* <code>'''[[setFriction]](object, friction)'''</code>
 +
* <code>'''[[getRestitution]](object)'''</code>
 +
* <code>'''[[setRestitution]](object, restitution)'''</code>
 +
{{vspace}}
 +
* <code>'''[[clearForces]](object)'''</code>
 +
* <code>'''[[addCentralForce]](object, {x, y, z}, ''"local"'')'''</code>
 +
* <code>'''[[addTorque]](object, {x, y, z}, ''"local"'')'''</code>
 +
* <code>'''[[getCentralForce]](object)'''</code>
 +
* <code>'''[[getTorque]](object)'''</code>
 +
* <code>'''[[isCollisionTest]](object)'''</code>
 +
* <code>'''[[isCollisionBetween]](object1, object2)'''</code>
 +
* <code>'''[[getNumCollisions]](object)'''</code>
 +
* <code>'''[[rayHit]](start, end)'''</code>
 +
{{end-box}}
 +
 
 +
{{begin-box|Light}}
 +
* <code>'''[[getLightColor]](object)'''</code>
 +
* <code>'''[[getLightRadius]](object)'''</code>
 +
* <code>'''[[getLightIntensity]](object)'''</code>
 +
* <code>'''[[getLightShadowQuality]](object)'''</code>
 +
* <code>'''[[getLightShadowBias]](object)'''</code>
 +
* <code>'''[[getLightShadowBlur]](object)'''</code>
 +
* <code>'''[[getLightSpotAngle]](object)'''</code>
 +
* <code>'''[[getLightSpotExponent]](object)'''</code>
 +
* <code>'''[[setLightColor]](object, {r, g, b})'''</code>
 +
* <code>'''[[setLightRadius]](object, radius)'''</code>
 +
* <code>'''[[setLightIntensity]](object, intensity)'''</code>
 +
* <code>'''[[setLightShadowQuality]](object, quality)'''</code>
 +
* <code>'''[[setLightShadowBias]](object, bias)'''</code>
 +
* <code>'''[[setLightShadowBlur]](object, blur)'''</code>
 +
* <code>'''[[setLightSpotAngle]](object, spotAngle)'''</code>
 +
* <code>'''[[setLightSpotExponent]](object, exponent)'''</code>
 +
{{end-box}}
 +
 
 +
{{column-box-end}}
 +
</onlyinclude>
 +
 
 +
[[Category:Lua scripting]]

Latest revision as of 01:08, 9 February 2014


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

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox