Skip to content

Main NavigationAPI Reference Engine Download Cocos Store

English

English

Appearance

Cocos Creator

Sidebar Navigation

Getting Started

Beginner Guide

About Cocos Creator

Install and Launch

Dashboard

Hello World!

Project Structure

Using Editor

Assets

Scene

Node Tree

Properties

Node Library

Console

Settings

Project Settings

Main Menu

Toolbar

Editor Layout

Preview and Build

Coding Environment Setup

Quick Start: Create Your First Game

Cocos2d-x User Guide

Get Help and Support

Upgrade Guide

v2.4 Asset Manager Upgrade Guide

v2.4 Subpackage Upgrade Guide

v2.4 Custom Project Build Process Upgrade Guide

v2.1 Upgrade Guide

v2.0 Upgrade Guide

v1.10 Resource Upgrade Guide

FAQ

Workflows

Asset Workflow

Scene Managing

Texture

Prefab

Atlas

Auto Atlas

Texture Compression

Label Atlas

Import/Export Assets

Texture Auto Trim

Script Files

Font

Particle

AudioClip

Spine

DragonBones

Tiledmap

JSON

Text

Import Project from Other Editor

Scene Building Workflow

Node and Component

Transform

Node Tree

Scene Editing

Scene Camera Configuration

Scripting

Use Component

cc.Class

Access Node and Component

Common Node and Component API

Lifecycle Callback

Creating and Destroying Nodes

Scene Management

Acquire and Set Asset

Asset Loading

Asset Bundle Configuration and Loading

Event System

Builtin Events

Player Input

Tweening

Actions

Scheduler

Execution Order

Networking

Pooling

Modular Script

Plugin Scripts

JavaScript Primer

TypeScript Support

Advanced CCClass

Attributes

Access to Third Party Services

Cocos Service Introduction

Agora RTC

Location Kit (HMS Core)

Analytics Kit (HMS Core)

APM (AGC)

Auth Service (AGC)

Crash (AGC)

Remote Configuration (AGC)

App Messaging (AGC)

App Linking (AGC)

Cloud DB (AGC)

Cloud Storage (AGC)

Cloud Functions (AGC)

Cocos SDKHub

Cocos SDKHub Introduction

HUAWEI HMS Core

Publish Game

Publish to Web

Publish to Facebook Instant Games

Setup Native Development

A short tutorial to install python on MacOS

Publish to native

Debugging JavaScript on Native Platforms

Publish to HUAWEI AppGallery Connect

Publish to Google Play Instant

Publish to Alipay Mini Games

Publish to Taobao Mini Games

Publish to ByteDance Mini Games

Publish to Cocos Play

Publish to Huawei Quick Games

Publish to OPPO Mini Games

Publish to vivo Mini Games

Publish to Migu Mini Games

Publish to Xiaomi Quick Games

Publish to Baidu Mini Games

Baidu Open Data Context

Publish to WeChat Mini Games

WeChat Open Data Context

WeChat Engine Plugin

WeChat PC Mini Games

Mini Game Subpackage

Publish from Command Line

Custom Project Build Template

Systems

Renderer and Graphics

Core Renderers

External Asset Renderer

Camera

Material

Effect

Sprite Reference

Label Reference

LabelOutline Reference

LabelShadow Reference

Mask Reference

MotionStreak Reference

ParticleSystem Reference

Tiledmap Reference

TiledTile Reference

Spine Reference

DragonBones Reference

VideoPlayer Reference

WebView Reference

Graphics Reference

UI

Multi-Resolution Adaption

Widget Alignment

Stretchable UI Sprites

Label Layout

Layout Container

List with Data

UI Component Reference

Canvas Reference

Widget Reference

Button Reference

Layout Reference

SafeArea Reference

EditBox Reference

RichText Reference

ScrollView Reference

ScrollBar Reference

ProgressBar Reference

Toggle Reference

ToggleContainer Reference

Slider Reference

PageView Reference

PageViewIndicator Reference

BlockInputEvents Reference

Animation

Introduction

Animation Component and Clip

Animation Curve

Sprite Animation

Time Curve

Animation Event

Animation Scripting

Animation Component Reference

Audio

Play Audio

AudioSource Reference

Compatability

Physics and Collision

Collision

Editing Collider Component

Collision Group

Collision Scripting

Collider Component Reference

Physics

Physics Manager

RigidBody

Physics Collider

Contact Callback

Joint

Advance Settings

3D System

3D Node

3D Scene

Import Model Resources

Mesh Resource

Mesh Renderer Component

Skinned Mesh Renderer Component

Skeleton Animation Component

Collision Detection

Lighting

Light Reference

3D Particle System

Primitive 3D Objects

3D Physics and Collision

Setting Physics Engine

Physics Manager

RigidBody Component Reference

ConstantForce Component Reference

Collider Component Reference

Physics Events

Physics Material

Asset Manager

Asset Bundle

Release Of Resources

Download and Parse

Loading and Preloading

Cache Manager

Optional Parameters

Pipeline and Task

Advanced Topics

Editor Extension

Your First Extension

Install and Share

Introduction to IPC

Entry Point

Extension Workflow

Extends Main Menu

Build Panel

IPC Workflow

Work with Simple Panel

i18n

Working Directories

Submit Extension to Cocos Store

Calling Engine API and Project Scripts

Asset Management

Create Panel

UI Kit

Extends UI Kit

Layout UI Element

Work with Vue.js

Extend Inspector

Customize Gizmos

Advanced Gizmos

Test Your Extension

package.json Reference

Main Menu Reference

Panel Registration Reference

Panel Define Reference

Custom Element Reference

Builtin IPC Message Reference

Advanced Topics

Resource management considerations - meta files

JSB 2.0 Guide

Hot Update Tutorial

AssetManager for Hot Update

i18n

User Data Storage

Engine Customization Workflow

Web Preview Customization

RenderFlow

UI Rendering Batch Processing Guide

Dynamic Atlas

JavaScript to Java Reflection

JavaScript to Objective-C Reflection

SDK Integration

Facebook Live Video & Audience Network

WebSocket Server

On this page

Advanced Topics

Resource management considerations - meta files
JSB 2.0 Guide
Hot Update
- Hot update tutorial
- AssetManager
i18n support
Read and Write user data
Engine Customization
Web Preview Customization
RenderFlow
UI Rendering Batch Processing Guide
Dynamic Atlas
JavaScript to Java Reflection
JavaScript to Objective-C Reflection

Edit this page on GitHub

Last updated:

Pager

Previous pageBuiltin IPC Message Reference

Next pageResource management considerations - meta files

Released under the MIT License.

Copyright © 2019-present Cocos