API Reference
- Libraries
  - ads.*
  - audio.*
  - composer.*
  - crypto.*
  - display.*
  - easing.*
  - facebook.*
  - gameNetwork.*
  - (globals)
  - graphics.*
  - io.*
  - json.*
  - lfs.* (file system)
  - licensing.*
  - math.*
  - media.*
  - native.*
  - network.*
  - os.*
  - package.*
  - physics.*
  - socket.*
  - sqlite3.* (database)
  - store.* (Apple IAP)
  - string.*
  - system.*
  - table.* (array)
  - timer.*
  - transition.*
  - widget.*
- Events
  - accelerometer
  - audio
  - axis
  - collision
  - colorSample
  - completion
  - enterFrame
  - fbconnect
  - finalize
  - gameNetwork
  - gyroscope
  - heading (compass)
  - inputDeviceStatus
  - key
  - licensing
  - location (GPS)
  - mapAddress
  - mapLocation
  - mapMarker
  - memoryWarning
  - mouse
  - networkRequest
  - networkStatus
  - notification
  - orientation
  - particleCollision
  - popup
  - postCollision
  - preCollision
  - relativeTouch
  - resize
  - scene
  - sprite
  - system
  - tap
  - timer
  - touch
  - unhandledError
  - urlRequest
  - userInput
  - video
- Types
  - Array
  - BitmapPaint
  - Body
  - Boolean
  - ButtonWidget
  - CirclePath
  - CompositePaint
  - Constant
  - CoronaClass
  - CoronaLibrary
  - CoronaPrototype
  - CoronaProvider
  - DisplayObject
  - EmitterObject
  - Event
  - EventDispatcher
  - File
  - Function
  - GameNetwork
  - GradientPaint
  - GroupObject
  - ImageSheet
  - ImageSheetPaint
  - InputAxis
  - InputDevice
  - Joint
  - Library
  - LineObject
  - Listener
  - Map
  - Mask
  - NativeDisplayObject
  - Number
  - Object
  - Paint
  - ParticleSystem
  - Path
  - PhysicsContact
  - PickerWheelWidget
  - ProgressViewWidget
  - Recording
  - RectPath
  - RoundedRectPath
  - Runtime
  - Scene
  - ScrollViewWidget
  - SegmentedControlWidget
  - ShapeObject
  - SliderWidget
  - SnapshotObject
  - SpinnerWidget
  - SpriteObject
  - StageObject
  - StepperWidget
  - String
  - SwitchWidget
  - TabBarWidget
  - Table
  - TableViewWidget
  - TextBox
  - TextField
  - TextObject
  - TextureResource
  - TextureResourceBitmap
  - TextureResourceCanvas
  - TextureResourceExternal
  - Userdata
  - Video
  - WebView

API Reference

This is the complete list of Lua APIs for Corona SDK.

If you're new, download Corona SDK and proceed to the Getting Started series. There are also numerous guides on specific topics.

If you're looking to extend Corona SDK beyond the functionality provided by these Lua APIs, please see the Corona Enterprise documentation.

To obtain the most recent builds of Corona SDK, browse the latest daily builds and corresponding documentation.

To download this documentation for offline viewing, please click here.

Libraries

ads.*

composer.*

composer.getScene()

composer.getSceneName()

composer.getVariable()

composer.gotoScene()

composer.hideOverlay()

composer.isDebug

composer.loadScene()

composer.newScene()

composer.recycleAutomatically

composer.recycleOnLowMemory

composer.recycleOnSceneChange

composer.removeHidden()

composer.removeScene()

composer.setVariable()

composer.showOverlay()

crypto.*

crypto.digest()

display.*

display.actualContentHeight

display.actualContentWidth

display.capture()

display.captureBounds()

display.captureScreen()

display.colorSample()

display.contentCenterX

display.contentCenterY

display.contentHeight

display.contentScaleX

display.contentScaleY

display.contentWidth

display.currentStage

display.getCurrentStage()

display.getDefault()

display.imageSuffix

display.loadRemoteImage()

display.newCircle()

display.newContainer()

display.newEmbossedText()

display.newEmitter()

display.newGroup()

display.newImage()

display.newImageRect()

display.newLine()

display.newMesh()

display.newPolygon()

display.newRect()

display.newRoundedRect()

display.newSnapshot()

display.newSprite()

display.newText()

display.pixelHeight

display.pixelWidth

display.remove()

display.screenOriginX

display.screenOriginY

display.setDefault()

display.setDrawMode()

display.setStatusBar()

display.statusBarHeight

display.topStatusBarContentHeight

display.viewableContentHeight

display.viewableContentWidth

easing.*

facebook.*

gameNetwork.*

graphics.*

graphics.defineEffect()

graphics.newImageSheet()

graphics.newMask()

graphics.newOutline()

