Skip to content

Create Cutcenes

Gustavo Lopes edited this page Oct 23, 2023 · 3 revisions

Introduction

Cutcenes are scripted sequences of actions that occur during gameplay. There are many forms in which you can implement Cutcenes with the help of this plugin and we are going to take a look at each one, their use cases, and all the functionality that they offer.

OverlayCutcene2D

In this first part, we are going to talk about a group of nodes, from a category called the "OverlayCutcene2D" nodes, meaning, that they are generally just Control nodes in Godot, that occupies the entire screen in the GameUI and show the player crucial information for him to see.

We are not going to use this class directly, since it is just an abstract. You instead focus on using/extending from the classes that already implement most features you are going to need, which are the "Static Cutcene" and the "Custom Cutcene".

Static Cutcene

As it's name suggest, this node is responsible for creating cutcenes where there is only a single image. This is the most simple implementation of a cutcene. But if you need a little bit more, you can try by adding custom scripting to the cutcene with the CutceneScript class. For more details, take a look down below.

Methods

play_cutcene

func play_cutcene(cutcene_texture: CompressedTexture2D = null, script: GDScript = cutcene_script) -> void:

Play a static cutcene, show the cutcene_texture as an overlay during the event and use the specified script to guide the events happening in the cutcene.

hide_cutcene

func hide_cutcene() -> void:

Hide the current on_going cutcene. In normal circumstances, you don't actually call this function, the function itself will be called when the cutcene ended. But in case you want to force the action of exiting the cutcene, you can do that, by calling this function.

Signals

Properties

How to use

Cutcene Script

The "Cutcene Script" is a complementary class for the "Static Cutcene", which the developer can use, if he desires to implement custom cutcene behavior.

The default behavior is to wait the user press the "Continue" key and then the cutcene finish, however, if you want to show dialogue or maybe you want a simple animation, then you should create an extended version of the "Cutcene Script".

Custom Cutcene

The custom cutcenes are as it's name suggests, a special type of "Static Cutcenes" where there is more complex behavior taking place, and you need more "firepower" to make this custom behavior flourish.

Methods

Signals

Properties

How to use

Cinematic Cutcene

Finally, the cinematic cutcene are in-game cutcenes with actions that manipulates the elements of the current Scene. You implement these cutcenes in the scenes themselves, instead of the GameUI like the OverlayCutcene2D. However if you still want to "merge" both styles, you can use StaticCutcenes to show more information to the player.

Methods

Signals

Properties

How to use

Clone this wiki locally