Interface
BoomOpt
:group Game Obj
subgroup Types
speed
?: numberAnimation speed.
scale
?: numberScale.
comps
?: CompList<any>Additional components.
since v3000.0
4000.0.0-alpha.23
Guides 
API Reference 
Blog Start
Assets
- loadRoot
- loadSprite
- loadSpriteAtlas
- loadAseprite
- loadBean
- loadHappy
- loadJSON
- loadSound
- loadMusic
- loadFont
- loadBitmapFont
- loadBitmapFontFromSprite
- loadShader
- loadShaderURL
- load
- loadPrefab
- loadProgress
- getSprite
- getSound
- getFont
- getBitmapFont
- getShader
- getAsset
- Asset
- SpriteData
- SoundData
- ShaderData
- GfxFont
- BitmapFontData
- LoadBitmapFontOpt
- FontData
- SpriteAnim
- SpriteAnims
- LoadSpriteOpt
- NineSlice
- LoadSpriteSrc
- AssetBucket
- AsepriteData
- SpriteAtlasData
- SpriteAtlasEntry
- MusicData
- LoadFontOpt
- TextureOpt
- ImageSource
Game Obj
Components
- pos
- scale
- rotate
- skew
- color
- blend
- opacity
- sprite
- text
- polygon
- rect
- circle
- ellipse
- uvquad
- video
- picture
- area
- anchor
- z
- layer
- outline
- particles
- body
- surfaceEffector
- areaEffector
- pointEffector
- platformEffector
- buoyancyEffector
- constantForce
- doubleJump
- move
- offscreen
- follow
- shader
- textInput
- timer
- fixed
- stay
- health
- lifespan
- named
- state
- fadeIn
- mask
- drawon
- tile
- agent
- animate
- fakeMouse
- serializeAnimation
- sentry
- patrol
- pathfinder
- level
- SerializedColor
- SerializedVec2
- FakeMouseComp
- FakeMouseOpt
- TimerComp
- SerializedFixedComp
- FixedComp
- SerializedPosComp
- PosComp
- SerializedBlendComp
- BlendComp
- SerializedCircleComp
- CircleComp
- CircleCompOpt
- SerializedColorComp
- ColorComp
- DrawonCompOpt
- DrawonComp
- SerializedEllipseComp
- EllipseComp
- EllipseCompOpt
- SerializedMaskComp
- MaskComp
- SerializedOpacityComp
- OpacityComp
- SerializedOutlineComp
- OutlineComp
- EmitterOpt
- ParticlesOpt
- ParticlesComp
- PictureComp
- PictureCompOpt
- PolygonComp
- PolygonCompOpt
- SerializedRectComp
- RectComp
- RectCompOpt
- SerializeShaderComp
- ShaderComp
- SerializedSpriteComp
- SpriteComp
- SpriteCompOpt
- SerializedTextComp
- TextComp
- TextCompOpt
- UVQuadComp
- AgentComp
- AgentCompOpt
- LevelComp
- LevelCompOpt
- PathFindOpt
- SentryComp
- SentryCompOpt
- TileComp
- TileCompOpt
- SerializeHealthComp
- HealthComp
- LifespanCompOpt
- SerializeNameComp
- NamedComp
- SerializeStateComp
- StateComp
- SerializeStayComp
- StayComp
- TextInputComp
- AreaComp
- AreaCompOpt
- BodyComp
- BodyCompOpt
- DoubleJumpComp
- SerializedAnchorComp
- AnchorComp
- FollowComp
- LayerComp
- SerializedMoveComp
- MoveComp
- OffScreenComp
- OffScreenCompOpt
- SerializedRotateComp
- RotateComp
- SerializedScaleComp
- ScaleComp
- SerializedSkewComp
- SkewComp
- SerializedZComp
- ZComp
- MergeComps
- CompList
- SpriteAnimPlayOpt
- Comp
- EmptyComp
Input
- onClick
- onKeyDown
- onKeyPress
- onKeyPressRepeat
- onKeyRelease
- onCharInput
- onMouseDown
- onMousePress
- onMouseRelease
- onMouseMove
- onTouchStart
- onTouchMove
- onTouchEnd
- onScroll
- onGamepadConnect
- onGamepadDisconnect
- 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
- getButtons
- setButton
- pressButton
- releaseButton
- getGamepadStick
- getGamepadAnalogButton
- getLastInputDeviceType
- charInputted
- ButtonBinding
- ButtonsDef
- ButtonBindingDevice
- Key
- MouseButton
- KGamepadButton
- KGamepadStick
- GamepadDef
- KGamepad
Events
- trigger
- on
- onFixedUpdate
- onUpdate
- onDraw
- onAdd
- onDestroy
- onUse
- onUnuse
- onTag
- onUntag
- onLoad
- onLoadError
- onLoading
- onError
- onResize
- onCleanup
- onCollide
- onCollideUpdate
- onCollideEnd
- onHover
- onHoverUpdate
- onHoverEnd
- onSceneLeave
- KEvent
- KEventHandler
- KEventController
- cancel
- Registry
- GameObjEventMap
- GameObjEvents
- GameObjEventNames
- AppEventMap
- GameEventMap
Info
Math
- 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
- hermite
- cardinal
- catmullRom
- bezier
- kochanekBartels
- testLinePoint
- testLineLine
- testLineCircle
- testRectRect
- testRectLine
- testRectPoint
- testCirclePolygon
- clipLineToRect
- clipLineToCircle
- anchorToVec2
- gjkShapeIntersects
- gjkShapeIntersection
- isConvex
- step
- smoothstep
- triangulate
- insertionSort
- NavMesh
- Point
- Line
- Rect
- Circle
- Ellipse
- Polygon
- Vec2
- Color
- Mat4
- Mat23
- Quad
- RNG
- Rule
- RuleSystem
- DecisionNode
- DecisionTree
- StateMachine
- RGBValue
- RGBAValue
- CSSColorKeywords
- ColorArgs
- LerpValue
- Vec2Args
- Mat2
- ShapeType
- RaycastHit
- RaycastResult
- StepPosition
- EaseFuncs
- EaseFunc
- RNGValue
- Edge
- Vec3
Rendering
- setCamPos
- getCamPos
- setCamScale
- getCamScale
- setCamRot
- getCamRot
- getCamTransform
- shake
- flash
- camPos
- camScale
- camRot
- camFlash
- camTransform
- toScreen
- toWorld
- setLayers
- getLayers
- getDefaultLayer
- layers
- pushTransform
- popTransform
- pushTranslate
- pushScale
- pushRotate
- pushMatrix
- usePostEffect
- formatText
- compileStyledText
- makeCanvas
- UniformValue
- UniformKey
- Uniform
- Shader
- Texture
- VertexFormat
- BatchRenderer
- Mesh
- CharTransformFunc
- CharTransform
- TextAlign
- CamData
- FormattedText
- FormattedChar
- FontAtlas
- StyledTextInfo
- FrameBuffer
- Viewport
- RenderTarget
- Canvas
- Vertex
- Attributes
- Cursor
Draw
- drawSprite
- drawText
- drawRect
- drawLine
- drawLines
- drawCurve
- drawBezier
- drawTriangle
- drawCircle
- drawEllipse
- drawPolygon
- drawUVQuad
- drawFormattedText
- drawMasked
- drawSubtracted
- Picture
- beginPicture
- appendToPicture
- endPicture
- drawPicture
- drawCanvas
- Material
- PictureCommand
- DrawPictureOpt
- DrawTextOpt
- DrawSpriteOpt
- DrawLineOpt
- DrawPolygonOpt
- DrawCurveOpt
- DrawBezierOpt
- DrawUVQuadOpt
- DrawCanvasOpt
- DrawCircleOpt
- DrawEllipseOpt
- DrawRectOpt
- DrawTriangleOpt
- Anchor
- Shape
- DrawTextureOpt
Plugins
Miscalenous
- _k
- constraint
- onHide
- onShow
- onTabShow
- onTabHide
- app
- ChordedButtonDetector
- ButtonProcessor
- GfxCtx
- initGfx
- TexPacker
- InternalAssetsCtx
- InternalAudioCtx
- Game
- AppGfxCtx
- FrameRenderer
- LineJoin
- LineCap
- DrawLinesOpt
- SpriteCurAnim
- VideoComp
- VideoCompOpt
- Graph
- PathfinderMapComp
- PathfinderMapCompOpt
- PathfinderComp
- PathfinderCompOpt
- PatrolComp
- PatrolEndBehavior
- PatrolCompOpt
- SentryCandidatesCb
- SentryCandidates
- TimeDirection
- Interpolation
- AnimateOpt
- AnimateCompOpt
- BaseValues
- AnimateComp
- AnimateChannel
- AnimationChannelKeys
- AnimationOptions
- AnimationChannel
- AnimationChannels
- Anim
- SurfaceEffectorCompOpt
- SurfaceEffectorComp
- AreaEffectorCompOpt
- AreaEffectorComp
- ForceMode
- PointEffectorCompOpt
- PointEffectorComp
- ConstantForceCompOpt
- ConstantForceComp
- PlatformEffectorCompOpt
- PlatformEffectorComp
- BuoyancyEffectorCompOpt
- BuoyancyEffectorComp
- BoneOpt
- BoneComp
- Constraint
- DistanceMode
- DistanceConstraintOpt
- DistanceConstraintComp
- TranslationConstraintOpt
- TranslationConstraintComp
- RotationConstraintOpt
- RotationConstraintComp
- ScaleConstraintOpt
- ScaleConstraintComp
- TransformConstraintOpt
- TransformConstraintComp
- InverseKinematicsAlgorithm
- IKConstraintOpt
- IKConstraintComp
- GameEventHandlers
- SetParentOpt
- InternalGameObjRaw
- SceneScope
- AppScope
- anchorPt
- Predicate
- Predicate$1
- Action
- EnterCallback
- UpdateCallback$1
- DrawCallback
- ExitCallback
- TransitionCallback
- StateCallbacks
- State
- GjkCollisionResult
- NavEdge
- NavPolygon
- UnionToIntersection
- Defined
- Expand
- MergeObj
- TupleWithoutFirst
- Engine
- InfKAPLAYOpt
- OptionalString
- TypesOpt
- Opt
- KAPLAYOptTypeOptions
- KAPLAYTypeOptWithoutPlugins
- SceneName
- SceneArgs
- ButtonName
- SceneScopeT
- KAPLAYCtxTMethods
- KAPLAYCtxT
- Tag
- RemoveCompProps
- MergePlugins
- PluginList
- ChordedKey
- ChordedMouseButton
- ChordedKGamepadButton
- GameObjInspect
- MustKAPLAYOpt
- TexFilter
- TexWrap
- RenderProps
- Outline
- Mask
- EdgeMask
- ButtonState
- GamepadState
- FPSCounter
- App
- AppState
- AppEvents
- Grid
- SatResult
- SapEdge
- SweepAndPrune
- BinaryHeap
- HasDefinedKeys
- ChooseKAPLAYCtx
- KAPLAYGame
- CSS_COLOR_MAP
- initAssets
- createEngine
- initAppState
- initApp
- kaplayTypes