Difference between revisions of "Documentation/Engine/Units/journey events road event"
< Documentation | Engine | Units
Jump to navigation
Jump to search
| Line 30: | Line 30: | ||
|layer_cutscenes | |layer_cutscenes | ||
|array<link_ptr> | |array<link_ptr> | ||
| − | | | + | | |
|Array of layer cutscenes (cutscenes placed between start and end cutscenes). | |Array of layer cutscenes (cutscenes placed between start and end cutscenes). | ||
|- | |- | ||
|mirror_cutscenes | |mirror_cutscenes | ||
|array<link_ptr> | |array<link_ptr> | ||
| − | | | + | | |
|Array of layer cutscenes for mirror event. Check '''mirror_active''' attributes for more info. | |Array of layer cutscenes for mirror event. Check '''mirror_active''' attributes for more info. | ||
|- | |- | ||
|layer_min_curve | |layer_min_curve | ||
|array<float> | |array<float> | ||
| − | | | + | | |
|Minimal allowed curvature of the road for layer cutscenes (in degress). It has to be defined for each item of '''layer_cutscenes''' array. | |Minimal allowed curvature of the road for layer cutscenes (in degress). It has to be defined for each item of '''layer_cutscenes''' array. | ||
|- | |- | ||
|layer_max_curve | |layer_max_curve | ||
|array<float> | |array<float> | ||
| − | | | + | | |
|Maximal allowed curvature of the road for layer cutscenes (in degress). It has to be defined for each item of '''layer_cutscenes''' array. | |Maximal allowed curvature of the road for layer cutscenes (in degress). It has to be defined for each item of '''layer_cutscenes''' array. | ||
|- | |- | ||
|min_length | |min_length | ||
|float | |float | ||
| − | |-1.0 | + | | <nowiki>-1.0</nowiki> |
|Minimal length of whole random event (in meters). | |Minimal length of whole random event (in meters). | ||
|- | |- | ||
| Line 60: | Line 60: | ||
|min_shoulder_space | |min_shoulder_space | ||
|float | |float | ||
| − | |-1.0 | + | | <nowiki>-1.0</nowiki> |
|Minimal shoulder space of the road (in meters). Compared with road look shoulder_space_left/shoulder_space_right attributes. | |Minimal shoulder space of the road (in meters). Compared with road look shoulder_space_left/shoulder_space_right attributes. | ||
|- | |- | ||
| Line 67: | Line 67: | ||
|100.0 | |100.0 | ||
|Maximal shoulder space of the road (in meters). Compared with road look shoulder_space_left/shoulder_space_right attributes. | |Maximal shoulder space of the road (in meters). Compared with road look shoulder_space_left/shoulder_space_right attributes. | ||
| + | |- | ||
| + | |traffic_block | ||
| + | |bool | ||
| + | |false | ||
| + | |Is necessary to block the most outer lane? | ||
| + | |- | ||
| + | |weight | ||
| + | |float | ||
| + | |1.0 | ||
| + | |Weight of the generation probability of this road event. | ||
| + | |- | ||
| + | |countries | ||
| + | |array<token> | ||
| + | | | ||
| + | |Array of tokens of allowed countries for this road event, empty array for no limitation. Uses full name like eg. 'france'. | ||
| + | |- | ||
| + | |excluded_countries | ||
| + | |array<token> | ||
| + | | | ||
| + | |Array of tokens of excluded countries for this road event. | ||
| + | |- | ||
| + | |min_time_constraint | ||
| + | |unsigned | ||
| + | |0 | ||
| + | |Minimal allowed time for this road event generation (in game minutes in day). | ||
| + | |- | ||
| + | |max_time_constraint | ||
| + | |unsigned | ||
| + | |24 * 60 | ||
| + | |Maximal allowed time for this road event generation (in game minutes in day). | ||
| + | |- | ||
| + | |min_duration | ||
| + | |unsigned | ||
| + | |0 | ||
| + | |Minimal accident duration, accident will be active for this time at least, even if the road has been released (in game minutes). | ||
|} | |} | ||
Revision as of 14:34, 18 May 2018
The journey_events_road_event unit class is used to define Random Road Events.
Attributes
| Name | Type | Default Value | Description |
|---|---|---|---|
| name | string | Name of the road event (description). | |
| set_idx | unsigned | Event's set. | |
| start_cutscene | link_ptr | NULL | Start cutscene of the road event. |
| end_cutscene | link_ptr | NULL | End cutscene of the road event. |
| layer_cutscenes | array<link_ptr> | Array of layer cutscenes (cutscenes placed between start and end cutscenes). | |
| mirror_cutscenes | array<link_ptr> | Array of layer cutscenes for mirror event. Check mirror_active attributes for more info. | |
| layer_min_curve | array<float> | Minimal allowed curvature of the road for layer cutscenes (in degress). It has to be defined for each item of layer_cutscenes array. | |
| layer_max_curve | array<float> | Maximal allowed curvature of the road for layer cutscenes (in degress). It has to be defined for each item of layer_cutscenes array. | |
| min_length | float | -1.0 | Minimal length of whole random event (in meters). |
| max_length | float | 10000.0 | Maximal length of whole random event (in meters). |
| min_shoulder_space | float | -1.0 | Minimal shoulder space of the road (in meters). Compared with road look shoulder_space_left/shoulder_space_right attributes. |
| max_shoulder_space | float | 100.0 | Maximal shoulder space of the road (in meters). Compared with road look shoulder_space_left/shoulder_space_right attributes. |
| traffic_block | bool | false | Is necessary to block the most outer lane? |
| weight | float | 1.0 | Weight of the generation probability of this road event. |
| countries | array<token> | Array of tokens of allowed countries for this road event, empty array for no limitation. Uses full name like eg. 'france'. | |
| excluded_countries | array<token> | Array of tokens of excluded countries for this road event. | |
| min_time_constraint | unsigned | 0 | Minimal allowed time for this road event generation (in game minutes in day). |
| max_time_constraint | unsigned | 24 * 60 | Maximal allowed time for this road event generation (in game minutes in day). |
| min_duration | unsigned | 0 | Minimal accident duration, accident will be active for this time at least, even if the road has been released (in game minutes). |
