×
A new build of Corona SDK is now available to subscribers. Not a subscriber? Subscribe now.
CoronaSDK 2013.1143 | Released: 18 Jun 2013, 2:19am | What's New | Download Now
Docs

API Reference

This is the Corona SDK API reference index. For in-depth guides and tutorials, see the Documentation. You can also view a platform and device specific API matrix here.

Download reference docs (664KB)

654 items
Ads
ads.hide()
ads.init()
ads.show()
Analytics
analytics.init()
analytics.logEvent()
Animation
Easing
easing.inExpo( )
easing.inOutExpo( )
easing.inOutQuad( )
easing.inQuad( )
easing.linear( )
easing.outExpo( )
easing.outQuad( )
Movieclips
movieclip.newAnim( )
object:nextFrame()
object:play()
object:previousFrame()
object:reverse()
object:setDrag( )
object:setLabels( )
object:stop()
object:stopAtFrame( )
Transitions
transition.cancel()
transition.dissolve( )
transition.from( )
transition.to( )
Arrays
table.concat()
table.copy()
table.indexOf()
table.insert()
table.maxn()
table.remove()
table.sort()
Audio
audio.dispose()
audio.fade()
audio.fadeOut()
audio.findFreeChannel()
audio.freeChannels
audio.getDuration()
audio.getMaxVolume()
audio.getMinVolume()
audio.getVolume()
audio.isChannelActive()
audio.isChannelPaused()
audio.isChannelPlaying()
audio.loadSound()
audio.loadStream()
audio.pause()
audio.play()
audio.reserveChannels()
audio.reservedChannels
audio.resume()
audio.rewind()
audio.seek()
audio.setMaxVolume()
audio.setMinVolume()
audio.setVolume()
audio.stop()
audio.stopWithDelay()
audio.totalChannels
audio.unreservedFreeChannels
audio.unreservedUsedChannels
audio.usedChannels
Basic Functions
_G
assert()
error()
getfenv()
getmetatable()
ipairs()
next()
pairs()
pcall()
print()
rawequal()
rawget()
rawset()
select()
setfenv()
setmetatable()
tonumber()
tostring()
type()
unpack()
Credits (Virtual Currency)
credits.init()
credits.requestUpdate()
credits.showOffers()
Crypto
crypto.digest()
crypto.hmac()
crypto.md4
crypto.md5
crypto.sha1
crypto.sha224
crypto.sha256
crypto.sha384
crypto.sha512
Database (SQLite)
SQLite3
Display Objects
Common Methods
object:addEventListener
object:contentToLocal()
object:dispatchEvent( )
object:getParent( ) **old**
object:localToContent()
object:removeEventListener( )
object:removeSelf( )
object:rotate( )
object:scale( )
object:setMask( )
object:setReferencePoint( )
object:toBack()
object:toFront( )
object:translate( )
Common Properties
object.alpha
object.contentBounds
object.contentHeight
object.contentWidth
object.height
object.isHitTestMasked
object.isHitTestable
object.isVisible
object.length **old**
object.maskRotation
object.maskScaleX
object.maskScaleY
object.maskX
object.maskY
object.parent
object.rotation
object.stageBounds **old**
object.stageHeight **old**
object.stageWidth **old**
object.width
object.x
object.xOrigin
object.xReference
object.xScale
object.y
object.yOrigin
object.yReference
object.yScale
Content Size Properties
display.contentCenterX
display.contentCenterY
display.contentHeight
display.contentScaleX
display.contentScaleY
display.contentWidth
display.screenOriginX
display.screenOriginY
display.statusBarHeight
display.viewableContentHeight
display.viewableContentWidth
Factory Functions
display.loadRemoteImage( )
display.newCircle()
display.newEmbossedText()
display.newGroup()
display.newImage( )
display.newImageRect()
display.newLine( )
display.newRect()
display.newRetinaText()
display.newRoundedRect()
display.newText()
Group Display Objects
group.numChildren
group:insert( )
group:remove( )
Other Display Functions
display.captureScreen( )
display.remove()
display.save( )
display.setDefault( )
display.setStatusBar( )
Stage Display Objects
display.getCurrentStage( )
stage:setFocus( )
Text Display Objects
object.size
object.text
object:setTextColor( )
Vector Display Objects
object.strokeWidth
object:append()
object:setColor()
object:setFillColor( )
object:setStrokeColor( )
Events
memoryWarning *iOS only*
Detect Network Status
event.address
event.isConnectionOnDemand
event.isConnectionRequired
event.isInteractionRequired
event.isReachable
event.isReachableViaCellular
event.isReachableViaWiFi
event.name
In-App Purchases
event.invalidProducts
event.name
event.products
event.transaction
Runtime
Runtime:addEventListener()
Runtime:hasEventSource()
Runtime:removeEventListener()
accelerometer
event.deltaTime
event.isShake
event.name
event.xGravity
event.xInstant
event.yGravity
event.yInstant
event.zGravity
event.zInstant
audio
event.channel
event.completed
event.handle
collision
event.phase
completion
event.action
event.blob
event.index
event.name
event.target
creditsRequest
event.name
event.newCredits
event.totalCredits
enterFrame
event.name
event.time
gameNetwork
event.data
event.errorCode
event.errorMessage
event.localPlayerScore
event.name
event.provider
event.type
gyroscope
event.deltaTime
event.name
event.xRotation
event.yRotation
event.zRotation
heading (compass)
event.geographic
event.magnetic
event.name
key
event.keyName
event.name
event.phase
location (GPS)
event.accuracy
event.altitude
event.direction
event.errorCode
event.errorMessage
event.latitude
event.longitude
event.name
event.speed
event.time
mapAddress
event.city
event.cityDetail
event.country
event.countryCode
event.errorMessage
event.isError
event.postalCode
event.region
event.regionDetail
event.street
event.streetDetail
notification
event.custom
event.type
orientation
event.delta
event.name
event.type
postCollision
event.force
event.friction
event.object1
event.object2
event.other
preCollision
event.other
sprite
event.phase
event.sprite
system
event.name
event.type
tap
event.name
event.numTaps
event.x
event.y
timer
event.count
event.name
event.source
event.time
touch
event.id
event.name
event.phase
event.target
event.time
event.x
event.xStart
event.y
event.yStart
urlRequest
event.errorCode
event.errorMessage
event.name
event.url
Facebook
facebook.login( )
facebook.logout( )
facebook.request( )
facebook.showDialog( )
File I/O
Explicit file manipulation
file:close()
file:flush()
file:lines()
file:read()
file:seek()
file:setvbuf()
file:write()
Implicit file manipulation
io.close()
io.flush()
io.input()
io.lines()
io.open()
io.output()
io.read()
io.tmpfile()
io.type()
io.write()
Game Network
gameNetwork.init()
gameNetwork.request()
gameNetwork.show()
Graphics
graphics.newGradient( )
graphics.newMask( )
In-App Purchases
store.canMakePurchases
store.finishTransaction()
store.init()
store.loadProducts()
store.purchase()
store.restore()
JSON
json.decode()
json.encode()
json.null()
Math
math.abs()
math.acos()
math.asin()
math.atan()
math.atan2()
math.ceil()
math.cos()
math.cosh()
math.deg()
math.exp()
math.floor()
math.fmod()
math.frexp()
math.inf
math.ldexp()
math.log()
math.log10()
math.max()
math.min()
math.modf()
math.pi
math.pow()
math.rad()
math.random()
math.randomseed()
math.round()
math.sin()
math.sinh()
math.sqrt()
math.tan()
math.tanh()
Modules and Packages
module()
package.loaded
package.loaders
package.seeall
require()
Multimedia
media.pauseSound()
media.newRecording()
media.newEventSound()
media.getSoundVolume
media.playEventSound()
media.playSound()
media.playVideo()
media.setSoundVolume()
media.show( )
media.stopSound()
object:getSampleRate()
object:getTunerFrequency()
object:getTunerVolume()
object:isRecording()
object:setSampleRate()
object:startRecording()
object:startTuner( )
object:stopRecording()
object:stopTuner()
Native UI
native.cancelAlert()
native.getFontNames()
native.getSync()
native.newFont()
native.newVideo( )
native.newWebView( )
native.setActivityIndicator()
native.setKeyboardFocus()
native.setSync()
native.showAlert()
native.showPopup( )
native.systemFont
Input Text Fields
native.newTextField()
object.align
object.font
object.inputType
object.isSecure
object.size
object.text
object:setTextColor()
Maps
myMap.isLocationVisible
myMap.isScrollEnabled
myMap.isZoomEnabled
myMap.mapType
myMap:addMarker()
myMap:getAddressLocation()
myMap:getUserLocation()
myMap:nearestAddress()
myMap:removeAllMarkers()
myMap:setCenter()
myMap:setRegion()
native.newMapView()
Text Boxes
native.newTextBox()
object.align
object.font
object.hasBackground
object.isEditable
object.size
object.text
object:setTextColor()
Web Popups
native.cancelWebPopup()
native.showWebPopup()
Network
Asynchronous HTTP
network.download( )
network.request( )
Detect Network Status
network.canDetectNetworkStatusChanges
network.setStatusListener
OpenFeint
openfeint.downloadBlob( )
openfeint.init( )
openfeint.launchDashboard( )
openfeint.setHighScore( )
openfeint.unlockAchievement( )
openfeint.uploadBlob( )
Operating System Facilities
os.clock()
os.date()
os.difftime()
os.execute()
os.exit()
os.remove()
os.rename()
os.time()
Physics
physics.addBody()
physics.getGravity()
physics.newJoint( )
physics.pause()
physics.removeBody()
physics.setDrawMode()
physics.setGravity()
physics.setPositionIterations()
physics.setScale()
physics.setVelocityIterations()
physics.start()
physics.stop()
Bodies
body.angularDamping
body.angularVelocity
body.bodyType
body.isAwake
body.isBodyActive
body.isBullet
body.isFixedRotation
body.isSensor
body.isSleepingAllowed
body.linearDamping
body:applyAngularImpulse( )
body:applyForce( )
body:applyLinearImpulse( )
body:applyTorque( )
body:getLinearVelocity( )
body:resetMassData( )
body:setLinearVelocity
Joints
joint.dampingRatio
joint.frequency
joint.isLimitEnabled
joint.isMotorEnabled
joint.jointAngle
joint.jointSpeed
joint.jointTranslation
joint.length
joint.length1
joint.length2
joint.maxForce
joint.maxMotorForce
joint.maxMotorTorque
joint.maxTorque
joint.motorForce
joint.motorSpeed
joint.motorTorque
joint.ratio
joint.reactionTorque
joint:getAnchorA( )
joint:getAnchorB( )
joint:getLimits()
joint:getReactionForce( )
joint:getRotationLimits()
joint:setLimits()
joint:setRotationLimits()
Sprite Sheets
sprite.add()
sprite.newSprite()
sprite.newSpriteMultiSet()
sprite.newSpriteSet()
sprite.newSpriteSheet()
sprite.newSpriteSheetFromData()
spriteInstance.animating
spriteInstance.currentFrame
spriteInstance.sequence
spriteInstance.timeScale
spriteInstance:addEventListener()
spriteInstance:pause()
spriteInstance:play()
spriteInstance:prepare()
spriteSheet:dispose()
Storyboard
Scene Template
storyboard.disableAutoPurge
storyboard.getCurrentSceneName()
storyboard.getPrevious()
storyboard.getScene()
storyboard.gotoScene()
storyboard.hideOverlay()
storyboard.isDebug
storyboard.loadScene()
storyboard.newScene()
storyboard.printMemUsage()
storyboard.purgeAll()
storyboard.purgeOnSceneChange
storyboard.purgeScene()
storyboard.reloadScene()
storyboard.removeAll()
storyboard.removeScene()
storyboard.showOverlay()
storyboard.stage
Strings
string.byte()
string.char()
string.find()
string.format()
string.gmatch()
string.gsub()
string.len()
string.lower()
string.match()
string.rep()
string.reverse()
string.sub()
string.upper()
System
system.DocumentsDirectory
system.ResourceDirectory
system.TemporaryDirectory
system.activate()
system.cancelNotification()
system.deactivate()
system.getInfo()
system.getPreference()
system.getTimer()
system.openURL()
system.orientation
system.pathForFile()
system.scheduleNotification()
system.setAccelerometerInterval()
system.setGyroscopeInterval()
system.setIdleTimer()
system.setLocationAccuracy()
system.setLocationThreshold()
system.vibrate()
Timer
timer.cancel()
timer.pause()
timer.performWithDelay()
timer.resume()
Widget
Bitmap Masks for tableViews and scrollViews
widget.newButton( )
widget.newPickerWheel( )
widget.newTabBar( )
widget.newTableView( )
widget.setTheme()
widget.newScrollView( )
scrollView (2012.721 and later)
widget.newSlider( )
Slider (build 2012.721 and later)