Documentation/Entity Types/Special/CutSceneManager.type

Language:

English • Русский

Status:

Approved

Go to higher level

CutSceneManager.type

Description

CutSceneManager is a game object type used for creating cut scenes. It includes several functions used for creating such scenes.

You can see an example of CutSceneManager use on CutSceneDemo.map (in "Data\Maps\CusSceneDemo" folder).

It is convenient to use CutSceneManager methods in map logic. You can learn how to add logic to a map from this article.

You can access cut scene’s methods and properties in the Logic Editor from the Choose Action list by selecting Static Members in the CutSceneManager scrollbar:

Methods and Properties of the CutSceneManager Class

The following properties of the CutSceneManager class can be used while creating map logic:

Name	Description
CutSceneEnable	Switches on/off the cutscene playback mode.

The following methods of the CutSceneManager class can be used while creating map logic:

Name	Parameters	Description
SetCamera	camera or camera curve.	Makes the designated camera active.
ResetCamera		Sets camera setting to default.
FadeIn	time – screen fading time in seconds.	The screen smoothly fades in.
FadeOut	time – screen fading time in seconds.	The screen smoothly fades out.
FadeInOut	timeIn – screen fade in time, timeOut – screen fade out time.	Smooth screen fading in and out.
PlaySound	name – the name of the wave file.	Sound playback.
SetMessage	text – text of the message, time – show time in seconds, color – font color.	Display a text for the scene. Can be used to display characters' dialog.
PlayObjectAnimation	obj – map object, animationName – animation name.	Game object’s animation playback.