Difference between revisions of "Documentation/Engine/Units/journey events cutscene"

From SCS Modding Wiki
Jump to navigation Jump to search
(Attributes)
 
(One intermediate revision by one other user not shown)
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 defined in "'''/def/camera/cutscene.sii'''" by last token in cutscene unit names).
+
|Array of token names of all cutscenes that this unit should gather (token name is matching cutscenes defined in "'''/def/camera/cutscene.sii'''" by last token of 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 move the cutscene inside the lane.
+
|Height of the cutscenes gathered by token names. Value >= 0.0 means that we could apply random offset in the perpendicular direction to lane direction (if there is enough space)
 
|-
 
|-
 
|align_buildings
 
|align_buildings

Latest revision as of 08:42, 21 December 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 of 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 defined in "/def/camera/cutscene.sii" by last token of 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.
  • 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 -1.0 Height of the cutscenes gathered by token names. Value >= 0.0 means that we could apply random offset in the perpendicular direction to lane direction (if there is enough space)
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.