1,740
edits
Changes
Jump to navigation
Jump to search
Created page with "The '''journey events cutscene''' unit class is used to define cutscenes for Random Road Events. This unit matches all saved cutsc..."
The '''journey events cutscene''' unit class is used to define cutscenes for [[Documentation/Engine/Random_Road_Events|Random Road Events]].
This unit matches all saved cutscenes by tokens given in '''cutscene_tokens''' array and binds them with the rest of attributes of this unit. So cutscenes with same auxiliary data can be defined in one journey events cutscene unit.
== Attributes ==
{|class="wikitable"
!Name
![[Documentation/Engine/Units#Attribute_types|Type]]
!Default Value
!Description
|-
|cutscene_tokens
|array<token>
|
|Array of token names of all cutscenes that this unit should gather (token name is matching cutscenes by last token in cutscene unit names).
|-
|left_width
|float
|<nowiki>-1.0</nowiki>
|The width of left side of the cutscenes gathered by given token names. More info: [[Documentation/Engine/Random_Road_Events#Cutscene_width]].
|-
|right_width
|float
|<nowiki>-1.0</nowiki>
|The width of right side of the cutscenes gathered by given token names. More info: [[Documentation/Engine/Random_Road_Events#Cutscene_width]].
|-
|sequence_mode
|int
|simple
|How will game choose cutscene token if this cutscene data gathers more than one cutscene.
* '''simple''' - Each cutscene in sequence (when more layer_cutscenes are placed after one another) is selected randomly and independently.
* '''pseudo''' - Each cutscene in sequence (when more layer_cutscenes are placed after one another) is selected in the way, that each N-tuple (where N is the number of cutscenes gathered by token names) contains all cutscenes in random order.
* '''fixed''' - One random cutscene is used for the whole sequence.
|-
|lane_height
|float
|<nowiki>-1.0</nowiki>
|Height of the cutscenes gathered by token names. Value >=0.0 means that we could move the cutscene inside the lane.
|-
|align_buildings
|bool
|false
|Should buildings be aligned to the drivable curve? When true all building nodes are placed in the same distance from the curve as is the X-axis distance from the cutscene origin.
|}
This unit matches all saved cutscenes by tokens given in '''cutscene_tokens''' array and binds them with the rest of attributes of this unit. So cutscenes with same auxiliary data can be defined in one journey events cutscene unit.
== Attributes ==
{|class="wikitable"
!Name
![[Documentation/Engine/Units#Attribute_types|Type]]
!Default Value
!Description
|-
|cutscene_tokens
|array<token>
|
|Array of token names of all cutscenes that this unit should gather (token name is matching cutscenes by last token in cutscene unit names).
|-
|left_width
|float
|<nowiki>-1.0</nowiki>
|The width of left side of the cutscenes gathered by given token names. More info: [[Documentation/Engine/Random_Road_Events#Cutscene_width]].
|-
|right_width
|float
|<nowiki>-1.0</nowiki>
|The width of right side of the cutscenes gathered by given token names. More info: [[Documentation/Engine/Random_Road_Events#Cutscene_width]].
|-
|sequence_mode
|int
|simple
|How will game choose cutscene token if this cutscene data gathers more than one cutscene.
* '''simple''' - Each cutscene in sequence (when more layer_cutscenes are placed after one another) is selected randomly and independently.
* '''pseudo''' - Each cutscene in sequence (when more layer_cutscenes are placed after one another) is selected in the way, that each N-tuple (where N is the number of cutscenes gathered by token names) contains all cutscenes in random order.
* '''fixed''' - One random cutscene is used for the whole sequence.
|-
|lane_height
|float
|<nowiki>-1.0</nowiki>
|Height of the cutscenes gathered by token names. Value >=0.0 means that we could move the cutscene inside the lane.
|-
|align_buildings
|bool
|false
|Should buildings be aligned to the drivable curve? When true all building nodes are placed in the same distance from the curve as is the X-axis distance from the cutscene origin.
|}
