Skip to content

Main NavigationAPI Reference Engine Download Cocos Store

English

English

Appearance

Cocos Creator

Sidebar Navigation

Beginners Guide

Basic Usage

About Cocos Creator

Installing and Launching

Dashboard

Hello World!

Project Structure

Editor Panels

Scene

Hierarchy

Assets

Inspector

Console

Preferences

Project Settings

Main Menu

Tool Bar

Editor Layout

Preview & Debugging

Support

Caution!

Quick Start: First Game

Upgrade Guide

Cocos Creator 3.0 Upgrade Guide

Cocos Creator 3.0 Material Upgrade Guide

Cocos Creator 3.1 Material Upgrade Guide

Basic Workflow

Scene Creation

Scene Assets

Nodes and Components

Coordinate Systems and Transformations

Node Hierarchy and Rendering Order

Build a Scene Image Using the Scene Panel

Asset System

Asset Workflow

Images

Textures

Sprite Frames

Auto Trim for SpriteFrame

Atlas

Auto Atlas

Label Atlas

Prefab

Fonts

Audio

Material

Model

Importing Models Exported from DCC Tools

glTF

Spine Skeletal Animation

DragonBones Skeletal Animation

TiledMap

Scripting Guide and Event System

Programming Language Support

Scripting Basics

Script Creation

Coding Environment Setup

Operating Environment

Decorator

Property Attributes

Life Cycle Callbacks

Using Scripts

Access Nodes and Components

Common Node and Component Interfaces

Create and Destroy Nodes

Scheduler

Components and Component Execution Order

Loading and Switching Scenes

Obtaining and Loading Assets

tsconfig Configuration

Advanced Scripting

Events

Listening to and Launching Events

Node System Events

Global System Events

Event API

Modules

Engine Modules

External Module Usage Case

Module Specification

Plugin Scripts

Cross-platform Game Publish

About the Build Panel

General Build Options

Publish to Web Platforms

Publish to Native Platforms

Publish for the Huawei HarmonyOS

Setup Native Development

Debugging JavaScript on Native Platforms

Publish to Mini Game Platforms

Publish to HUAWEI AppGallery Connect

Publish to Alipay Mini Game

Publish to ByteDance Mini Game

Publish to Huawei Quick Game

Publish to OPPO Mini Game

Publish to vivo Mini Game

Publish to Xiaomi Quick Game

Publish to Baidu Mini Game

Publish to WeChat Mini Game

WeChat Engine Plugin

Access to the WeChat PC Mini Game

Access to Open Data Context

Mini Game Subpackage

Publish from the Command Line

Build Process with FAQ

Custom Project Build Process

Function Modules

Graphics Rendering

Render Pipeline

Built-in Render Pipeline

Camera

Lighting

Physically Based Lighting

Lights

Directional Lights

Spherical Lights

Spotlights

Ambient Light

Additive Per-Pixel Lights

Shadows

Lightmapping

Meshes

MeshRenderer

Textures

Texture Compression

RenderTexture

Material System

YAML 101

Effect Syntax

Pass Params

Builtin Shader Uniforms

Effects

Billboard

Line

Skybox

Global Fog

2D Objects

2D Render

Rendering Order

2D Renderable Component Batching Rules

Custom Materials for 2D Rendering Objects

2D Renderable Components

Sprite Component Reference

Label Component Reference

Mask Component Reference

Graphics Component Reference

RichText Component Reference

UIStaticBatch Component Reference

Spine Skeleton Component Reference

DragonBones ArmatureDisplay Component Reference

TiledMap Component Reference

TiledTile Component Reference

MotionStreak Component Reference

UI System

UI Components

Canvas Component Reference

UITransform Component Reference

Widget Component Reference

Button Component Reference

Layout Component Reference

EditBox Component Reference

ScrollView Component Reference

ScrollBar Component Reference

ProgressBar Component Reference

LabelOutline Component Reference

LabelShadow Component Reference

Toggle Component Reference

ToggleContainer Component Reference

Slider Component Reference

PageView Component Reference

PageViewIndicator Component Reference

UIMeshRenderer Component Reference

UICoordinateTracker Component Reference

UIOpacity Component Reference

BlockInputEvents Component Reference

WebView Component Reference

VideoPlayer Component Reference

SafeArea Component Reference

UI Practice Guide

Multi-Resolution Adaption

Widget Alignment

Label Layout

Auto Layout Container

Create a List of Dynamically Generated Content

Stretchable UI Sprite

Animation

Animation Clip

Animation Component Reference

Animation Panel

Creating Animation Components and Animation Clips

Get Familiar with the Animation Panel

Editing Animation Clips

Editing Animation Easing Curve

Adding Animation Events

Using Animation Curves

Skeletal Animation

Joint Texture Layout Settings

Controlling Animation with Scripts

Animation State

Audio System

AudioSource Component Reference

AudioSource Playback Example

Compatibility Notes

Physics System

Physics 2D

2D Physics Manager

2D RigidBody

2D Physics Collider

2D Contact Callback

2D Physics Joint

Physics 3D

3D Physics Options

3D Physics System

3D Physics Component

Using 3D Physics

3D Physics Collider

3D Physics Configs

3D Physics Material

3D RigidBody

3D Physics Events

Groups And Masks

3D RayCast Detection

Particle System

2D Particle System

3D Particle System

Particle System Module

Main Module

Shape Module

Velocity Overtime Module

Force Overtime Module

Size Overtime Module

Rotation Overtime Module

Color Over Life Time Module

Texture Animation Module

Limit Velocity Overtime Module

Trail Module

Renderer Module

Particle Properties Editor

Curve Editor

Gradient Editor

Particle Editor

Tween System

Terrain System

Asset Manager

AssetManager Upgrade Guide

Asset Bundle Upgrade Guide

Asset Loading

Asset Bundle

Release Of Assets

Download and Parse

Loading and Preloading

Cache Manager

Optional Parameters

Pipeline and Task

Resource Management Considerations --- meta files

Advanced Tutorials

Editor Extension

First Extension

First Panel

First Data Interaction

Install and Share

Submitting Resources to Cocos Store

Extension Panel

Compose Panel

Panel Message

Communicate with the Panel

Contributions

Message

Shortcuts

Call the engine API and project script

Extending the Main Menu

Extending the Assets Panel

Extending the Project Settings Panel

Extending the Preferences Panel

Extend the Build Process

Basic

Extension Description

Extension

Message

I18n

Profile

Editor UI

Advanced Topics

Hot Update Tutorial

AssetManager for Hot Update

Dynamic Atlas

Engine Customization Workflow

Web Preview Customization Workflow

The Tutorial for JSB 2.0

JavaScript to Java Reflection

JavaScript to Objective-C Reflection

CMake Usage Introduction

WebSocket Server

On this page

Upgrade Guide

Cocos Creator 3.0 Upgrade Guide
Cocos Creator 3.0 Material Upgrade Guide
Cocos Creator 3.1 Material Upgrade Guide

Edit this page on GitHub

Last updated:

Pager

Previous pageQuick Start: First Game

Next pageCocos Creator 3.0 Upgrade Guide

Released under the MIT License.

Copyright © 2019-present Cocos