# Prison Prolog

## Overview

* Is system which will showcase to the new prisoner your Prison in cool immersive way!
* Can be disabled in config.lua (Prolog.Enable)
* Note: There is no editor in current version, but could be tested along with config.lua/Prolog.ResetCache = true, so each time prolog will be loaded.

## Gallery

<figure><img src="https://1037498771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZErcztD5BvrKnwRGJq%2Fuploads%2Fgit-blob-a0238fda9f5e94b528301674d88ed43395261adb%2Fprison_prolog_start.png?alt=media" alt=""><figcaption><p>How the prolog looks</p></figcaption></figure>

<figure><img src="https://1037498771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZErcztD5BvrKnwRGJq%2Fuploads%2Fgit-blob-b8bdc74111693e3d208763aedd58e562ca0f1ea6%2Fprison_prolog.png?alt=media" alt=""><figcaption><p>Third sequence of prolog</p></figcaption></figure>

## Configuration

The `cameraProlog` object is used to define the initial camera position and rotation, as well as a series of points that the camera will move to during a prologue sequence.

Path: `rcore_prison/data/presets/yourMap.lua`

* Properties

***

* `initCameraPosition`
  * This property is a `vector3` that defines the initial position of the camera.
* `initCameraRot`
  * This property is a `vector3` that defines the initial rotation of the camera.
* `initGameplayCamRot`
  * This property is a `vector3` that defines the initial rotation of the gameplay camera.
* `points`
  * This property is an array of objects that define the points that the camera will move to during the prologue sequence.
  * `pos`
    * This property is a `vector3` that defines the position of the camera at this point in the sequence.
  * `rot`
    * This property is a `vector3` that defines the rotation of the camera at this point in the sequence.
  * `duration`
    * This property is a number that defines the duration of time that the camera will take to move to this point.
  * `text`
    * This property is a string that defines the text that will be displayed on the screen during this point in the sequence.
  * `textTimeout`
    * This property is a number that defines the amount of time that the text will be displayed on the screen.
  * `textRenderTime`
    * This property is a number that defines the amount of time that the text will take to fade in and out.

## Features

* Showing new Prisoner prison in cool way what they can do inside Prison / or where stuff is located.
* If Prisoner wish, they can skip the Prolog intro at any time during active sequence