Index

Cocos Creator v2.4

Welcome to Cocos Creator JavaScript engine API reference. You can search anything in top left search filed.

All enums and classes are under cc module if not specified otherwise.

Modules

• GLOBAL-MACROS
• _decorator
• cc
• cc.AssetManager
• cc.geomUtils
• cc.primitive
• dragonBones
• js
• sp
• sp.spine

Classes

• Action from cc
• ActionInstant from cc
• ActionInterval from cc
• ActionManager from cc
• AffineTransform from cc
• AlphaKey from cc
• Animation from cc
• Animation.EventType from cc
• AnimationClip from cc
• AnimationCurve from cc
• AnimationState from cc
• ArmatureDisplay from dragonBones
• array from js
• Asset from cc
• AssetManager from cc
• AudioClip from cc
• audioEngine from cc
• AudioSource from cc
• BitmapFont from cc
• BlendFunc from cc
• BlockInputEvents from cc
• BoxCollider from cc
• BoxCollider3D from cc
• BufferAsset from cc
• BufferRange from cc
• Builtins from cc.AssetManager
• Bundle from cc.AssetManager
• Burst from cc
• Button from cc
• Cache from cc.AssetManager
• CacheManager from cc.AssetManager
• CallbacksInvoker from cc
• Camera from cc
• Canvas from cc
• CCFactory from dragonBones
• CircleCollider from cc
• Collider from cc
• Collider.Box from cc
• Collider.Circle from cc
• Collider.Polygon from cc
• Collider3D from cc
• ColliderInfo from cc
• CollisionManager from cc
• Color from cc
• ColorKey from cc
• ColorOvertimeModule from cc
• Component from cc
• Component.EventHandler from cc
• ConstantForce from cc
• constructor from cc
• ContainerStrategy from cc
• ContentStrategy from cc
• CurveRange from cc
• debug from cc
• DependUtil from cc.AssetManager
• Details from cc
• Director from cc
• DistanceJoint from cc
• Downloader from cc.AssetManager
• dragonBones.AttachUtil from dragonBones
• DragonBonesAsset from dragonBones
• DragonBonesAtlasAsset from dragonBones
• DynamicAtlasManager from cc
• Easing from cc
• EditBox from cc
• EffectAsset from cc
• EqualToFrame from cc
• EqualToWindow from cc
• Event from cc
• Event.EventAcceleration from cc
• Event.EventCustom from cc
• Event.EventKeyboard from cc
• Event.EventMouse from cc
• Event.EventTouch from cc
• EventTarget from cc
• FiniteTimeAction from cc
• Font from cc
• ForceOvertimeModule from cc
• Game from cc
• geomUtils.Aabb from cc
• geomUtils.Frustum from cc
• geomUtils.intersect from cc
• geomUtils.Line from cc
• geomUtils.Obb from cc
• geomUtils.Plane from cc
• geomUtils.Ray from cc
• geomUtils.Sphere from cc
• geomUtils.Triangle from cc
• Gradient from cc
• GradientRange from cc
• Graphics from cc
• GraySpriteState from cc
• Helper from cc.AssetManager
• IBaseShape from cc
• IBoxShape from cc
• ICollisionDetect from cc
• ICollisionEvent from cc
• IContactEquation from cc
• Intersection from cc
• IPhysicsWorld from cc
• IQuatLike from cc
• IRaycastOptions from cc
• IRigidBody from cc
• ISphereShape from cc
• ITriggerEvent from cc
• IVec3Like from cc
• Joint from cc
• JsonAsset from cc
• Label from cc
• LabelAtlas from cc
• LabelOutline from cc
• LabelShadow from cc
• Layout from cc
• Light from cc
• LimitVelocityOvertimeModule from cc
• loader from cc
• LoadingItems from cc
• macro from cc
• Manifold from cc
• ManifoldPoint from cc
• MapUtils from cc
• Mask from cc
• Mat3 from cc
• Mat4 from cc
• Material from cc
• MaterialVariant from cc
• Mesh from cc
• MeshRenderer from cc
• misc from cc
• MotionStreak from cc
• MotorJoint from cc
• MouseJoint from cc
• Node from cc
• Node.EventType from cc
• NodePool from cc
• OptimizedCurve from cc
• OriginalContainer from cc
• PackManager from cc.AssetManager
• PageView from cc
• PageViewIndicator from cc
• Parser from cc.AssetManager
• ParticleAsset from cc
• ParticleSystem from cc
• ParticleSystem3D from cc
• path from cc
• Physics3DManager from cc
• PhysicsBoxCollider from cc
• PhysicsChainCollider from cc
• PhysicsCircleCollider from cc
• PhysicsCollider from cc
• PhysicsContact from cc
• PhysicsImpulse from cc
• PhysicsManager from cc
• PhysicsMaterial from cc
• PhysicsPolygonCollider from cc
• PhysicsRayCastResult from cc
• PhysicsRayResult from cc
• Pipeline from cc.AssetManager
• Playable from cc
• PolygonCollider from cc
• Pool from js
• Prefab from cc
• primitive.VertexData from cc
• PrismaticJoint from cc
• PrivateNode from cc
• ProgressBar from cc
• ProportionalToFrame from cc
• ProportionalToWindow from cc
• Quat from cc
• Rect from cc
• RenderComponent from cc
• renderer from cc
• RenderTexture from cc
• RequestItem from cc.AssetManager
• ResolutionPolicy from cc
• RevoluteJoint from cc
• RichText from cc
• RigidBody from cc
• RigidBody3D from cc
• RopeJoint from cc
• RotationOvertimeModule from cc
• SafeArea from cc
• Scene from cc
• SceneAsset from cc
• Scheduler from cc
• screen from cc
• Scrollbar from cc
• ScrollView from cc
• ShapeModule from cc
• Size from cc
• SizeOvertimeModule from cc
• Skeleton from sp
• SkeletonAnimation from cc
• SkeletonAnimationClip from cc
• SkeletonData from sp
• SkinnedMeshRenderer from cc
• Slider from cc
• sp.AttachUtil from sp
• SphereCollider3D from cc
• Sprite from cc
• SpriteAtlas from cc
• SpriteFrame from cc
• SubContextView from cc
• SwanSubContextView from cc
• sys from cc
• SystemEvent from cc
• SystemEvent.EventType from cc
• Task from cc.AssetManager
• TextAsset from cc
• Texture2D from cc
• TextureAnimationModule from cc
• TiledLayer from cc
• TiledMap from cc
• TiledMapAsset from cc
• TiledObjectGroup from cc
• TiledTile from cc
• TMXImageLayerInfo from cc
• TMXLayerInfo from cc
• TMXMapInfo from cc
• TMXObjectGroupInfo from cc
• TMXTilesetInfo from cc
• Toggle from cc
• ToggleContainer from cc
• ToggleGroup from cc
• Touch from cc
• TrailModule from cc
• TTFFont from cc
• Tween from cc
• TypeScript from cc
• url from cc
• ValueType from cc
• Vec2 from cc
• Vec3 from cc
• Vec4 from cc
• VelocityOvertimeModule from cc
• VertexEffectDelegate from sp
• VertexFormat from cc
• VideoClip from cc
• VideoPlayer from cc
• View from cc
• ViewGroup from cc
• visibleRect from cc
• WebView from cc
• WeldJoint from cc
• WheelJoint from cc
• Widget from cc
• WorldManifold from cc
• WXSubContextView from cc

