Function
mask
(maskType?: Mask): MaskCompMask all children object render.
param maskType- The type of mask to use.
returns The mask comp.
since v3001.0
group Components
Guides 
API Reference 
Blog Assets
Game Obj
Components
- pos
- scale
- rotate
- color
- opacity
- sprite
- text
- polygon
- rect
- circle
- uvquad
- area
- anchor
- z
- 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
- serializeAnimation
- 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
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
- pressButton
- releaseButton
- getGamepadStick
- getLastInputDeviceType
- charInputted
- Key
- MouseButton
- KGamepadButton
- GamepadStick
Events
Info
Math
- raycast
- vec2
- rgb
- hsl2rgb
- quad
- 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
- Vec2Args
- ShapeType
- RaycastHit
- RaycastResult
- UniformValue
- UniformKey
- Uniform
- LerpValue
- RNGValue
- Collision
- Edge
- EaseFuncs
- EaseFunc
Layer
Camera
Layers
Level
Draw
- drawSprite
- drawText
- drawRect
- drawLine
- drawLines
- drawCurve
- drawBezier
- drawTriangle
- drawCircle
- drawEllipse
- drawPolygon
- drawUVQuad
- drawFormattedText
- drawMasked
- drawSubtracted
- pushTransform
- popTransform
- pushTranslate
- pushScale
- pushRotate
- pushMatrix
- usePostEffect
- formatText
- makeCanvas
- DrawTextOpt
- TextAlign
- Cursor
- Anchor
- Shape
Plugins
Button Bindings
GFX
Miscalenous
- _k
- hermite
- cardinal
- catmullRom
- bezier
- kochanekBartels
- addKaboom
- GfxCtx
- Texture
- VertexFormat
- BatchRenderer
- Mesh
- initGfx
- RGBValue
- RGBAValue
- ColorArgs
- Mat2
- StepPosition
- SatResult
- DrawCurveOpt
- DrawBezierOpt
- DrawCircleOpt
- GfxFont
- BitmapFontData
- LoadBitmapFontOpt
- FontData
- CharTransformFunc
- FormattedText
- FormattedChar
- DrawLineOpt
- LineJoin
- LineCap
- DrawLinesOpt
- DrawRectOpt
- Graph
- Grid
- NavEdge
- NavPolygon
- DrawSpriteOpt
- DrawTriangleOpt
- ShaderData
- AppGfxCtx
- TexPacker
- SpriteAnim
- SpriteAnims
- LoadSpriteOpt
- NineSlice
- LoadSpriteSrc
- AssetBucket
- AssetsCtx
- AsepriteData
- PeditFile
- SpriteAtlasData
- SpriteAtlasEntry
- AudioCtx
- Registry
- BinaryHeap
- 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
- GameObjEvents
- GameObjEventNames
- AppEventMap
- TupleWithoutFirst
- SceneName
- SceneDef
- Game
- KAPLAYInternal
- 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
- EdgeMask
- SpriteCurAnim
- ButtonState
- GamepadState
- FPSCounter
- App
- AppState
- initAppGfx
- initAssets
- initAudio
- initGame
- initAppState
- initApp