getSound(name: string): Asset | null

Start

• kaplay
• quit
• KAPLAYOpt

Assets

• loadRoot
• loadSprite
• loadSpriteAtlas
• loadAseprite
• loadPedit
• loadBean
• loadJSON
• loadSound
• loadMusic
• loadFont
• loadBitmapFont
• loadShader
• loadShaderURL
• load
• loadProgress
• getSprite
• getSound
• getFont
• getBitmapFont
• getShader
• getAsset
• Asset
• SpriteData
• SoundData

Game Obj

• add
• make
• readd
• get
• query
• destroy
• destroyAll
• GameObjRaw
• GameObj
• GameObjID

Components

• pos
• scale
• rotate
• color
• opacity
• sprite
• text
• polygon
• rect
• circle
• uvquad
• area
• anchor
• z
• layer
• outline
• particles
• body
• surfaceEffector
• areaEffector
• pointEffector
• buoyancyEffector
• constantForce
• doubleJump
• move
• offscreen
• follow
• shader
• textInput
• timer
• fixed
• stay
• health
• lifespan
• named
• state
• fadeIn
• mask
• tile
• agent
• animate
• sentry
• patrol
• pathfinder
• Comp

Component Types

• CircleComp
• CircleCompOpt
• ColorComp
• MaskComp
• OpacityComp
• OutlineComp
• ParticlesOpt
• ParticlesComp
• PolygonComp
• PolygonCompOpt
• RectComp
• RectCompOpt
• ShaderComp
• SpriteComp
• SpriteCompOpt
• TextComp
• TextCompOpt
• UVQuadComp
• AgentComp
• AgentCompOpt
• FixedComp
• PosComp
• SentryComp
• SentryCompOpt
• TileComp
• TileCompOpt
• HealthComp
• LifespanCompOpt
• NamedComp
• StateComp
• StayComp
• TextInputComp
• TimerComp
• AreaComp
• AreaCompOpt
• BodyComp
• BodyCompOpt
• DoubleJumpComp
• AnchorComp
• FollowComp
• LayerComp
• OffScreenComp
• OffScreenCompOpt
• RotateComp
• ScaleComp
• ZComp
• MergeComps
• CompList
• EmptyComp
• LevelComp

Scene

• getSceneName
• scene
• go
• layers

Input

• onGamepadConnect
• onGamepadDisconnect
• onClick
• onKeyDown
• onKeyPress
• onKeyPressRepeat
• onKeyRelease
• onCharInput
• onMouseDown
• onMousePress
• onMouseRelease
• onMouseMove
• onTouchStart
• onTouchMove
• onTouchEnd
• onScroll
• onGamepadButtonDown
• onGamepadButtonPress
• onGamepadButtonRelease
• onGamepadStick
• onButtonPress
• onButtonRelease
• onButtonDown
• isTouchscreen
• mousePos
• mouseDeltaPos
• isKeyDown
• isKeyPressed
• isKeyPressedRepeat
• isKeyReleased
• isMouseDown
• isMousePressed
• isMouseReleased
• isMouseMoved
• isGamepadButtonPressed
• isGamepadButtonDown
• isGamepadButtonReleased
• isButtonPressed
• isButtonDown
• isButtonReleased
• getButton
• setButton
• getGamepadStick
• charInputted
• Key
• MouseButton
• KGamepadButton
• GamepadStick

Events

• KEventController
• GameObjEventMap
• on
• onUpdate
• onDraw
• onAdd
• onDestroy
• onLoad
• onLoading
• onError
• onResize
• onCleanup
• onCollide
• onCollideUpdate
• onCollideEnd
• onHover
• onHoverUpdate
• onHoverEnd
• onHide
• onShow
• onSceneLeave
• KEvent
• KEventHandler
• KEventController

Info

• width
• getTreeRoot
• height
• center
• dt
• fixedDt
• restDt
• time
• isFocused
• shake
• camPos
• camScale
• camRot
• camFlash
• camTransform
• toScreen
• toWorld
• setGravity
• getGravity
• setBackground
• getBackground
• getGamepads
• setCursor
• getCursor
• setCursorLocked
• isCursorLocked
• setFullscreen
• isFullscreen
• canvas
• VERSION

Timer

• wait
• loop
• TimerController
• TweenController

Math