Enums

• AnimationCurve.WrapMode from cc
• AnimationEventType from sp
• ArmatureDisplay.AnimationCacheMode from dragonBones
• audioEngine.AudioState from cc
• BuiltinBundleName from cc.AssetManager
• Button.Transition from cc
• Camera.ClearFlags from cc
• debug.DebugMode from cc
• EditBox.InputFlag from cc
• EditBox.InputMode from cc
• EditBox.KeyboardReturnType from cc
• ERigidBodyType from cc
• geomUtils.enums from cc
• Graphics.LineCap from cc
• Graphics.LineJoin from cc
• Label.CacheMode from cc
• Label.HorizontalAlign from cc
• Label.Overflow from cc
• Label.Type from cc
• Label.VerticalAlign from cc
• Layout.AxisDirection from cc
• Layout.HorizontalDirection from cc
• Layout.ResizeMode from cc
• Layout.Type from cc
• Layout.VerticalDirection from cc
• Light.ShadowType from cc
• Light.Type from cc
• macro.BlendFactor from cc
• macro.ImageFormat from cc
• macro.KEY from cc
• macro.TextAlignment from cc
• Mask.Type from cc
• Material.BUILTIN_NAME from cc
• MeshRenderer.ShadowCastingMode from cc
• PageView.Direction from cc
• PageView.EventType from cc
• PageView.SizeMode from cc
• PageViewIndicator.Direction from cc
• ParticleSystem.EmitterMode from cc
• ParticleSystem.PositionType from cc
• ParticleSystem3DAssembler.RenderMode from cc
• ParticleSystem3DAssembler.Space from cc
• PhysicsManager.DrawBits from cc
• Prefab.OptimizationPolicy from cc
• primitive.PolyhedronType from cc
• ProgressBar.Mode from cc
• RayCastType from cc
• RenderTexture.DepthStencilFormat from cc
• RigidBodyType from cc
• Scrollbar.Direction from cc
• ScrollView.EventType from cc
• shapeModule.ArcMode from cc
• shapeModule.EmitLocation from cc
• shapeModule.ShapeType from cc
• Skeleton.AnimationCacheMode from sp
• Slider.Direction from cc
• Sprite.FillType from cc
• Sprite.SizeMode from cc
• Sprite.State from cc
• Sprite.Type from cc
• sys.NetworkType from cc
• Texture2D.Filter from cc
• Texture2D.PixelFormat from cc
• Texture2D.WrapMode from cc
• textureAnimationModule.Animation from cc
• textureAnimationModule.Mode from cc
• TiledMap.Orientation from cc
• TiledMap.Property from cc
• TiledMap.RenderOrder from cc
• TiledMap.StaggerAxis from cc
• TiledMap.TileFlag from cc
• TiledMap.TMXObjectType from cc
• trailModule.TextureMode from cc
• trailModule.TrailMode from cc
• VerticalTextAlignment from cc
• VideoPlayer.EventType from cc
• VideoPlayer.ResourceType from cc
• WebView.EventType from cc
• Widget.AlignMode from cc
• WrapMode from cc

Editor API

• AssetDB

Main Process

• Editor
• Editor (Console Module)
• Editor.App
• Editor.Debugger
• Editor.DevTools
• Editor.Dialog
• Editor.Ipc
• Editor.MainMenu
• Editor.Menu
• Editor.Package
• Editor.Panel
• Editor.Profile
• Editor.Protocol
• Editor.Window
• Editor.Worker

Renderer Process (Web Page)

• Editor
• Editor (Console Module)
• Editor.Dialog
• Editor.Ipc
• Editor.MainMenu
• Editor.Menu
• Editor.Package
• Editor.Panel
• Editor.Protocol
• Editor.Window
• Editor.UI (DOM Utils Module)
• Editor.UI (Element Utils Module)
• Editor.UI (Focus Module)
• Editor.UI (Resources Module)
• Editor.UI.Settings
• Editor.UI.DockUtils
• Editor.UI.DragDrop

Modules for Both Processes

• Editor
• Editor.Easing
• Editor.IpcListener
• Editor.JS
• Editor.Math
• Editor.Selection
• Editor.Undo
• Editor.Utils
• Editor.i18n