Learning Materials

Article
Resource

Classes

Classes describe an aggregate of ta fields such as variables and defines the operations, such as methods.

Think of a class as a blueprint for creating objects, with initial value states, and implementation behavior.

In GDScript, by default, all script classes are unnamed classes.

This means you can only reference a class by its relative path.

Absolute Path

# Absolute Path on Windows
"C:\Data\Filepath"

Relative Path

# Relative Path through GDScript
"res://path/to/file.gd"

Basic Class Format

Use the extends keyword in a class file to let Godot know which Global Godot class your script file inherits from.

The extends keyword determines what Node functions are available to you.

You can learn more about the Godot Global Classes in the Godot Basics Series.

Classes can also have class/member variables and functions.

Class/member variables are available in the entire class file.

# Example.gd
extends Node2D

var playerHealth: int = 100
var playerSpeed: float = 5.0

func getPlayerHealth() -> int:
    return playerHealth

If you omit the extends keyword, your class will inherit from the Reference global class:

# Example.gd
# Extends from Global Reference Class

var playerHealth: int = 100
var playerSpeed: float = 5.0

func getPlayerHealth() -> int:
    return playerHealth

Naming a Class

Use the class_name keyword to name a class and add it to the global scope.

The newly created class will be available in other .gd files and scenes in Godot.

#Player.gd

extends Node2D

class_name Player

# class variables and functions

#Scene.gd

extends Node2D

var playerInstanceObject = Player.new()

Class Inheritance

A GDScript class can inherit from the following:

Global Class
Another Class
An Inner Class

Inner Class

An inner class is a class inside of a class.

extends Node

# class instance object
var object = InnerClass.new()

func _ready():
   var getInnerValue = object.getA()
   print(getInnerValue)

class InnerClass:
   #member variables
   var another = 100
   
   func getAnother():
      return another