graphics.newTexture()

graphics.releaseTextures()

io.*

json.*

json.decodeFile()

json.prettify()

lfs.* (file system)

licensing.*

licensing.init()

licensing.verify()

media.*

media.RemoteSource

media.capturePhoto()

media.captureVideo()

media.getSoundVolume()

media.hasSource()

media.newEventSound()

media.newRecording()

media.pauseSound()

media.playEventSound()

media.playSound()

media.playVideo()

media.selectPhoto()

media.selectVideo()

media.setSoundVolume()

media.stopSound()

network.*

network.canDetectNetworkStatusChanges

network.cancel()

network.download()

network.request()

network.setStatusListener()

network.upload()

os.*

package.*

package.loaders

socket.*

sqlite3.* (database)

string.*

string.format()

string.gmatch()

string.reverse()

string.starts()

table.* (array)

table.indexOf()

timer.*

timer.performWithDelay()

transition.*

transition.blink()

transition.cancel()

transition.dissolve()

transition.fadeIn()

transition.fadeOut()

transition.from()

transition.moveBy()

transition.moveTo()

transition.pause()

transition.resume()

transition.scaleBy()

transition.scaleTo()

transition.to()

Events

accelerometer

event.deltaTime

audio

event.completed

axis

event.normalizedValue

collision

event.otherElement

event.selfElement

colorSample

completion

event.completed

enterFrame

fbconnect

event.didComplete

event.expiration

finalize

gameNetwork

event.errorCode

event.errorMessage

event.localPlayerScore

gyroscope

event.deltaTime

event.xRotation

event.yRotation

event.zRotation

heading (compass)

event.geographic

inputDeviceStatus

event.connectionStateChanged

event.reconfigured

key

event.descriptor

event.isAltDown

event.isCommandDown

event.isCtrlDown

event.isShiftDown

event.nativeKeyCode

licensing

event.errorType

event.expiration

event.isVerified

location (GPS)

event.direction

event.errorCode

event.errorMessage

event.longitude

mapAddress

event.cityDetail

event.countryCode

event.errorMessage

event.postalCode

event.regionDetail

event.streetDetail

mapLocation

event.errorMessage

event.longitude

mapMarker

event.longitude

memoryWarning

mouse

event.isMiddleButtonDown

event.isPrimaryButtonDown

event.isSecondaryButtonDown

networkRequest

event.bytesEstimated

event.bytesTransferred

event.requestId

event.responseHeaders

event.responseType

networkStatus

event.isConnectionOnDemand

event.isConnectionRequired

event.isInteractionRequired

event.isReachable

event.isReachableViaCellular

event.isReachableViaWiFi

notification

event.applicationState

orientation

particleCollision

event.particleSystem

postCollision

event.otherElement

event.selfElement

preCollision

event.otherElement

event.selfElement

relativeTouch

resize

scene

sprite

system

event.commandLineArgs

event.commandLineDir

tap

timer

touch

unhandledError

event.errorMessage

event.stackTrace

urlRequest

event.errorCode

event.errorMessage

userInput

event.newCharacters

event.numDeleted

event.startPosition

video

Types

Array

BitmapPaint

Body

object.angularDamping

object.angularVelocity

object:applyAngularImpulse()

object:applyForce()

object:applyLinearImpulse()

object:applyTorque()

object.bodyType

object:getLinearVelocity()

object:getMassLocalCenter()

object:getMassWorldCenter()

object.gravityScale

object.isBodyActive

object.isBullet

object.isFixedRotation

object.isSensor

object.isSleepingAllowed

object.linearDamping

object:resetMassData()

object:setLinearVelocity()

Boolean

ButtonWidget

object:getLabel()

object:setEnabled()

object:setLabel()

CirclePath

CompositePaint

Constant

CoronaClass

CoronaLibrary

object:getCurrentProvider()

object.publisherId

object.revision

object:setCurrentProvider()

CoronaPrototype

object:initialize()

object:instanceOf()

object:isClass()

object:isRoot()

object:newClass()

object:setExtension()

CoronaProvider

EmitterObject

EmitterObject:pause()

EmitterObject:start()

EmitterObject:stop()

Event

EventDispatcher

object:addEventListener()

object:dispatchEvent()

object:removeEventListener()

File

object:setvbuf()

Function

GameNetwork

gameNetwork.match

gameNetwork.outcome

gameNetwork.participant

gameNetwork.status

GradientPaint

GroupObject

object.anchorChildren

object:insert()

object.numChildren

object:remove()

ImageSheet

ImageSheetPaint

InputAxis

object.accuracy

object.descriptor

object.maxValue

object.minValue

InputDevice

object.MFiProfile

object.allowsRotation

object.androidDeviceId

object.canVibrate

object.connectionState

object.descriptor

object.displayName

object:getAxes()

object.isConnected

