Changes

Jump to navigation Jump to search

Documentation/Engine/Units/journey events road event

2,597 bytes added, 07:10, 23 May 2018
no edit summary
The '''journey_events_road_event''' unit class is used to define [[Documentation/Engine/Random_Road_Events|Random Road Events]].
 
All cutscenes attributes ('''start_cutscene''', '''end_cutscene''', '''layer_cutscenes''', '''mirror_cutscenes''', '''signs_cutscenes_inner''' and '''signs_cutscenes_outer''' ) use link pointers of: [[Documentation/Engine/Units/journey_events_cutscene|'''journey_events_cutscene''']] for linking cutscene data to each random event.
== Attributes ==
|array<link_ptr>
|
|Array of layer cutscenes (cutscenes placed between start and end cutscenes).This array has more than one element when stacking more types of cutscenes beside each other for example: roadwork should have first layer for signs and second for actual roadwork. Layer usage cabe be seen below: [[#Composition of the road event]]
|-
|mirror_cutscenes
|array<link_ptr>
|
|Array of layer cutscenes Similar as '''layer_cutscenes''' only that it's used for mirror eventopposite road direction. Check '''mirror_active''' attributes for more info.
|-
|layer_min_curve
|-
|remove_map_sign
|array<token>bool
|
|If true then remove conflicting signs (speed limits) on the map overlapping with the road event.
|-
|inner_lane_allowed
|bool
|false
|Is the road event allowed in the most inner lane?
|-
|center_lane_allowed
|bool
|false
|Is the road event allowed in some of the center lanes?
|-
|outer_lane_allowed
|bool
|false
|Is the road event allowed in the most outer lane?
|-
|allowed_lanes_count
|array<unsigned>
|
|Array of allowed road lanes counts. Empty array means no constraint.
|-
|mirror_active
|bool
|false
|Should road event spawn in the opposite direction too? The opposite direction must fulfill all conditions of the road event. However '''mirror_cutscenes''' will be used in opposite direction instead of '''layer_cutscenes'''.
|-
|forward_allowed
|bool
|true
|Is the road event allowed in the forward direction (nodes[0] -> nodes[1])?
|-
|backward_allowed
|bool
|true
|Is the road event allowed in the backward direction (nodes[1] -> nodes[0])?
|-
|signs_cutscenes_outer
|array<link_ptr>
|
|Array of cutscenes for signs of the most outer lane. More info: [[Documentation/Engine/Random Road Events#Signage]].
|-
|signs_distances_outer
|array<float>
|
|Array of same size as '''signs_cutscenes_outer''' defining distances of signs for the most outer lane, where positive values will place signs before road event and negative will place it after. More info: [[Documentation/Engine/Random Road Events#Signage]].
|-
|signs_cutscenes_inner
|array<link_ptr>
|
|Array of cutscenes for signs of the most inner lane. More info: [[Documentation/Engine/Random Road Events#Signage]].
|-
|signs_distances_inner
|array<float>
|
|Array of same size as '''signs_cutscenes_inner''' defining distances of signs for the most inner lane, where positive values will place signs before road event and negative will place it after. More info: [[Documentation/Engine/Random Road Events#Signage]].
|-
|parent
|link_ptr
|NULL
|Road event parent, all non explicitly defined values are inherited from the parent.
|}
 
= Composition of the road event =
[[File:Engine random event composition.jpg|1024px|Layers in road event]]
91
edits

Navigation menu