chacha/OpenRA
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
a455ed64f73d24b99935fcc7f9c02da2cbdbde80
OpenRA/api/lua/gideros.lua
Paul Kulchenko 76f6fdade6 Updated Gideros auto-complete API to add global objects.
2013-06-19 10:30:51 -07:00

3608 lines
82 KiB
Lua
Raw Blame History

-- Copyright 2011-13 Paul Kulchenko, ZeroBrane LLC
-- converted from http://docs.giderosmobile.com/reference/autocomplete.php;
-- also available in <Gideros>/Resources/gideros_annot.api.
-- the conversion script is at the bottom of this file.
return {
Accelerometer = {
childs = {
getAcceleration = {
args = "()",
description = "Returns the 3-axis acceleration measured by the accelerometer",
returns = "()",
type = "method"
},
isAvailable = {
args = "()",
description = "Does the accelerometer available?",
returns = "()",
type = "function"
},
new = {
args = "()",
description = "Creates new Accelerometer instance",
returns = "()",
type = "function"
},
start = {
args = "()",
description = "Starts accelerometer updates",
returns = "()",
type = "method"
},
stop = {
args = "()",
description = "Starts accelerometer updates",
returns = "()",
type = "method"
}
},
type = "class"
},
AlertDialog = {
childs = {
hide = {
args = "()",
description = "",
returns = "()",
type = "method"
},
new = {
args = "(title, message, cancelButton, button1, button2)",
description = "",
returns = "()",
type = "function"
},
show = {
args = "()",
description = "",
returns = "()",
type = "method"
}
},
type = "class"
},
Application = {
childs = {
LANDSCAPE_LEFT = {
description = "value \"landscapeLeft\"",
type = "value"
},
LANDSCAPE_RIGHT = {
description = "value \"landscapeRight\"",
type = "value"
},
PORTRAIT = {
description = "value \"portrait\"",
type = "value"
},
PORTRAIT_UPSIDE_DOWN = {
description = "value \"portraitUpsideDown\"",
type = "value"
}
},
type = "class"
},
Bitmap = {
childs = {
getAnchorPoint = {
args = "()",
description = "Returns the x and y coordinates of the anchor point",
returns = "()",
type = "method"
},
new = {
args = "(texture)",
description = "Creates a new Bitmap object",
returns = "()",
type = "function"
},
setAnchorPoint = {
args = "(x, y)",
description = "Sets the anchor point",
returns = "()",
type = "method"
},
setTexture = {
args = "(texture)",
description = "Sets the texture",
returns = "()",
type = "method"
},
setTextureRegion = {
args = "(textureRegion)",
description = "Sets the texture region",
returns = "()",
type = "method"
}
},
inherits = "Sprite",
type = "class"
},
Core = {
childs = {
class = {
args = "([base])",
description = "Creates and returns new Gideros class",
returns = "()",
type = "function"
}
},
type = "class"
},
Event = {
childs = {
ADDED_TO_STAGE = {
description = "value \"addedToStage\"",
type = "value"
},
APPLICATION_BACKGROUND = {
description = "value \"applicationBackground\"",
type = "value"
},
APPLICATION_EXIT = {
description = "value \"applicationExit\"",
type = "value"
},
APPLICATION_FOREGROUND = {
description = "value \"applicationForeground\"",
type = "value"
},
APPLICATION_RESUME = {
description = "value \"applicationResume\"",
type = "value"
},
APPLICATION_START = {
description = "value \"applicationStart\"",
type = "value"
},
APPLICATION_SUSPEND = {
description = "value \"applicationSuspend\"",
type = "value"
},
BANNER_ACTION_BEGIN = {
description = "value \"bannerActionBegin\"",
type = "value"
},
BANNER_ACTION_FINISHED = {
description = "value \"bannerActionFinished\"",
type = "value"
},
BANNER_AD_FAILED = {
description = "value \"bannerAdFailed\"",
type = "value"
},
BANNER_AD_LOADED = {
description = "value \"bannerAdLoaded\"",
type = "value"
},
BEGIN_CONTACT = {
description = "value \"beginContact\"",
type = "value"
},
CHECK_BILLING_SUPPORTED_COMPLETE = {
description = "value \"checkBillingSupportedComplete\"",
type = "value"
},
COMPLETE = {
description = "value \"complete\"",
type = "value"
},
CONFIRM_NOTIFICATION_COMPLETE = {
description = "value \"confirmNotificationComplete\"",
type = "value"
},
DIALOG_CANCEL = {
description = "value \"dialogCancel\"",
type = "value"
},
DIALOG_COMPLETE = {
description = "value \"dialogComplete\"",
type = "value"
},
DIALOG_ERROR = {
description = "value \"dialogError\"",
type = "value"
},
END_CONTACT = {
description = "value \"endContact\"",
type = "value"
},
ENTER_FRAME = {
description = "value \"enterFrame\"",
type = "value"
},
ERROR = {
description = "value \"error\"",
type = "value"
},
HEADING_UPDATE = {
description = "value \"headingUpdate\"",
type = "value"
},
KEY_DOWN = {
description = "value \"keyDown\"",
type = "value"
},
KEY_UP = {
description = "value \"keyUp\"",
type = "value"
},
LOCATION_UPDATE = {
description = "value \"locationUpdate\"",
type = "value"
},
LOGIN_CANCEL = {
description = "value \"loginCancel\"",
type = "value"
},
LOGIN_COMPLETE = {
description = "value \"loginComplete\"",
type = "value"
},
LOGIN_ERROR = {
description = "value \"loginError\"",
type = "value"
},
LOGOUT_COMPLETE = {
description = "value \"logoutComplete\"",
type = "value"
},
MOUSE_DOWN = {
description = "value \"mouseDown\"",
type = "value"
},
MOUSE_MOVE = {
description = "value \"mouseMove\"",
type = "value"
},
MOUSE_UP = {
description = "value \"mouseUp\"",
type = "value"
},
POST_SOLVE = {
description = "value \"postSolve\"",
type = "value"
},
PRE_SOLVE = {
description = "value \"preSolve\"",
type = "value"
},
PROGRESS = {
description = "value \"progress\"",
type = "value"
},
PURCHASE_STATE_CHANGE = {
description = "value \"purchaseStateChange\"",
type = "value"
},
REMOVED_FROM_STAGE = {
description = "value \"removedFromStage\"",
type = "value"
},
REQUEST_COMPLETE = {
description = "value \"requestComplete\"",
type = "value"
},
REQUEST_ERROR = {
description = "value \"requestError\"",
type = "value"
},
REQUEST_PRODUCTS_COMPLETE = {
description = "value \"requestProductsComplete\"",
type = "value"
},
REQUEST_PURCHASE_COMPLETE = {
description = "value \"requestPurchaseComplete\"",
type = "value"
},
RESTORE_TRANSACTIONS_COMPLETE = {
description = "value \"restoreTransactionsComplete\"",
type = "value"
},
TIMER = {
description = "value \"timer\"",
type = "value"
},
TIMER_COMPLETE = {
description = "value \"timerComplete\"",
type = "value"
},
TOUCHES_BEGIN = {
description = "value \"touchesBegin\"",
type = "value"
},
TOUCHES_CANCEL = {
description = "value \"touchesCancel\"",
type = "value"
},
TOUCHES_END = {
description = "value \"touchesEnd\"",
type = "value"
},
TOUCHES_MOVE = {
description = "value \"touchesMove\"",
type = "value"
},
TRANSACTION = {
description = "value \"transaction\"",
type = "value"
},
getTarget = {
args = "()",
description = "Returns the element on which the event listener was registered",
returns = "()",
type = "method"
},
getType = {
args = "()",
description = "Returns the type of Event",
returns = "()",
type = "method"
},
new = {
args = "(type)",
description = "Creates a new Event object",
returns = "()",
type = "function"
},
stopPropagation = {
args = "()",
description = "Stops the propagation of the current event in the scene tree hierarchy",
returns = "()",
type = "method"
}
},
type = "class"
},
EventDispatcher = {
childs = {
addEventListener = {
args = "(type, listener [, data])",
description = "Registers a listener function",
returns = "()",
type = "method"
},
dispatchEvent = {
args = "(event)",
description = "Dispatches an event",
returns = "()",
type = "method"
},
hasEventListener = {
args = "(type)",
description = "Checks if the EventDispatcher object has a event listener",
returns = "()",
type = "method"
},
new = {
args = "()",
description = "Creates a new EventDispatcher object",
returns = "()",
type = "function"
},
removeEventListener = {
args = "(type, listener, data)",
description = "Removes a listener function",
returns = "()",
type = "method"
}
},
type = "class"
},
Facebook = {
childs = {
authorize = {
args = "(permissions)",
description = "",
returns = "()",
type = "method"
},
dialog = {
args = "(action, paramaters)",
description = "",
returns = "()",
type = "method"
},
extendAccessToken = {
args = "()",
description = "",
returns = "()",
type = "method"
},
extendAccessTokenIfNeeded = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getAccessToken = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getExpirationDate = {
args = "()",
description = "",
returns = "()",
type = "method"
},
graphRequest = {
args = "(graphPath, paramaters, method)",
description = "",
returns = "()",
type = "method"
},
isSessionValid = {
args = "()",
description = "",
returns = "()",
type = "method"
},
logout = {
args = "()",
description = "",
returns = "()",
type = "method"
},
setAccessToken = {
args = "(accessToken)",
description = "",
returns = "()",
type = "method"
},
setAppId = {
args = "(appId)",
description = "",
returns = "()",
type = "method"
},
setExpirationDate = {
args = "(expirationDate)",
description = "",
returns = "()",
type = "method"
},
shouldExtendAccessToken = {
args = "()",
description = "",
returns = "()",
type = "method"
}
},
inherits = "EventDispatcher",
type = "class"
},
Font = {
childs = {
new = {
args = "(txtfile, imagefile, filtering)",
description = "Creates a new Font object",
returns = "()",
type = "function"
}
},
inherits = "FontBase",
type = "class"
},
FontBase = {
childs = {
getAdvanceX = {
args = "(text, letterSpacing, size)",
description = "",
returns = "()",
type = "method"
},
getAscender = {
args = "()",
description = "Returns the ascender of the font",
returns = "()",
type = "method"
},
getBounds = {
args = "(text)",
description = "Returns the tight bounding rectangle of the characters in the string specified by text",
returns = "()",
type = "method"
},
getLineHeight = {
args = "()",
description = "Returns the distance from one base line to the next",
returns = "()",
type = "method"
}
},
type = "class"
},
Geolocation = {
childs = {
getAccuracy = {
args = "()",
description = "Returns the previously set desired accuracy",
returns = "()",
type = "function"
},
getThreshold = {
args = "()",
description = "Returns the previously set minimum distance threshold",
returns = "()",
type = "function"
},
isAvailable = {
args = "()",
description = "Does this device have the capability to determine current location?",
returns = "()",
type = "function"
},
isHeadingAvailable = {
args = "()",
description = "Does this device have the capability to determine heading?",
returns = "()",
type = "function"
},
new = {
args = "()",
description = "Creates new Geolocation instance",
returns = "()",
type = "function"
},
setAccuracy = {
args = "(accuracy)",
description = "Of the location data",
returns = "()",
type = "function"
},
setThreshold = {
args = "(threshold)",
description = "Threshold",
returns = "()",
type = "function"
},
start = {
args = "()",
description = "Starts the generation of updates that report the current location and heading",
returns = "()",
type = "method"
},
startUpdatingHeading = {
args = "()",
description = "Starts the generation of updates that report the heading",
returns = "()",
type = "method"
},
startUpdatingLocation = {
args = "()",
description = "Starts the generation of updates that report the current location",
returns = "()",
type = "method"
},
stop = {
args = "()",
description = "Stops the generation of updates that report the current location and heading",
returns = "()",
type = "method"
},
stopUpdatingHeading = {
args = "()",
description = "Stops the generation of updates that report the heading",
returns = "()",
type = "method"
},
stopUpdatingLocation = {
args = "()",
description = "Stops the generation of updates that report the current location",
returns = "()",
type = "method"
}
},
inherits = "EventDispatcher",
type = "class"
},
GoogleBilling = {
childs = {
BILLING_UNAVAILABLE = {
description = "value \"billingUnavailable\"",
type = "value"
},
CANCELED = {
description = "value \"canceled\"",
type = "value"
},
DEVELOPER_ERROR = {
description = "value \"developerError\"",
type = "value"
},
ERROR = {
description = "value \"error\"",
type = "value"
},
EXPIRED = {
description = "value \"expired\"",
type = "value"
},
INAPP = {
description = "value \"inapp\"",
type = "value"
},
ITEM_UNAVAILABLE = {
description = "value \"itemUnavailable\"",
type = "value"
},
OK = {
description = "value \"ok\"",
type = "value"
},
PURCHASED = {
description = "value \"purchased\"",
type = "value"
},
REFUNDED = {
description = "value \"refunded\"",
type = "value"
},
SERVICE_UNAVAILABLE = {
description = "value \"serviceUnavailable\"",
type = "value"
},
SUBS = {
description = "value \"subs\"",
type = "value"
},
USER_CANCELED = {
description = "value \"userCanceled\"",
type = "value"
},
checkBillingSupported = {
args = "(productType)",
description = "",
returns = "()",
type = "method"
},
confirmNotification = {
args = "(notificationId)",
description = "",
returns = "()",
type = "method"
},
requestPurchase = {
args = "(productId, productType, developerPayload)",
description = "",
returns = "()",
type = "method"
},
restoreTransactions = {
args = "()",
description = "",
returns = "()",
type = "method"
},
setApiVersion = {
args = "(apiVersion)",
description = "",
returns = "()",
type = "method"
},
setPublicKey = {
args = "(publicKey)",
description = "",
returns = "()",
type = "method"
}
},
type = "class"
},
Gyroscope = {
childs = {
getRotationRate = {
args = "()",
description = "Returns the rotation rate in radians per second",
returns = "()",
type = "method"
},
isAvailable = {
args = "()",
description = "Does the gyroscope available?",
returns = "()",
type = "function"
},
new = {
args = "()",
description = "Creates new Gyroscope instance",
returns = "()",
type = "function"
},
start = {
args = "()",
description = "Starts gyroscope updates",
returns = "()",
type = "method"
},
stop = {
args = "()",
description = "Stops gyroscope updates",
returns = "()",
type = "method"
}
},
type = "class"
},
KeyCode = {
childs = {
BACK = {
description = "value \"301\"",
type = "value"
},
CENTER = {
description = "value \"304\"",
type = "value"
},
DOWN = {
description = "value \"40\"",
type = "value"
},
L1 = {
description = "value \"307\"",
type = "value"
},
LEFT = {
description = "value \"37\"",
type = "value"
},
MENU = {
description = "value \"303\"",
type = "value"
},
R1 = {
description = "value \"308\"",
type = "value"
},
RIGHT = {
description = "value \"39\"",
type = "value"
},
SEARCH = {
description = "value \"302\"",
type = "value"
},
SELECT = {
description = "value \"305\"",
type = "value"
},
START = {
description = "value \"306\"",
type = "value"
},
UP = {
description = "value \"38\"",
type = "value"
},
X = {
description = "value \"88\"",
type = "value"
},
Y = {
description = "value \"89\"",
type = "value"
}
},
type = "class"
},
Matrix = {
childs = {
getElements = {
args = "()",
description = "Returns the elements of this matrix instance",
returns = "()",
type = "method"
},
getM11 = {
args = "()",
description = "Returns the value of the m11 component",
returns = "()",
type = "method"
},
getM12 = {
args = "()",
description = "Returns the value of the m12 component",
returns = "()",
type = "method"
},
getM21 = {
args = "()",
description = "Returns the value of the m21 component",
returns = "()",
type = "method"
},
getM22 = {
args = "()",
description = "Returns the value of the m22 component",
returns = "()",
type = "method"
},
getTx = {
args = "()",
description = "Returns the value of the tx component",
returns = "()",
type = "method"
},
getTy = {
args = "()",
description = "Returns the value of the ty component",
returns = "()",
type = "method"
},
new = {
args = "(m11, m12, m21, m22, tx, ty)",
description = "Creates a new Matrix object",
returns = "()",
type = "function"
},
setElements = {
args = "(m11, m12, m21, m22, tx, ty)",
description = "Sets all 6 elements of this matrix instance",
returns = "()",
type = "method"
},
setM11 = {
args = "(m11)",
description = "Sets the value of the m11 component",
returns = "()",
type = "method"
},
setM12 = {
args = "(m12)",
description = "Sets the value of the m22 component",
returns = "()",
type = "method"
},
setM21 = {
args = "(m21)",
description = "",
returns = "()",
type = "method"
},
setM22 = {
args = "(m22)",
description = "",
returns = "()",
type = "method"
},
setTx = {
args = "(tx)",
description = "Sets the value of the tx component",
returns = "()",
type = "method"
},
setTy = {
args = "(ty)",
description = "Sets the value of the ty component",
returns = "()",
type = "method"
}
},
type = "class"
},
Mesh = {
childs = {
clearColorArray = {
args = "()",
description = "",
returns = "()",
type = "method"
},
clearIndexArray = {
args = "()",
description = "",
returns = "()",
type = "method"
},
clearTexture = {
args = "()",
description = "",
returns = "()",
type = "method"
},
clearTextureCoordinateArray = {
args = "()",
description = "",
returns = "()",
type = "method"
},
clearVertexArray = {
args = "()",
description = "",
returns = "()",
type = "method"
},
new = {
args = "()",
description = "",
returns = "()",
type = "function"
},
resizeColorArray = {
args = "(size)",
description = "",
returns = "()",
type = "method"
},
resizeIndexArray = {
args = "(size)",
description = "",
returns = "()",
type = "method"
},
resizeTextureCoordinateArray = {
args = "(size)",
description = "",
returns = "()",
type = "method"
},
resizeVertexArray = {
args = "(size)",
description = "",
returns = "()",
type = "method"
},
setColor = {
args = "(i, color, alpha)",
description = "",
returns = "()",
type = "method"
},
setColorArray = {
args = "(colors)",
description = "",
returns = "()",
type = "method"
},
setColors = {
args = "(colors)",
description = "",
returns = "()",
type = "method"
},
setIndex = {
args = "(i, index)",
description = "",
returns = "()",
type = "method"
},
setIndexArray = {
args = "(indices)",
description = "",
returns = "()",
type = "method"
},
setIndices = {
args = "(indices)",
description = "",
returns = "()",
type = "method"
},
setTexture = {
args = "(texture)",
description = "",
returns = "()",
type = "method"
},
setTextureCoordinate = {
args = "(i, u, v)",
description = "",
returns = "()",
type = "method"
},
setTextureCoordinateArray = {
args = "(textureCoordinates)",
description = "",
returns = "()",
type = "method"
},
setTextureCoordinates = {
args = "(textureCoordinates)",
description = "",
returns = "()",
type = "method"
},
setVertex = {
args = "(i, x, y)",
description = "",
returns = "()",
type = "method"
},
setVertexArray = {
args = "(vertices)",
description = "",
returns = "()",
type = "method"
},
setVertices = {
args = "(vertices)",
description = "",
returns = "()",
type = "method"
}
},
inherits = "Sprite",
type = "class"
},
MovieClip = {
childs = {
clearAction = {
args = "(frame)",
description = "Clears the action at the specified frame",
returns = "()",
type = "method"
},
gotoAndPlay = {
args = "(frame)",
description = "Goes to the specified frame and starts playing",
returns = "()",
type = "method"
},
gotoAndStop = {
args = "(frame)",
description = "Goes to the specified frame and stops",
returns = "()",
type = "method"
},
new = {
args = "(timeline)",
description = "Creates a new MovieClip object",
returns = "()",
type = "function"
},
play = {
args = "()",
description = "Starts playing the movie clip",
returns = "()",
type = "method"
},
setGotoAction = {
args = "(frame, destframe)",
description = "Sets a \"go to\" action to the specified frame",
returns = "()",
type = "method"
},
setStopAction = {
args = "(frame)",
description = "Sets a \"stop\" action to the specified frame",
returns = "()",
type = "method"
},
stop = {
args = "()",
description = "Stops playing the movie clip",
returns = "()",
type = "method"
}
},
inherits = "Sprite",
type = "class"
},
Shape = {
childs = {
EVEN_ODD = {
description = "value \"evenOdd\"",
type = "value"
},
NONE = {
description = "value \"none\"",
type = "value"
},
NON_ZERO = {
description = "value \"nonZero\"",
type = "value"
},
SOLID = {
description = "value \"solid\"",
type = "value"
},
TEXTURE = {
description = "value \"texture\"",
type = "value"
},
beginPath = {
args = "(winding)",
description = "Resets the current path",
returns = "()",
type = "method"
},
clear = {
args = "()",
description = "Clears the graphics that were drawn to this Shape object, and resets fill and line style settings",
returns = "()",
type = "method"
},
closePath = {
args = "()",
description = "Marks the current subpath as closed, and starts a new subpath with a point the same as the start and end of the newly closed subpath",
returns = "()",
type = "method"
},
endPath = {
args = "()",
description = "Ends the current path and draws the geometry by using the specified line and fill styles",
returns = "()",
type = "method"
},
lineTo = {
args = "(x, y)",
description = "Adds the given point to the current subpath, connected to the previous one by a straight line.",
returns = "()",
type = "method"
},
moveTo = {
args = "(x, y)",
description = "Creates a new subpath with the given point",
returns = "()",
type = "method"
},
new = {
args = "()",
description = "Creates a new Shape object",
returns = "()",
type = "function"
},
setFillStyle = {
args = "(type, ...)",
description = "Sets the fill style that Shape object uses for subsequent drawings",
returns = "()",
type = "method"
},
setLineStyle = {
args = "(width, color, alpha)",
description = "Sets the line style that Shape object uses for subsequent drawings",
returns = "()",
type = "method"
}
},
inherits = "Sprite",
type = "class"
},
Sound = {
childs = {
getLength = {
args = "()",
description = "",
returns = "()",
type = "method"
},
new = {
args = "(filename)",
description = "Creates a new Sound object",
returns = "()",
type = "function"
},
play = {
args = "(startTime, looping, paused)",
description = "Creates a new SoundChannel object to play the sound",
returns = "()",
type = "method"
}
},
type = "class"
},
SoundChannel = {
childs = {
getPitch = {
args = "()",
description = "Returns the current pitch of the sound channel",
returns = "()",
type = "method"
},
getPosition = {
args = "()",
description = "Returns the position of the current playback",
returns = "()",
type = "method"
},
getVolume = {
args = "()",
description = "Returns the current volume of the sound channel",
returns = "()",
type = "method"
},
isLooping = {
args = "()",
description = "Returns the looping state of the channel",
returns = "()",
type = "method"
},
isPaused = {
args = "()",
description = "Returns the paused state of the channel",
returns = "()",
type = "method"
},
isPlaying = {
args = "()",
description = "Returns the playing state for the sound channel",
returns = "()",
type = "method"
},
setLooping = {
args = "(looping)",
description = "Sets the looping state of the channel",
returns = "()",
type = "method"
},
setPaused = {
args = "(paused)",
description = "Sets the paused state of the channel",
returns = "()",
type = "method"
},
setPitch = {
args = "(pitch)",
description = "Sets the pitch of the sound channel",
returns = "()",
type = "method"
},
setPosition = {
args = "(position)",
description = "Sets the position of the current playback",
returns = "()",
type = "method"
},
setVolume = {
args = "(volume)",
description = "Sets the volume of the sound channel",
returns = "()",
type = "method"
},
stop = {
args = "()",
description = "Stops the sound playing in the channel",
returns = "()",
type = "method"
}
},
type = "class"
},
Sprite = {
childs = {
ADD = {
description = "value \"add\"",
type = "value"
},
ALPHA = {
description = "value \"alpha\"",
type = "value"
},
MULTIPLY = {
description = "value \"multiply\"",
type = "value"
},
NO_ALPHA = {
description = "value \"noAlpha\"",
type = "value"
},
SCREEN = {
description = "value \"screen\"",
type = "value"
},
addChild = {
args = "(child)",
description = "Adds a sprite as a child",
returns = "()",
type = "method"
},
addChildAt = {
args = "(child, index)",
description = "Add a sprite as a child at the index position specified",
returns = "()",
type = "method"
},
clearBlendMode = {
args = "()",
description = "Clears the blending mode",
returns = "()",
type = "method"
},
contains = {
args = "(child)",
description = "Determines whether the specified sprite is contained in the subtree of this sprite",
returns = "()",
type = "method"
},
get = {
args = "(param)",
description = "Gets the specified property by its name",
returns = "()",
type = "method"
},
getAlpha = {
args = "()",
description = "Returns the alpha transparency of this sprite",
returns = "()",
type = "method"
},
getBounds = {
args = "(targetSprite)",
description = "Returns the bounds as it appears in another sprite's coordinate system",
returns = "()",
type = "method"
},
getChildAt = {
args = "(index)",
description = "Returns the child sprite that exists at the specified index",
returns = "()",
type = "method"
},
getChildIndex = {
args = "(child)",
description = "Returns the index of the specified child sprite",
returns = "()",
type = "method"
},
getColorTransform = {
args = "()",
description = "Returns the red, green, blue and alpha channel multipliers",
returns = "()",
type = "method"
},
getHeight = {
args = "()",
description = "Returns the height",
returns = "()",
type = "method"
},
getMatrix = {
args = "()",
description = "Returns the transformation matrix of the sprite",
returns = "()",
type = "method"
},
getNumChildren = {
args = "()",
description = "Returns the number of children of this sprite",
returns = "()",
type = "method"
},
getParent = {
args = "()",
description = "Returns the parent sprite",
returns = "()",
type = "method"
},
getPosition = {
args = "()",
description = "Gets the x,y coordinates of the sprite",
returns = "()",
type = "method"
},
getRotation = {
args = "()",
description = "Returns the rotation of the sprite in degrees",
returns = "()",
type = "method"
},
getScale = {
args = "()",
description = "Returns the horizontal and vertical scales of the sprite",
returns = "()",
type = "method"
},
getScaleX = {
args = "()",
description = "Returns the horizontal scale of the sprite",
returns = "()",
type = "method"
},
getScaleY = {
args = "()",
description = "Returns the vertical scale of the sprite",
returns = "()",
type = "method"
},
getWidth = {
args = "()",
description = "Returns the width",
returns = "()",
type = "method"
},
getX = {
args = "()",
description = "Returns the x coordinate of the sprite",
returns = "()",
type = "method"
},
getY = {
args = "()",
description = "Returns the y coordinate of the sprite",
returns = "()",
type = "method"
},
globalToLocal = {
args = "(x, y)",
description = "Converts the x,y coordinates from the global to the sprite's (local) coordinates",
returns = "()",
type = "method"
},
hitTestPoint = {
args = "(x, y)",
description = "Checks the given coordinates is in bounds of the sprite",
returns = "()",
type = "method"
},
isVisible = {
args = "()",
description = "Returns the visibility of sprite",
returns = "()",
type = "method"
},
localToGlobal = {
args = "(x, y)",
description = "Converts the x,y coordinates from the sprite's (local) coordinates to the global coordinates",
returns = "()",
type = "method"
},
new = {
args = "()",
description = "Creates a new Sprite object",
returns = "()",
type = "function"
},
removeChild = {
args = "(child)",
description = "Removes the child sprite",
returns = "()",
type = "method"
},
removeChildAt = {
args = "(index)",
description = "Removes the child sprite at the specifed index",
returns = "()",
type = "method"
},
removeFromParent = {
args = "()",
description = "If the sprite has a parent, removes the sprite from the child list of its parent sprite.",
returns = "()",
type = "method"
},
set = {
args = "(param, value)",
description = "Sets the specified property by its name",
returns = "()",
type = "method"
},
setAlpha = {
args = "(alpha)",
description = "Sets the alpha transparency of this sprite",
returns = "()",
type = "method"
},
setBlendMode = {
args = "(blendMode)",
description = "Sets the blend mode of the sprite",
returns = "()",
type = "method"
},
setColorTransform = {
args = "(redMultiplier, greenMultiplier, blueMultiplier, alphaMultiplier)",
description = "Sets the red, green, blue and alpha channel multipliers",
returns = "()",
type = "method"
},
setMatrix = {
args = "(matrix)",
description = "Sets the transformation matrix of the sprite",
returns = "()",
type = "method"
},
setPosition = {
args = "(x, y)",
description = "Sets the x,y coordinates of the sprite",
returns = "()",
type = "method"
},
setRotation = {
args = "(rotation)",
description = "Sets the rotation of the sprite in degrees",
returns = "()",
type = "method"
},
setScale = {
args = "(scaleX, scaleY)",
description = "Sets the horizontal and vertical scales of the sprite",
returns = "()",
type = "method"
},
setScaleX = {
args = "(scaleX)",
description = "Sets the horizontal scale of the sprite",
returns = "()",
type = "method"
},
setScaleY = {
args = "(scaleY)",
description = "Sets the vertical scale of the sprite",
returns = "()",
type = "method"
},
setVisible = {
args = "(visible)",
description = "Sets the visibility of sprite",
returns = "()",
type = "method"
},
setX = {
args = "(x)",
description = "Sets the x coordinate of the sprite",
returns = "()",
type = "method"
},
setY = {
args = "(y)",
description = "Sets the y coordinate of the sprite",
returns = "()",
type = "method"
}
},
inherits = "EventDispatcher",
type = "class"
},
Stage = {
childs = {},
inherits = "Sprite",
type = "class"
},
StoreKit = {
childs = {
FAILED = {
description = "value \"failed\"",
type = "value"
},
PURCHASED = {
description = "value \"purchased\"",
type = "value"
},
RESTORED = {
description = "value \"restored\"",
type = "value"
},
canMakePayments = {
args = "()",
description = "Returns whether the user is allowed to make payments",
returns = "()",
type = "method"
},
finishTransaction = {
args = "(transaction)",
description = "Completes a pending transaction",
returns = "()",
type = "method"
},
new = {
args = "()",
description = "Creates a new StoreKit object",
returns = "()",
type = "function"
},
purchase = {
args = "(productIdentifier, quantity)",
description = "Process a payment request",
returns = "()",
type = "method"
},
requestProducts = {
args = "(productIdentifiers)",
description = "Retrieve localized information about a list of products",
returns = "()",
type = "method"
},
restoreCompletedTransactions = {
args = "()",
description = "Restore previously completed purchases",
returns = "()",
type = "method"
}
},
type = "class"
},
TTFont = {
childs = {
new = {
args = "(filename, size, text, filtering)",
description = "Creates a new TTFont object",
returns = "()",
type = "function"
}
},
inherits = "FontBase",
type = "class"
},
TextField = {
childs = {
getLetterSpacing = {
args = "()",
description = "Returns the letter-spacing property which is used to increase or decrease the space between characters in a text",
returns = "()",
type = "method"
},
getText = {
args = "()",
description = "Returns the text displayed",
returns = "()",
type = "method"
},
getTextColor = {
args = "()",
description = "Returns the color of the text in a text field in hexadecimal format",
returns = "()",
type = "method"
},
new = {
args = "(font, text)",
description = "Creates a new TextField object with the specified font and text",
returns = "()",
type = "function"
},
setLetterSpacing = {
args = "(spacing)",
description = "Sets the letter-spacing property which is used to increase or decrease the space between characters in a text",
returns = "()",
type = "method"
},
setText = {
args = "(text)",
description = "Sets the text to be displayed",
returns = "()",
type = "method"
},
setTextColor = {
args = "(color)",
description = "Sets the color of the text in a text field in hexadecimal format",
returns = "()",
type = "method"
}
},
inherits = "Sprite",
type = "class"
},
TextInputDialog = {
childs = {
EMAIL = {
description = "value \"email\"",
type = "value"
},
NUMBER = {
description = "value \"number\"",
type = "value"
},
PHONE = {
description = "value \"phone\"",
type = "value"
},
TEXT = {
description = "value \"text\"",
type = "value"
},
URL = {
description = "value \"url\"",
type = "value"
},
getInputType = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getText = {
args = "()",
description = "",
returns = "()",
type = "method"
},
isSecureInput = {
args = "()",
description = "",
returns = "()",
type = "method"
},
new = {
args = "(title, message, text, cancelButton, button1, button2)",
description = "",
returns = "()",
type = "function"
},
setInputType = {
args = "(type)",
description = "",
returns = "()",
type = "method"
},
setSecureInput = {
args = "(secureInput)",
description = "",
returns = "()",
type = "method"
},
setText = {
args = "(text)",
description = "",
returns = "()",
type = "method"
}
},
type = "class"
},
Texture = {
childs = {
new = {
args = "(filename, filtering, options)",
description = "Creates a new Texture object",
returns = "()",
type = "function"
}
},
inherits = "TextureBase",
type = "class"
},
TextureBase = {
childs = {
CLAMP = {
description = "value \"clamp\"",
type = "value"
},
REPEAT = {
description = "value \"repeat\"",
type = "value"
},
getHeight = {
args = "()",
description = "Returns the height of the texture in pixels",
returns = "()",
type = "method"
},
getWidth = {
args = "()",
description = "Returns the width of the texture in pixels",
returns = "()",
type = "method"
}
},
type = "class"
},
TexturePack = {
childs = {
getTextureRegion = {
args = "(texturename)",
description = "Returns the texture region of texture pack",
returns = "()",
type = "method"
},
new = {
args = "(txtfile, imagefile, filtering, options)",
description = "",
returns = "()",
type = "function"
}
},
inherits = "TextureBase",
type = "class"
},
TextureRegion = {
childs = {
getRegion = {
args = "()",
description = "Returns the coordinates of the region",
returns = "()",
type = "method"
},
new = {
args = "(texture, x, y, width, height)",
description = "",
returns = "()",
type = "function"
},
setRegion = {
args = "(x, y, width, height)",
description = "Sets the coordinates of the region",
returns = "()",
type = "method"
}
},
type = "class"
},
TileMap = {
childs = {
FLIP_DIAGONAL = {
description = "value \"1\"",
type = "value"
},
FLIP_HORIZONTAL = {
description = "value \"4\"",
type = "value"
},
FLIP_VERTICAL = {
description = "value \"2\"",
type = "value"
},
clearTile = {
args = "(x, y)",
description = "Set an empty tile at given indices",
returns = "()",
type = "method"
},
getTile = {
args = "(x, y)",
description = "Returns the index of the tile",
returns = "()",
type = "method"
},
new = {
args = "(width, height, texture, tilewidth, tileheight, spacingx, spacingy, marginx, marginy, displaywidth, displayheight)",
description = "Creates a new TileMap instance",
returns = "()",
type = "function"
},
setTile = {
args = "(x, y, tx, ty, flip)",
description = "Sets the index of the tile",
returns = "()",
type = "method"
},
shift = {
args = "(dx, dy)",
description = "Shifts the tile map",
returns = "()",
type = "method"
}
},
inherits = "Sprite",
type = "class"
},
Timer = {
childs = {
delayedCall = {
args = "(delay, func [, data])",
description = "Delayed call a function after a set amount of time",
returns = "()",
type = "function"
},
getCurrentCount = {
args = "()",
description = "Returns the current trigger count of the timer",
returns = "()",
type = "method"
},
getDelay = {
args = "()",
description = "Returns the time interval between timer events in milliseconds",
returns = "()",
type = "method"
},
getRepeatCount = {
args = "()",
description = "Returns the number of repetitions the timer will make",
returns = "()",
type = "method"
},
isRunning = {
args = "()",
description = "Returns the current running status of timer",
returns = "()",
type = "method"
},
new = {
args = "(delay, repeatCount)",
description = "Creates a new Timer object",
returns = "()",
type = "function"
},
pauseAll = {
args = "()",
description = "Pause all timers",
returns = "()",
type = "function"
},
reset = {
args = "()",
description = "Stops the timer and sets the currentCount property to 0",
returns = "()",
type = "method"
},
resumeAll = {
args = "()",
description = "Resume all timers",
returns = "()",
type = "function"
},
setDelay = {
args = "(delay)",
description = "Sets the time interval between timer events in milliseconds",
returns = "()",
type = "method"
},
setRepeatCount = {
args = "(repeatCount)",
description = "Sets the number of repetitions the timer will make",
returns = "()",
type = "method"
},
start = {
args = "()",
description = "Starts the timer",
returns = "()",
type = "method"
},
stop = {
args = "()",
description = "Stops the timer",
returns = "()",
type = "method"
},
stopAll = {
args = "()",
description = "Stop all timers",
returns = "()",
type = "function"
}
},
type = "class"
},
UrlLoader = {
childs = {
DELETE = {
description = "value \"delete\"",
type = "value"
},
GET = {
description = "value \"get\"",
type = "value"
},
POST = {
description = "value \"post\"",
type = "value"
},
PUT = {
description = "value \"put\"",
type = "value"
},
close = {
args = "()",
description = "Terminates the current loading operation",
returns = "()",
type = "method"
},
load = {
args = "(url, method, headers, body)",
description = "Loads data from the specified URL",
returns = "()",
type = "method"
},
new = {
args = "(url, method, headers, body)",
description = "Creates a new UrlLoader object",
returns = "()",
type = "function"
}
},
type = "class"
},
application = {
childs = {
exit = {
args = "()",
description = "Terminates the application",
returns = "()",
type = "method"
},
getApiVersion = {
args = "()",
description = "Returns the API version",
returns = "()",
type = "method"
},
getBackgroundColor = {
args = "()",
description = "Returns the background color in hexadecimal format",
returns = "()",
type = "method"
},
getContentHeight = {
args = "()",
description = "Returns content height",
returns = "()",
type = "method"
},
getContentWidth = {
args = "()",
description = "Returns content width",
returns = "()",
type = "method"
},
getDeviceHeight = {
args = "()",
description = "Returns the physical height of the device in pixels",
returns = "()",
type = "method"
},
getDeviceInfo = {
args = "()",
description = "Returns information about device",
returns = "()",
type = "method"
},
getDeviceWidth = {
args = "()",
description = "Returns the physical width of the device in pixels",
returns = "()",
type = "method"
},
getFps = {
args = "()",
description = "Returns the frame rate of the application",
returns = "()",
type = "method"
},
getLanguage = {
args = "()",
description = "Returns the user language",
returns = "()",
type = "method"
},
getLocale = {
args = "()",
description = "Returns the device locale",
returns = "()",
type = "method"
},
getLogicalHeight = {
args = "()",
description = "Returns the logical height of the application",
returns = "()",
type = "method"
},
getLogicalScaleX = {
args = "()",
description = "Returns the scaling of automatic screen scaling on the x-axis",
returns = "()",
type = "method"
},
getLogicalScaleY = {
args = "()",
description = "Returns the scaling of automatic screen scaling on the y-axis",
returns = "()",
type = "method"
},
getLogicalTranslateX = {
args = "()",
description = "Returns the translation of automatic screen scaling on the x-axis",
returns = "()",
type = "method"
},
getLogicalTranslateY = {
args = "()",
description = "Returns the translation of automatic screen scaling on the y-axis",
returns = "()",
type = "method"
},
getLogicalWidth = {
args = "()",
description = "Returns the logical width of the application",
returns = "()",
type = "method"
},
getOrientation = {
args = "()",
description = "Returns the orientation of the application",
returns = "()",
type = "method"
},
getScaleMode = {
args = "()",
description = "Returns the automatic scale mode of the application",
returns = "()",
type = "method"
},
getScreenDensity = {
args = "()",
description = "Returns the screen density in pixels per inch",
returns = "()",
type = "method"
},
getTextureMemoryUsage = {
args = "()",
description = "Returns the texture memory usage in Kbytes",
returns = "()",
type = "method"
},
openUrl = {
args = "()",
description = "Opens the given URL in the appropriate application",
returns = "()",
type = "method"
},
setBackgroundColor = {
args = "(color)",
description = "Sets the background color in hexadecimal format",
returns = "()",
type = "method"
},
setFps = {
args = "(fps)",
description = "Sets the frame rate of the application",
returns = "()",
type = "method"
},
setKeepAwake = {
args = "(keepAwake)",
description = "Enables/disables screen dimming and device sleeping",
returns = "()",
type = "method"
},
setLogicalDimensions = {
args = "(width, height)",
description = "Sets the logical dimensions of the application",
returns = "()",
type = "method"
},
setOrientation = {
args = "(orientation)",
description = "Sets the orientation of the application",
returns = "()",
type = "method"
},
setScaleMode = {
args = "(scaleMode)",
description = "Sets the automatic scale mode of the application",
returns = "()",
type = "method"
},
vibrate = {
args = "()",
description = "Vibrates the device",
returns = "()",
type = "method"
}
},
type = "class"
},
b2 = {
childs = {
Body = {
childs = {
applyAngularImpulse = {
args = "(impulse)",
description = "Applies an angular impulse",
returns = "()",
type = "method"
},
applyForce = {
args = "(forcex, forcey, pointx, pointy)",
description = "Applies a force at a world point",
returns = "()",
type = "method"
},
applyLinearImpulse = {
args = "(impulsex, impulsey, pointx, pointy)",
description = "Applies an impulse at a point",
returns = "()",
type = "method"
},
applyTorque = {
args = "(torque)",
description = "Applies a torque",
returns = "()",
type = "method"
},
createFixture = {
args = "(fixtureDef)",
description = "Creates a fixture and attach it to this body",
returns = "()",
type = "method"
},
destroyFixture = {
args = "(fixture)",
description = "Destroys a fixture",
returns = "()",
type = "method"
},
getAngle = {
args = "()",
description = "Returns the current world rotation angle in radians",
returns = "()",
type = "method"
},
getAngularDamping = {
args = "()",
description = "Returns the angular damping of the body",
returns = "()",
type = "method"
},
getAngularVelocity = {
args = "()",
description = "Returns the angular velocity",
returns = "()",
type = "method"
},
getGravityScale = {
args = "()",
description = "Returns the gravity scale of the body",
returns = "()",
type = "method"
},
getInertia = {
args = "()",
description = "Returns the rotational inertia of the body about the local origin in kg-m^2",
returns = "()",
type = "method"
},
getLinearDamping = {
args = "()",
description = "Returns the linear damping of the body",
returns = "()",
type = "method"
},
getLinearVelocity = {
args = "()",
description = "Returns the linear velocity of the center of mass",
returns = "()",
type = "method"
},
getLocalCenter = {
args = "()",
description = "Returns the local position of the center of mass",
returns = "()",
type = "method"
},
getLocalPoint = {
args = "(x, y)",
description = "",
returns = "()",
type = "method"
},
getLocalVector = {
args = "(x, y)",
description = "",
returns = "()",
type = "method"
},
getMass = {
args = "()",
description = "Returns the total mass of the body in kilograms (kg)",
returns = "()",
type = "method"
},
getPosition = {
args = "()",
description = "Returns the world body origin position",
returns = "()",
type = "method"
},
getWorldCenter = {
args = "()",
description = "Returns the world position of the center of mass",
returns = "()",
type = "method"
},
getWorldPoint = {
args = "(x, y)",
description = "",
returns = "()",
type = "method"
},
getWorldVector = {
args = "(x, y)",
description = "",
returns = "()",
type = "method"
},
isActive = {
args = "()",
description = "Returns the active state of the body",
returns = "()",
type = "method"
},
isAwake = {
args = "()",
description = "Returns the sleeping state of the body",
returns = "()",
type = "method"
},
isBullet = {
args = "()",
description = "",
returns = "()",
type = "method"
},
isFixedRotation = {
args = "()",
description = "",
returns = "()",
type = "method"
},
isSleepingAllowed = {
args = "()",
description = "",
returns = "()",
type = "method"
},
setActive = {
args = "(flag)",
description = "Sets the active state of the body",
returns = "()",
type = "method"
},
setAngle = {
args = "(angle)",
description = "",
returns = "()",
type = "method"
},
setAngularDamping = {
args = "(angularDamping)",
description = "Sets the angular damping of the body",
returns = "()",
type = "method"
},
setAngularVelocity = {
args = "(omega)",
description = "Sets the angular velocity",
returns = "()",
type = "method"
},
setAwake = {
args = "(awake)",
description = "Sets the sleep state of the body",
returns = "()",
type = "method"
},
setBullet = {
args = "(flag)",
description = "",
returns = "()",
type = "method"
},
setFixedRotation = {
args = "(flag)",
description = "",
returns = "()",
type = "method"
},
setGravityScale = {
args = "(scale)",
description = "Sets the gravity scale of the body",
returns = "()",
type = "method"
},
setLinearDamping = {
args = "(linearDamping)",
description = "Sets the linear damping of the body",
returns = "()",
type = "method"
},
setLinearVelocity = {
args = "(x, y)",
description = "Sets the linear velocity of the center of mass",
returns = "()",
type = "method"
},
setPosition = {
args = "(x, y)",
description = "Sets the world body origin position",
returns = "()",
type = "method"
},
setSleepingAllowed = {
args = "(flag)",
description = "",
returns = "()",
type = "method"
}
},
type = "class"
},
ChainShape = {
childs = {
createChain = {
args = "(vertices)",
description = "Creates a chain with isolated end vertices",
returns = "()",
type = "method"
},
createLoop = {
args = "(vertices)",
description = "Creates a loop",
returns = "()",
type = "method"
},
new = {
args = "()",
description = "",
returns = "()",
type = "function"
}
},
inherits = "b2.Shape",
type = "class"
},
CircleShape = {
childs = {
new = {
args = "(centerx, centery, radius)",
description = "",
returns = "()",
type = "function"
},
set = {
args = "(centerx, centery, radius)",
description = "Sets the center point and radius",
returns = "()",
type = "method"
}
},
inherits = "b2.Shape",
type = "class"
},
Contact = {
childs = {
getChildIndexA = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getChildIndexB = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getFixtureA = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getFixtureB = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getFriction = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getManifold = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getRestitution = {
args = "()",
description = "",
returns = "()",
type = "method"
},
getWorldManifold = {
args = "()",
description = "",
returns = "()",
type = "method"
},
isTouching = {
args = "()",
description = "",
returns = "()",
type = "method"
},
resetFriction = {
args = "()",
description = "",
returns = "()",
type = "method"
},
resetRestitution = {
args = "()",
description = "",
returns = "()",
type = "method"
},
setEnabled = {
args = "(flag)",
description = "",
returns = "()",
type = "method"
},
setFriction = {
args = "(friction)",
description = "",
returns = "()",
type = "method"
},
setRestitution = {
args = "(restitution)",
description = "",
returns = "()",
type = "method"
}
},
type = "class"
},
DISTANCE_JOINT = {
description = "value \"3\"",
type = "value"
},
DYNAMIC_BODY = {
description = "value \"2\"",
type = "value"
},
DebugDraw = {
childs = {
AABB_BIT = {
description = "value \"4\"",
type = "value"
},
CENTER_OF_MASS_BIT = {
description = "value \"16\"",
type = "value"
},
JOINT_BIT = {
description = "value \"2\"",
type = "value"
},
PAIR_BIT = {
description = "value \"8\"",
type = "value"
},
SHAPE_BIT = {
description = "value \"1\"",
type = "value"
},
appendFlags = {
args = "(flags)",
description = "Append flags to the current flags",
returns = "()",
type = "method"
},
clearFlags = {
args = "(flags)",
description = "Clear flags from the current flags",
returns = "()",
type = "method"
},
getFlags = {
args = "()",
description = "Returns the debug drawing flags",
returns = "()",
type = "method"
},
new = {
args = "()",
description = "",
returns = "()",
type = "function"
},
setFlags = {
args = "(flags)",
description = "Sets the debug drawing flags",
returns = "()",
type = "method"
}
},
inherits = "Sprite",
type = "class"
},
DistanceJoint = {
childs = {
getDampingRatio = {
args = "()",
description = "Returns the damping ratio",
returns = "()",
type = "method"
},
getFrequency = {
args = "()",
description = "Returns the mass-spring-damper frequency in Hertz",
returns = "()",
type = "method"
},
getLength = {
args = "()",
description = "Returns the length of this distance joint in meters",
returns = "()",
type = "method"
},
setDampingRatio = {
args = "(ratio)",
description = "Sets the damping ratio (0 = no damping, 1 = critical damping)",
returns = "()",
type = "method"
},
setFrequency = {
args = "(frequency)",
description = "Sets the mass-spring-damper frequency in Hertz",
returns = "()",
type = "method"
},
setLength = {
args = "(length)",
description = "Sets the natural joint length in meters",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
EdgeShape = {
childs = {
new = {
args = "(v1x, v1y, v2x, v2y)",
description = "",
returns = "()",
type = "function"
},
set = {
args = "(v1x, v1y, v2x, v2y)",
description = "Sets the two vertices",
returns = "()",
type = "method"
}
},
inherits = "b2.Shape",
type = "class"
},
FRICTION_JOINT = {
description = "value \"9\"",
type = "value"
},
Fixture = {
childs = {
getBody = {
args = "()",
description = "Returns the parent body of this fixture",
returns = "()",
type = "method"
},
getFilterData = {
args = "()",
description = "Returns the contact filtering data",
returns = "()",
type = "method"
},
isSensor = {
args = "()",
description = "Is this fixture a sensor (non-solid)?",
returns = "()",
type = "method"
},
setFilterData = {
args = "(filterData)",
description = "Sets the contact filtering data",
returns = "()",
type = "method"
},
setSensor = {
args = "(sensor)",
description = "Sets if this fixture is a sensor",
returns = "()",
type = "method"
}
},
type = "class"
},
FrictionJoint = {
childs = {
getMaxForce = {
args = "()",
description = "Returns the maximum friction force in N",
returns = "()",
type = "method"
},
getMaxTorque = {
args = "()",
description = "Returns the maximum friction torque in N*m",
returns = "()",
type = "method"
},
setMaxForce = {
args = "(force)",
description = "Sets the maximum friction force in N",
returns = "()",
type = "method"
},
setMaxTorque = {
args = "(torque)",
description = "Sets the maximum friction torque in N*m",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
GEAR_JOINT = {
description = "value \"6\"",
type = "value"
},
GearJoint = {
childs = {
getRatio = {
args = "()",
description = "Returns the gear ratio",
returns = "()",
type = "method"
},
setRatio = {
args = "(ratio)",
description = "Sets the gear ratio",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
Joint = {
childs = {
getAnchorA = {
args = "()",
description = "Returns the anchor point on bodyA in world coordinates",
returns = "()",
type = "method"
},
getAnchorB = {
args = "()",
description = "Returns the anchor point on bodyB in world coordinates",
returns = "()",
type = "method"
},
getBodyA = {
args = "()",
description = "Returns the first body attached to this joint",
returns = "()",
type = "method"
},
getBodyB = {
args = "()",
description = "Returns the second body attached to this joint",
returns = "()",
type = "method"
},
getReactionForce = {
args = "(inv_dt)",
description = "Returns the reaction force on bodyB at the joint anchor",
returns = "()",
type = "method"
},
getReactionTorque = {
args = "(inv_dt)",
description = "Returns the reaction torque on bodyB",
returns = "()",
type = "method"
},
getType = {
args = "()",
description = "Returns a value that represents the type",
returns = "()",
type = "method"
},
isActive = {
args = "()",
description = "Is active?",
returns = "()",
type = "method"
}
},
type = "class"
},
KINEMATIC_BODY = {
description = "value \"1\"",
type = "value"
},
MOUSE_JOINT = {
description = "value \"5\"",
type = "value"
},
MouseJoint = {
childs = {
getDampingRatio = {
args = "()",
description = "Returns the damping ratio",
returns = "()",
type = "method"
},
getFrequency = {
args = "()",
description = "Returns the response frequency in Hertz",
returns = "()",
type = "method"
},
getMaxForce = {
args = "()",
description = "Returns the maximum force in N",
returns = "()",
type = "method"
},
getTarget = {
args = "()",
description = "Returns the x and y coordinates of the target point",
returns = "()",
type = "method"
},
setDampingRatio = {
args = "(ratio)",
description = "Sets the damping ratio (0 = no damping, 1 = critical damping)",
returns = "()",
type = "method"
},
setFrequency = {
args = "(frequency)",
description = "Sets the response frequency in Hertz",
returns = "()",
type = "method"
},
setMaxForce = {
args = "(force)",
description = "Sets the maximum force in N",
returns = "()",
type = "method"
},
setTarget = {
args = "(x, y)",
description = "Updates the target point",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
PRISMATIC_JOINT = {
description = "value \"2\"",
type = "value"
},
PULLEY_JOINT = {
description = "value \"4\"",
type = "value"
},
PolygonShape = {
childs = {
new = {
args = "()",
description = "",
returns = "()",
type = "function"
},
set = {
args = "(vertices)",
description = "Sets vertices",
returns = "()",
type = "method"
},
setAsBox = {
args = "(hx, hy, centerx, centery, angle)",
description = "Set vertices to represent an oriented box",
returns = "()",
type = "method"
}
},
inherits = "b2.Shape",
type = "class"
},
PrismaticJoint = {
childs = {
enableLimit = {
args = "(flag)",
description = "Enables or disables the joint limit",
returns = "()",
type = "method"
},
enableMotor = {
args = "(flag)",
description = "Enables or disables the joint motor",
returns = "()",
type = "method"
},
getJointSpeed = {
args = "()",
description = "Returns the current joint translation speed in meters per second",
returns = "()",
type = "method"
},
getJointTranslation = {
args = "()",
description = "Returns the current joint translation in meters",
returns = "()",
type = "method"
},
getLimits = {
args = "()",
description = "Returns the lower and upper joint limits in meters",
returns = "()",
type = "method"
},
getMotorForce = {
args = "(inv_dt)",
description = "Returns the current motor force given the inverse time step",
returns = "()",
type = "method"
},
getMotorSpeed = {
args = "()",
description = "Returns the motor speed in meters per second",
returns = "()",
type = "method"
},
isLimitEnabled = {
args = "()",
description = "Is the joint limit enabled?",
returns = "()",
type = "method"
},
isMotorEnabled = {
args = "()",
description = "Is the joint motor enabled?",
returns = "()",
type = "method"
},
setLimits = {
args = "(lower, upper)",
description = "Sets the joint limits in meters",
returns = "()",
type = "method"
},
setMaxMotorForce = {
args = "(force)",
description = "Sets the maximum motor force in N",
returns = "()",
type = "method"
},
setMotorSpeed = {
args = "(speed)",
description = "Sets the motor speed in meters per second",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
PulleyJoint = {
childs = {
getGroundAnchorA = {
args = "()",
description = "Returns the x and y coordinates of the first ground anchor",
returns = "()",
type = "method"
},
getGroundAnchorB = {
args = "()",
description = "Returns the x and y coordinates of the second ground anchor",
returns = "()",
type = "method"
},
getLengthA = {
args = "()",
description = "Returns the current length of the segment attached to bodyA",
returns = "()",
type = "method"
},
getLengthB = {
args = "()",
description = "Returns the current length of the segment attached to bodyB",
returns = "()",
type = "method"
},
getRatio = {
args = "()",
description = "Returns the joint ratio",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
REVOLUTE_JOINT = {
description = "value \"1\"",
type = "value"
},
ROPE_JOINT = {
description = "value \"10\"",
type = "value"
},
RevoluteJoint = {
childs = {
enableLimit = {
args = "(flag)",
description = "Enables or disables the joint limit",
returns = "()",
type = "method"
},
enableMotor = {
args = "(flag)",
description = "Enables or disables the joint motor",
returns = "()",
type = "method"
},
getJointAngle = {
args = "()",
description = "Returns the current joint angle in radians",
returns = "()",
type = "method"
},
getJointSpeed = {
args = "()",
description = "Returns the current joint angle speed in radians per second",
returns = "()",
type = "method"
},
getLimits = {
args = "()",
description = "Returns the lower and upper joint limit in radians",
returns = "()",
type = "method"
},
getMotorSpeed = {
args = "()",
description = "Returns the motor speed in radians per second",
returns = "()",
type = "method"
},
getMotorTorque = {
args = "(inv_dt)",
description = "Returns the current motor torque given the inverse time step",
returns = "()",
type = "method"
},
isLimitEnabled = {
args = "()",
description = "Is the joint limit enabled?",
returns = "()",
type = "method"
},
isMotorEnabled = {
args = "()",
description = "Is the joint motor enabled?",
returns = "()",
type = "method"
},
setLimits = {
args = "(lower, upper)",
description = "Sets the joint limits in radians",
returns = "()",
type = "method"
},
setMaxMotorTorque = {
args = "(torque)",
description = "Sets the maximum motor torque in N*m",
returns = "()",
type = "method"
},
setMotorSpeed = {
args = "(speed)",
description = "Sets the motor speed in radians per second",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
RopeJoint = {
childs = {
getMaxLength = {
args = "()",
description = "",
returns = "()",
type = "method"
},
setMaxLength = {
args = "(maxLength)",
description = "",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
STATIC_BODY = {
description = "value \"0\"",
type = "value"
},
WELD_JOINT = {
description = "value \"8\"",
type = "value"
},
WHEEL_JOINT = {
description = "value \"7\"",
type = "value"
},
WeldJoint = {
childs = {
getDampingRatio = {
args = "()",
description = "Returns damping ratio",
returns = "()",
type = "method"
},
getFrequency = {
args = "()",
description = "Returns frequency in Hz",
returns = "()",
type = "method"
},
setDampingRatio = {
args = "(damping)",
description = "Sets damping ratio",
returns = "()",
type = "method"
},
setFrequency = {
args = "(frequency)",
description = "Sets frequency in Hz",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
WheelJoint = {
childs = {
enableMotor = {
args = "(flag)",
description = "Enables or disables the joint motor",
returns = "()",
type = "method"
},
getJointSpeed = {
args = "()",
description = "Returns the current joint translation speed in meters per second.",
returns = "()",
type = "method"
},
getJointTranslation = {
args = "()",
description = "Returns the current joint translation in meters.",
returns = "()",
type = "method"
},
getMaxMotorTorque = {
args = "()",
description = "Returns the maximum motor torque in N*m",
returns = "()",
type = "method"
},
getMotorSpeed = {
args = "()",
description = "Returns the motor speed in radians per second",
returns = "()",
type = "method"
},
getSpringDampingRatio = {
args = "()",
description = "Returns the spring damping ratio",
returns = "()",
type = "method"
},
getSpringFrequencyHz = {
args = "()",
description = "Returns the spring frequency in Hertz",
returns = "()",
type = "method"
},
isMotorEnabled = {
args = "()",
description = "Is the joint motor enabled?",
returns = "()",
type = "method"
},
setMaxMotorTorque = {
args = "(torque)",
description = "Sets the maximum motor torque in N*m",
returns = "()",
type = "method"
},
setMotorSpeed = {
args = "(speed)",
description = "Sets the motor speed in radians per second",
returns = "()",
type = "method"
},
setSpringDampingRatio = {
args = "(damping)",
description = "Sets the spring damping ratio",
returns = "()",
type = "method"
},
setSpringFrequencyHz = {
args = "(frequency)",
description = "Sets the spring frequency in Hertz (0 = disable the spring)",
returns = "()",
type = "method"
}
},
inherits = "b2.Joint",
type = "class"
},
World = {
childs = {
clearForces = {
args = "()",
description = "Call this after you are done with time steps to clear the forces",
returns = "()",
type = "method"
},
createBody = {
args = "(bodyDef)",
description = "Creates a rigid body given a definition",
returns = "()",
type = "method"
},
createJoint = {
args = "(jointDef)",
description = "Creates a joint given a definition",
returns = "()",
type = "method"
},
destroyBody = {
args = "(body)",
description = "Destroys a rigid body",
returns = "()",
type = "method"
},
destroyJoint = {
args = "(joint)",
description = "Destroys a joint",
returns = "()",
type = "method"
},
getGravity = {
args = "()",
description = "Returns the gravity vector",
returns = "()",
type = "method"
},
new = {
args = "(gravityx, gravityy, doSleep)",
description = "",
returns = "()",
type = "function"
},
queryAABB = {
args = "(lowerx, lowery, upperx, uppery)",
description = "Query the world for all fixtures that potentially overlap the provided AABB",
returns = "()",
type = "method"
},
rayCast = {
args = "(x1, y1, x2, y2, listener [, data])",
description = "Raycast the world for all fixtures in the path of the ray",
returns = "()",
type = "method"
},
setDebugDraw = {
args = "()",
description = "Registers a b2.DebugDraw instance for debug drawing",
returns = "()",
type = "method"
},
setGravity = {
args = "(gravityx, gravityy)",
description = "Sets the gravity vector",
returns = "()",
type = "method"
},
step = {
args = "(timeStep, velocityIterations, positionIterations)",
description = "Takes a time step",
returns = "()",
type = "method"
}
},
inherits = "EventDispatcher",
type = "class"
},
createDistanceJointDef = {
args = "(bodyA, bodyB, anchorAx, anchorAy, anchorBx, anchorBy)",
description = "Creates and returns a distance joint definition table",
returns = "()",
type = "function"
},
createFrictionJointDef = {
args = "(bodyA, bodyB, anchorx, anchory)",
description = "Creates and returns a friction joint definition table",
returns = "()",
type = "function"
},
createGearJointDef = {
args = "(bodyA, bodyB, joint1, joint2, ratio)",
description = "Creates and returns a gear joint definition table",
returns = "()",
type = "function"
},
createMouseJointDef = {
args = "(bodyA, bodyB, targetx, targety, maxForce, frequencyHz, dampingRatio)",
description = "Creates and returns a mouse joint definition table",
returns = "()",
type = "function"
},
createPrismaticJointDef = {
args = "(bodyA, bodyB, anchorx, anchory, axisx, axisy)",
description = "Creates and returns a prismatic joint definition table",
returns = "()",
type = "function"
},
createPulleyJointDef = {
args = "(bodyA, bodyB, groundAnchorAx, groundAnchorAy, groundAnchorBx, groundAnchorBy, anchorAx, anchorAy, anchorBx, anchorBy, ratio)",
description = "Creates and returns a pulley joint definition table",
returns = "()",
type = "function"
},
createRevoluteJointDef = {
args = "(bodyA, bodyB, anchorx, anchory)",
description = "Creates and returns a revolute joint definition table",
returns = "()",
type = "function"
},
createRopeJointDef = {
args = "(bodyA, bodyB, anchorAx, anchorAy, anchorBx, anchorBy, maxLength)",
description = "",
returns = "()",
type = "function"
},
createWeldJointDef = {
args = "(bodyA, bodyB, anchorAx, anchorAy, anchorBx, anchorBy)",
description = "Creates and returns a weld joint definition table",
returns = "()",
type = "function"
},
createWheelJointDef = {
args = "(bodyA, bodyB, anchorx, anchory, axisx, axisy)",
description = "Creates and returns a wheel joint definition table",
returns = "()",
type = "function"
},
getScale = {
args = "()",
description = "Returns the global pixels to meters scale",
returns = "()",
type = "function"
},
setScale = {
args = "(scale)",
description = "Sets the global pixels to meters scale",
returns = "()",
type = "function"
}
},
type = "class"
},
flurry = {
childs = {
endTimedEvent = {
args = "(eventName, parameters)",
description = "Ends Flurry timed event",
returns = "()",
type = "function"
},
isAvailable = {
args = "()",
description = "Returns true if Flurry is available",
returns = "()",
type = "function"
},
logEvent = {
args = "(eventName, parameters, timed)",
description = "Logs Flurry event",
returns = "()",
type = "function"
},
startSession = {
args = "(apiKey)",
description = "Starts the Flurry session with your API key",
returns = "()",
type = "function"
}
},
type = "class"
},
iad = {
childs = {
Banner = {
childs = {
BOTTOM = {
description = "value \"bottom\"",
type = "value"
},
LANDSCAPE = {
description = "value \"landscape\"",
type = "value"
},
PORTRAIT = {
description = "value \"portrait\"",
type = "value"
},
TOP = {
description = "value \"top\"",
type = "value"
},
hide = {
args = "()",
description = "",
returns = "()",
type = "method"
},
isBannerLoaded = {
args = "()",
description = "",
returns = "()",
type = "method"
},
new = {
args = "(alignment, orientation)",
description = "",
returns = "()",
type = "function"
},
setAlignment = {
args = "(alignment)",
description = "",
returns = "()",
type = "method"
},
show = {
args = "()",
description = "",
returns = "()",
type = "method"
}
},
inherits = "EventDispatcher",
type = "class"
},
isAvailable = {
args = "()",
description = "",
returns = "()",
type = "function"
}
},
type = "class"
},
stage = {
childs = {},
inherits = "Sprite",
type = "class"
}
}
--[[
Conversion script for Gideros API (http://docs.giderosmobile.com/reference/autocomplete.php)
Run the script as: lua gideros-conv.lua <gideros_annot.api >gideros.lua
Event
Event.new(type) creates a new Event object
Event.ENTER_FRAME
getType() Event - returns the type of Event
getTarget() Event - returns the element on which the event listener was registered
Limitations
- only handles two levels of class hierarchy (as in b2.Body.*)
Notes
+ replace &quot; with "
+ remove standard Lua functions and classes
+ b2.* and flurry.* don't have any headers (assume those)
+ there some duplicates, like Stage and stage (ignore lowecase ones)
+ remove "CLASS - " from the description
+ b2.World and many others have several levels
+ create different methods for Application and application
+ missing new() methods for some classes (+geolocation, +gyroscope, +accelerometer, +storekit)
+ application, stage, world are global variables
------------------------>> cut here <<-----------------------------
local class = ""
local t = {}
local inherits = {}
while true do
local s = io.read()
if not s then break end
local newclass, base = s:match('^([%w%.]+)%s+>%s+([%w%.]+)%s*$')
if base then
inherits[newclass] = base
else
newclass = s:match('^([A-Z]%w+)$') or s:match('^(%w+%.%w+)$')
or s:match('^([%.%w]+)%.')
end
if newclass and class:lower() ~= newclass:lower() then
class = newclass
if not class:match('%.') then
t[class] = t[class] or {childs = {}, type = "class", inherits = inherits[class]} end
end
s = s:gsub('^'..class..'%.', ""):gsub('^'..class:lower()..'%:', "")
local const, value = s:match('^([A-Z_0-9]+)[ -]+(.+)$')
local fun, args, desc = s:match('(%w+)(%b())%s*(.*)%s*$')
if #class == 0 then
-- do nothing; haven't found a single class yet; skipping Lua methods
elseif _G[class] then
-- do nothing; skipping Lua tables (io, table, math, etc.)
elseif s:lower() == class:lower() or base then
-- do nothing; it's either class or its duplicate
elseif const or fun then
local t, class = t, class
local c1, c2 = class:match('^(%w+)%.(%w+)$')
if c1 and c2 then
t[c1] = t[c1] or {childs = {}, type = "class"}
t = t[c1].childs
local base = inherits[class]
class = c2
t[class] = t[class] or {childs = {}, type = "class", inherits = base}
end
if fun then
local removeclass = "^"..(c2 and c1..'.'..c2 or class)..'[- ]*'
desc = (desc or "")
:gsub("&quot;?", '"')
:gsub(removeclass, "") -- remove class
:gsub(removeclass, "") -- some descriptions have it twice
:gsub("^(%w)", string.upper) -- convert first letter to uppercase
-- function have "Class.function" format and
-- methods have "function() Class"; "newclass" means it a function
t[class].childs[fun] = {
type = (newclass and "function" or "method"),
args = args or "()",
description = desc,
returns = "()",
}
elseif const then
t[class].childs[const] = {type = "value", description = value}
end
else
io.stderr:write("Unrecognized string: "..s, "\n")
class = ""
end
end
-- several manual tweaks --
-- move functions/methods to "application" (and to "stage")
-- as there are global variables with these name.
-- "world" is also a global variable, but what are its methods?
for _, class in ipairs({"Application", "Stage"}) do
local global = class:lower()
t[global] = t[global] or {childs = {}, type = t[class].type, inherits = t[class].inherits}
for key, value in pairs(t[class].childs) do
if value.type == "function" or value.type == "method" then
t[global].childs[key] = value
t[class].childs[key] = nil
end
end
end
-- add missing new() methods
for _, class in ipairs{'StoreKit'} do
if t[class] and t[class].childs then
t[class].childs.new = {
type = "function",
args = "()",
description = "Creates a new " .. class .." object",
returns = "()",
}
else
print("Can't find class object for class " .. class)
end
end
print('return ' .. (require 'mobdebug').line(t, {indent = ' ', comment = false}))
------------------------>> cut here <<-----------------------------]]
Reference in New Issue View Git Blame Copy Permalink