object.permanentId

object.playerNumber

object.productName

object.reportsAbsoluteDpadValues

object:vibrate()

Joint

object.dampingRatio

object.frequency

object:getAnchorA()

object:getAnchorB()

object:getGroundAnchorA()

object:getGroundAnchorB()

object:getLimits()

object:getLocalAnchorA()

object:getLocalAnchorB()

object:getLocalAxisA()

object:getReactionForce()

object:getRotationLimits()

object:getTarget()

object.isActive

object.isCollideConnected

object.isLimitEnabled

object.isMotorEnabled

object.jointAngle

object.jointSpeed

object.jointTranslation

object.limitState

object.maxForce

object.maxLength

object.maxMotorForce

object.maxMotorTorque

object.maxTorque

object.motorForce

object.motorSpeed

object.motorTorque

object.reactionTorque

object.referenceAngle

object:removeSelf()

object:setLimits()

object:setRotationLimits()

object:setTarget()

object.springDampingRatio

object.springFrequency

Library

LineObject

object.anchorSegments

object:append()

Listener

Map

object:addMarker()

object:getAddressLocation()

object:getUserLocation()

object.isLocationVisible

object.isScrollEnabled

object.isZoomEnabled

object:nearestAddress()

object:removeAllMarkers()

object:removeMarker()

object:requestLocation()

object:setCenter()

object:setRegion()

Mask

NativeDisplayObject

object:getNativeProperty()

object:setNativeProperty()

Number

Object

Paint

fill.blendEquation

ParticleSystem

object:applyForce()

object:applyLinearImpulse()

object:createGroup()

object:createParticle()

object:destroyParticles()

object.imageRadius

object.particleCount

object.particleDamping

object.particleDensity

object.particleDestructionByAge

object.particleGravityScale

object.particleMass

object.particleMaxCount

object.particlePaused

object.particleRadius

object.particleStrictContactCheck

object:queryRegion()

object:rayCast()

Path

PhysicsContact

PhysicsContact.bounce

PhysicsContact.friction

PhysicsContact.isEnabled

PhysicsContact.isTouching

PickerWheelWidget

object:getValues()

object:selectValue()

ProgressViewWidget

object:getProgress()

object:resizeView()

object:setProgress()

Recording

object:getSampleRate()

object:isRecording()

object:setSampleRate()

object:startRecording()

object:stopRecording()

RectPath

RoundedRectPath

Runtime

Runtime:hasEventSource()

Runtime:hideErrorAlerts()

Runtime:setCheckGlobals()

Scene

ScrollViewWidget

object:getContentPosition()

object:getView()

object:scrollTo()

object:scrollToPosition()

object:setIsLocked()

object:setScrollHeight()

object:setScrollWidth()

object:takeFocus()

SegmentedControlWidget

object.segmentLabel

object.segmentNumber

object:setActiveSegment()

ShapeObject

object:setFillColor()

object:setStrokeColor()

object.strokeWidth

SliderWidget

object:setValue()

SnapshotObject

object.canvasMode

object.clearColor

object:invalidate()

object.textureFilter

object.textureWrapX

object.textureWrapY

SpinnerWidget

SpriteObject

object.isPlaying

object.numFrames

object.sequence

object:setFrame()

object:setSequence()

object.timeScale

StageObject

StageObject:setFocus()

StepperWidget

object:getValue()

object.maximumValue

object.minimumValue

object:setValue()

String

SwitchWidget

object:setState()

TabBarWidget

object:setSelected()

Table

TableViewWidget

object:deleteAllRows()

object:deleteRow()

object:deleteRows()

object:getContentPosition()

object:getNumRows()

object:getRowAtIndex()

object:insertRow()

object:reloadData()

object:scrollToIndex()

object:scrollToY()

object:setIsLocked()

TextBox

object.hasBackground

object.isEditable

object.isFontSizeScaled

object.placeholder

object:setReturnKey()

object:setSelection()

object:setTextColor()

TextField

object.autocorrectionType

object.hasBackground

object.inputType

object.isFontSizeScaled

object.isSecure

object.placeholder

object:resizeFontToFitHeight()

object:resizeHeightToFitFont()

object:setReturnKey()

object:setSelection()

object:setTextColor()

object.spellCheckingType

TextObject

object:setEmbossColor()

TextureResource

texture.baseDir

texture.filename

texture:releaseSelf()

TextureResourceBitmap

texture:preload()

TextureResourceCanvas

texture.anchorX

texture.anchorY

texture:invalidate()

texture.pixelHeight

texture.pixelWidth

texture:setBackground()

TextureResourceExternal

texture:invalidate()

Userdata

Video

object.currentTime

object.totalTime

WebView

object.canGoBack

object.canGoForward

object:deleteCookies()

object:forward()

object.hasBackground

object:reload()

object:request()