Difference between revisions of "Documentation/Engine/Units/journey events cutscene"
< Documentation | Engine | Units
Jump to navigation
Jump to search
(3 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
The '''journey events cutscene''' unit class is used to define cutscenes for [[Documentation/Engine/Random_Road_Events|Random Road Events]]. | The '''journey events cutscene''' unit class is used to define cutscenes for [[Documentation/Engine/Random_Road_Events|Random Road Events]]. | ||
− | This unit gathers multiple cutscenes and binds them with the attributes of this unit. So cutscenes with same auxiliary data can be defined in one journey event cutscene unit, which enables usage | + | This unit gathers multiple cutscenes and binds them with the attributes of this unit. So cutscenes with same auxiliary data can be defined in one journey event cutscene unit, which enables usage more graphical variants wrapped under one journey event cutscene. |
== Attributes == | == Attributes == | ||
Line 13: | Line 13: | ||
|array<token> | |array<token> | ||
| | | | ||
− | |Array of token names of all cutscenes that this unit should gather (token name is matching cutscenes | + | |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 | |left_width | ||
Line 36: | Line 36: | ||
|float | |float | ||
|<nowiki>-1.0</nowiki> | |<nowiki>-1.0</nowiki> | ||
− | |Height of the cutscenes gathered by token names. Value >= 0.0 means that we could | + | |Height of the cutscenes gathered by token names. Value >=0.0 means that we could move the cutscene inside the lane. |
|- | |- | ||
|align_buildings | |align_buildings |
Revision as of 14:30, 22 May 2018
The journey events cutscene unit class is used to define cutscenes for Random Road Events.
This unit gathers multiple cutscenes and binds them with the attributes of this unit. So cutscenes with same auxiliary data can be defined in one journey event cutscene unit, which enables usage more graphical variants wrapped under one journey event cutscene.
Attributes
Name | 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 | -1.0 | 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 | -1.0 | 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.
|
lane_height | float | -1.0 | 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. |