• Color
• Vec2Args
• Vec2
• Quad
• Mat4
• RNG
• ShapeType
• RaycastHit
• RaycastResult
• Line
• Rect
• Circle
• Ellipse
• Polygon
• UniformValue
• UniformKey
• Uniform
• raycast
• rand
• randi
• randSeed
• vec2
• rgb
• hsl2rgb
• quad
• choose
• chooseMultiple
• shuffle
• chance
• lerp
• tween
• easings
• easingSteps
• easingLinear
• easingCubicBezier
• map
• mapc
• wave
• deg2rad
• rad2deg
• clamp
• evaluateQuadratic
• evaluateQuadraticFirstDerivative
• evaluateQuadraticSecondDerivative
• evaluateBezier
• evaluateBezierFirstDerivative
• evaluateBezierSecondDerivative
• evaluateCatmullRom
• evaluateCatmullRomFirstDerivative
• curveLengthApproximation
• normalizedCurve
• testLinePoint
• testLineLine
• testLineCircle
• testRectRect
• testRectLine
• testRectPoint
• testCirclePolygon
• isConvex
• triangulate
• NavMesh
• Point
• Line
• Rect
• Circle
• Ellipse
• Polygon
• Vec2
• Color
• Mat4
• Quad
• RNG
• LerpValue
• RNGValue
• Collision
• Edge
• EdgeMask
• EaseFuncs
• EaseFunc

Misc

• GfxCtx
• Texture
• VertexFormat
• BatchRenderer
• Mesh
• initGfx
• RGBValue
• RGBAValue
• ColorArgs
• Mat2
• Point
• StepPosition
• SatResult
• DrawCurveOpt
• DrawBezierOpt
• DrawCircleOpt
• GfxFont
• BitmapFontData
• LoadBitmapFontOpt
• FontData
• CharTransformFunc
• FormattedText
• FormattedChar
• DrawLineOpt
• LineJoin
• LineCap
• DrawLinesOpt
• DrawRectOpt
• Graph
• Grid
• NavEdge
• NavPolygon
• NavMesh
• DrawSpriteOpt
• DrawTriangleOpt
• ShaderData
• AppGfxCtx
• TexPacker
• SoundData
• SpriteAnim
• SpriteAnims
• LoadSpriteOpt
• NineSlice
• LoadSpriteSrc
• SpriteData
• Asset
• AssetBucket
• AssetsCtx
• AsepriteData
• PeditFile
• SpriteAtlasData
• SpriteAtlasEntry
• AudioCtx
• BinaryHeap
• Registry
• KEvent
• KEventHandler
• AudioPlayOpt
• AudioPlay
• EmitterOpt
• PathfinderMapComp
• PathfinderMapCompOpt
• PathfinderComp
• PathfinderCompOpt
• PatrolComp
• PatrolEndBehavior
• PatrolCompOpt
• SentryCandidatesCb
• SentryCandidates
• TimeDirection
• Interpolation
• AnimateOpt
• AnimateCompOpt
• BaseValues
• AnimateComp
• AnimationChannelKeys
• AnimationOptions
• AnimationChannel
• SurfaceEffectorCompOpt
• SurfaceEffectorComp
• AreaEffectorCompOpt
• AreaEffectorComp
• ForceMode
• PointEffectorCompOpt
• PointEffectorComp
• ConstantForceCompOpt
• ConstantForceComp
• PlatformEffectorCompOpt
• PlatformEffectorComp
• BuoyancyEffectorCompOpt
• BuoyancyEffectorComp
• GameObjEventNames
• TupleWithoutFirst
• SceneName
• SceneDef
• Game
• addKaboom
• Tag
• UnionToIntersection
• Defined
• Expand
• MergeObj
• MergePlugins
• PluginList
• GamepadDef
• KGamepad
• GameObjInspect
• SpriteAnimPlayOpt
• MusicData
• LoadFontOpt
• TextureOpt
• ImageSource
• Canvas
• Vertex
• TexFilter
• TexWrap
• RenderProps
• DrawTextureOpt
• DrawUVQuadOpt
• DrawEllipseOpt
• DrawPolygonOpt
• Outline
• Mask
• SpriteCurAnim
• initAppGfx
• initAssets
• initAudio
• initGame

GFX

• FrameBuffer
• Shader

Draw

• DrawTextOpt
• TextAlign
• drawSprite
• drawText
• drawRect
• drawLine
• drawLines
• drawCurve
• drawBezier
• drawTriangle
• drawCircle
• drawEllipse
• drawPolygon
• drawUVQuad
• drawFormattedText
• drawMasked
• drawSubtracted
• pushTransform
• popTransform
• pushTranslate
• pushScale
• pushRotate
• pushMatrix
• usePostEffect
• formatText
• makeCanvas
• Cursor
• Anchor
• Shape

Options

• CharTransform
• BoomOpt
• LevelOpt
• GetOpt
• QueryOpt
• PathFindOpt

Audio

• play
• burp
• volume
• audioCtx

Level

• addLevel

Data

• getData
• setData
• screenshot
• download
• downloadText
• downloadJSON
• downloadBlob
• record
• Recording

Debug

• debug
• Debug

Plugins

• plug
• KAPLAYPlugin

Constants

• ASCII_CHARS
• LEFT
• RIGHT
• UP
• DOWN
• RED
• GREEN
• BLUE
• YELLOW
• MAGENTA
• CYAN
• WHITE
• BLACK

Button Bindings

• ButtonBinding
• ButtonsDef
• ButtonBindingDevice