Changes

Jump to navigation Jump to search

Documentation/Engine/Truck Interior Animations and IDs

9,126 bytes added, 14:54, 19 June 2020
Stick Animations
==Interior Animations==
For The movement of various things in the truck interior are used is controlled by program -driven animations ( '''*_anim''' ). For each animation can be , the range is set range by the '''*_anim_min''' and '''*_anim_max''' values. As most animations expect a range from 0 to 1, this these are also the default values. If an animation expect expects any other value range , it will be stated below.
===Special animationsAnimations===
* {| class="wikitable"!Attribute Name!Function!Behavior!Notes|-|wheel_anim* |Steering wheel|0 - left full lock<br />0.5 - center<br />1 - right full lock|For best results, each keyframe should be less than 45°<br />The steering wheel bone should be named '''steering_w''' for compatibility with [[Games/ETS2/Modding_guides/1.25#Steering_wheel_accessory|interchangeable steering wheels]].|-|wheel_updown_anim|Steering column tilt adjustment|0 - lowest setting<br />1 - highest setting|The default position is set by '''wheel_updown_anim_default'''|-|wheel_frontback_anim|Steering column telescope adjustment|0 - fully retracted<br />1 - fully extended|The default position is set by '''wheel_frontback_anim_default'''|-|wiper_anim* |Windshield wipers|0&rarr;1 is a full wipe cycle<br />(from park to full travel and back to park)|The keyframes at 0 and 1 should match.|-|gadget_anim||0&rarr;1 is a full animation cycle<br />(animation will be played as a continuous loop)|This animation is played in a loop while the truck's ignition/electricity is on.|}
===Stick animationsAnimations===
* {| class="wikitable"!Attribute Name!Function!Behavior!Notes|-|blinker_anim* |Turn signal control lever|0 - left indicator active<br />0.5 - rest position<br />1 - right indicator active||-|lights_anim* |Headlight control|0 - lights off<br />0.5 - parking/clearance lights on<br />1 - headlights on||-|high_beam_anim* |High beam headlight control|0 - rest position<br />1 - high beams on||-|light_horn_stick_anim* wiper_stick_anim|Light/city horn button* parking_stick_anim|0 - rest position<br />1 - light horn being applied* flasher_4way_anim|* engine_start_anim |- |wiper_stick_anim|Windshield wiper control|0 - off<br />1 - maximum speed|This animation is interpolated based on the total number of wiper speeds. For example, if there are two additional wiper speeds (delays), 0.33 electricity on, would correspond with the first and 0.67 engine on, 1 engine startingwith the second delay definition.|-* beacon_anim|rowspan="2"|parking_stick_anim* trailer_stick_anim - trailer |rowspan="2"|Parking brakecontrol* retarder_stick_anim* auto_transmission_stick_anim |rowspan="2"|0 - in order reverseparking brake released<br />1 -neutral-driveparking brake applied* lift_axle_stick_anim|'''North America:''' Whether 'in' or 'out' is the applied state will depend on the truck – make sure that the animation matches the label on the valve or you will look like a goof.
==Gauge animations==The typical usage is for 'push to release' systems where the 0.0 state is 'in' and the 1.0 state is 'out'.|-|'''Europe:'''|-|flasher_4way_anim|Four-way flasher (hazard light) control|0 - rest position<br />1 - hazard lights are active|For a button, the &ldquo;depressed&rdquo; state would be 0.5 to make the button press and rebound for both activation and deactivation|-|engine_start_anim|Ignition and starting controls|0 - off<br />0.33 - electricity on<br />0.67 - engine on<br />1 - engine starting||-|beacon_anim|Beacon on/off switch|0 - beacon off1 - beacon on|-|trailer_air_stick_anim|Trailer air supply valve|0 - trailer disconnected1 - trailer connected|This is directly tied to whether a trailer is connected to the truck or not.
* oil_psi_anim - range in psi (pounds per square inch)Typical usage is for a 'push to supply' type, 40-90 psi so the valve is typical working value* water_temp_anim - 'out' in the 0.0 state and 'in' in celsius degrees, working value 90*Cthe 1.0 state* battery_anim |- in volts, working value 24V* oil_temp_anim - engine oil temperature, in celsius degrees, working value 90*C|trailer_brake_stick_anim* diff_temp_anim - differential temperature, in celsius degrees, working value 90*C|Trailer brake hand valve* tachometer_anim - in rpm (revolution per minutesometimes called the 'spike')* speedometer_anim |0 - rest position1 - speed in km/htrailer brake hand valve fully applied* air_psi_anim |Do not confuse this with the trailer supply valve - range in psi the hand valve is used (pounds per square inchrarely), working value 140 psito apply only the trailer brakes in a controlled manner* brake_psi_anim |- range is |retarder_stick_anim|Retarder control|0 to - off1, - maximum pressure value should be equivalent of 60setting||-|engine_brake_stick_anim|Engine brake control|0 -70 psioff* suspension_load_anim 1 - expects range maximum setting|''Added in newtons (22t trailer creates like 70kN on kingpin)1.38''* fuel_anim|-* ad_blue_anim|auto_transmission_stick_anim* turbo_anim|Automatic transmission gear selector* consumption_anim |0 - instant consumption in lreverse<br /100km, scania gauge has >0 to 120.5 - neutral<br />1 - drive|* clock_big_anim |- minutes, 0|lift_axle_stick_anim|Lift axle switch/control|||-60* clock_small_anim |differential_lock_stick_anim|Differential lock switch/control|0 - hours, 0disengaged<br />1 -12engaged* generic_anim - animation for other gauges|''Added in ETS2 1. 0 when truck is turned off, 27/ATS 1 when truck is turned on.6''|}
==Indicator =Gauge animations===This set of animationshandles analog gauges. The related '''*_min''' and '''*_max''' attributes set the values that the start and end of the animation correspond to. Where the simulated value exceeds the min/max attribute, the animation is clamped.{{Note|All '''*_psi_*''' attributes have been renamed to '''*_pressure_*''' as of ETS2 1.27/ATS 1.6. This is to reflect the change to ''bar'' (atmospheres) as the working pressure unit instead of ''psi''.}}{| class="wikitable"!Attribute Name!Function!Behavior!Notes|-|oil_pressure_anim|Engine oil pressure (bar)|0 - oil_pressure_anim_min1 - oil_pressure_anim_max|3-6 bars (43.5-87 psi) is typical working value|-|water_temp_anim|Engine water/coolant temperature (°C)|0 - water_temp_anim_min1 - water_temp_anim_max|working value 90°C|-|battery_anim|Battery potential (V)|0 - battery_anim_min1 - battery_anim_max|Nominally 24V. For 12V systems, set the min/max attributes to twice the value the gauge displays and it should appear as if it is indeed a 12V system.|-|oil_temp_anim|Engine oil temperature (°C)|0 - oil_temp_anim_min1 - oil_temp_anim_max|working value 90°C|-|exhaust_temp_anim|Exhaust gas temperature (°C)|0 - exhaust_temp_anim_min1 - exhaust_temp_anim_max|working range cca to 650°C|-|diff_temp_anim|Differential temperature (°C)|0 - diff_temp_anim_min1 - diff_temp_anim_max|working value 90°C|-|tachometer_anim|Tachometer in rpm (revolution per minute)|0 - tachometer_anim_min1 - tachometer_anim_max||-|speedometer_anim|Speedometer (km/h)|0 - speedometer_anim_min1 - speedometer_anim_max|1mph = 1.60934km/h|-|air_pressure_anim|Air brake reservoir pressure (bar)|0 - air_pressure_anim_min1 - air_pressure_anim_max||-|brake_pressure_anim|Air brake application (bar)|0 - brake_pressure_anim_min1 - brake_pressure_anim_max||-|general_air_press_anim|General air supply (bar)|0 - general_air_press_anim_min1 - general_air_press_anim_max||-|trailer_air_press_anim|Trailer air supply (bar)|0 - trailer_air_press_anim_min1 - trailer_air_press_anim_max||-|suspension_load_anim|Suspension load (newtons)|0 - suspension_load_anim_min1 - suspension_load_anim_max|expects range in newtons (22t trailer creates like 70kN on kingpin)|-|fuel_anim|Fuel gauge (relative to full)|0 - fuel_anim_min1 - fuel_anim_max|By default, 0 corresponds to empty state and 1 corresponds to full|-|ad_blue_anim|Ad Blue/DEF gauge (relative to full)|0 - fuel_anim_min1 - fuel_anim_max|By default, 0 corresponds to empty state and 1 corresponds to full|-|turbo_anim|Manifold pressure|||-|consumption_anim|Instantaneous fuel consumption in l/100km|0 - consumption_anim_min1 - consumption_anim_max|scania gauge has 0 to 120|-|clock_big_anim|Analog clock, minute hand (0-60)|0 - clock_big_anim_min (default 0)1 - clock_big_anim_max (default 60)||-|clock_small_anim|Analog clock, hour hand (0-12)|0 - clock_small_anim_min (default 0)1 - clock_small_anim_max (default 24)||-|generic_anim|Animation for other gauges. |0 when truck is turned off1 when truck is turned on||}
This ===Indicator animations are not interpolated from 0 to 1 rather they have only 2 states: switched off and switched on. So this animations should have only 2 key frames.===
* button_left_blinker* button_right_blinker* blinker_delay - this is These animations are not animationinterpolated from 0 to 1. Instead they have only 2 states: switched off (0) and switched on (1), but value describing length of half blinking loop* button_water_temp* indicator_oil_temp* indicator_position_lights* button_lights* button_high_beam_lights* indicator_aux_lights_front* indicator_aux_lights_roof* indicator_aux_lights_any* button_low_air_psi* button_low_oil_psi* button_battery_warning* button_low_fuel* indicator_low_adblue* button_jakebrake* button_parking_brake* button_4way - indicator so these animations should be placed on hazard warning button for blinking* indicator_retarder* indicator_warning - damage warning have only 2 key frames. All indicator* indicator_stop animations are triggered during the start- critical damage indicator* indicator_axle_lift - lifted axle indicator* indicator_cruise_control* indicator_generic - animation up electrical check, as well as for other indicator. 0 most of the time, 1 when truck is making electricity check (after turned on)their particular functions.
{| class="wikitable"!Attribute Name!Function!Behavior!Notes|-|button_left_blinker|Left turn signal indicator|rowspan="2"|Flashes on and off with left/right turn signal|rowspan="2"|The related attribute '''blinker_delay''' is describing length of the half blinking loop (in seconds)|-|button_right_blinker|Right turn signal indicator|-|button_water_temp|Water temperature warning light|On when engine temperature is excessive||-|indicator_oil_temp|Engine oil temperature warning light|On when engine oil temperature is excessive||-|indicator_position_lights|Position light indicator|On when positional/marker/parking lights are on||-|button_lights|Headlight indicator|On when headlights are on||-|button_high_beam_lights|Highbeam indicator|On when highbeam headlights are on||-|indicator_aux_lights_front|Front auxiliary lights indicator|On when ''front'' auxiliary lights are on||-|indicator_aux_lights_roof|Roof auxiliary lights indicator|On when ''roof'' auxiliary lights are on||-|indicator_aux_lights_any|Auxiliary lights indicator|On when any auxiliary lights are on||-|indicator_low_air_pressure|Low air pressure warning light|On when air pressure drops below cca 5 bars||-|indicator_low_oil_pressure|Low oil pressure warning light|On when engine oil pressure is low|This will also illuminate when the electrical is on and the engine is off|-|button_battery_warning|Low battery voltage warning light|On when battery voltage is low||-|button_low_fuel|Low fuel warning light|On when fuel level is low||-|indicator_low_adblue|Low AdBlue/DEF warning light|On when AdBlue/DEF level is low||-|button_jakebrake|Engine brake indicator light|On when engine brake (jake brake) is armed or active||-|button_parking_brake|Parking brake indicator light|On when parking brake is applied||-|button_4way|Four-way flasher status light|On when four-way flasher is on|Indicator should be placed on hazard warning button for blinking|-|indicator_retarder|Retarder status light|On when the retarder is active||-|indicator_warning|Damage warning indicator|On when damage is 15% or more||-|indicator_stop|Critical damage indicator|On when damage is 50% or more||-|indicator_axle_lift|Lift axle indicator|On when lift axle is up||-|indicator_cruise_control|Cruise control status light|On when cruise control is engaged||-|indicator_generic|Animation for other indicators|0 most of the time, 1 when truck is making electricity check (after turned on).||-|indicator_differential_lock|Differential lock status light|On when differential lock is engaged|''Added in ETS2 1.27/ATS 1.6''|-|indicator_trailer_axle_lift|Trailer lift axle status light|On when trailer axle(s) are raised.|''Added in ETS2 1.27/ATS 1.6''|-|indicator_weigh_green|(ATS) Weigh pass transponder green (bypass) light|On when the player may bypass an upcoming weigh station|''Added in ETS2 1.27/ATS 1.6''|-|indicator_weigh_red|(ATS) Weigh pass transponder red (no bypass) light|On when the player must enter an upcoming weigh station|''Added in ETS2 1.27/ATS 1.6''|} ==Dashboards IDs==
Screen of dashboard computers uses our UI library and shows thus UI elements. Each element has unique ID and can be used only once (due to caching). Most of fields can be used as two parameter template - value and unit, both are used accordingly to current game options. As in different languages can be units and other texts translated ensure that there are enough space for all of them.
===Screen IDs ( '''ui::group''' type):===
* 100 to 800 - basic screens, up to 8 screens
* 950 - shared screen (used together with all basic screens)
===Element IDs (mostly '''ui::text_common''' type):===
* 1000 - ambient temperature
* 1020 - current speed
* 1030 - odometer, needs space for at least six digits
* 1040 - current gear, uses N, DA[number], R or R[number] for automatic and N, [number], R or R[number] for maualmanual or sequential* 1050 - current clock time in proper format, eg. "12:34 " (am/pm"is omitted)
* 1060 - remaining fuel in tank
* 1070 - ui::text for fuel bar, the text is cut left-to-right according to current fuel tank state* 1075 - ui::text that defines size, orientation and range of fuel bar(typical data "H~~0~~1", horizontal range 0 to 1)
* 1080 - guessed operating range of vehicle
* 1090 - water temperature
* 1100 - cruise control speed value
* 1110 - ui::text for oil pressure bar, the text is cut according to current oil pressure
* 1115 - ui::text that defines size, orientation and range of oil pressure bar (typical data "H~~0~~1168", horizontal range 0psi 0bar to 8bar (116psi (8bar))
* 1120 - ui::text for air pressure bar, the text is cut according to current air pressure
* 1125 - ui::text that defines size, orientation and range of air pressure bar (typical data "H~~0~~17412", horizontal range 0psi 0bar to 12bar (174psi (12bar))
* 1130 - ui::text for turbo pressure bar, the text is cut according to current oil pressure
* 1135 - ui::text that defines size, orientation and range of turbo pressure bar (typical data "H~~0~~1", horizontal range 0 to 1)
* 1140 - ui::text for adblue bar, the text is cut according to current adblue tank state
* 1145 - ui::text that defines size, orientation and range of adblue bar(typical data "H~~0~~1", horizontal range 0 to 1)
* 1150 - ui::text for water temperature bar, the text is cut according to current water temperature
* 1155 - ui::text that defines size, orientation and range of water temperature bar (typical data "H~~0~~130", horizontal range 0*C 0°C to 130*C130°C (32°F to 266°F))
* 1160 - instant consumption
* 1170 - average (trip) consumption
* 1220 - compass, displays strings like "N", "E", "SW".
* 1230 - engine brake icon
* 1240 - cruise control icon, can be ui::group or ui::text or any other element that could show/hide. Cruise control speed ( id 1100) explicitly CAN be child of this group.
* 1250 - cruise control memory icon, can be ui::group or ui::text or any other element that could show/hide.
* 1260 - low air pressure warning icon
* 1270 - parking brake indicator icon
* 1280 - engine running time
* 1290 - retarder icon
* 1300 - transmission gear (raw, without mode info)
* 1310 - transmission mode (without gear info, A/M)
* 1320 - battery voltage
* 1330 - battery voltage gauge, expected to be ui_gauge element type
* 1340 - oil temperature gauge, expected to be ui_gauge element type
* 1350 - ui::text for instant fuel economy bar, the text is cut according to current value
* 1355 - ui::text that defines size, orientation and range of instant fuel economy bar (typical data "H~~0~~5", horizontal range 0 to 5 km/l (11.8mpg))
* 1360 - ui::text for average fuel economy bar, the text is cut according to current value
* 1365 - ui::text that defines size, orientation and range of average fuel economy bar (typical data "H~~0~~5", horizontal range 0 to 5 km/l (11.8mpg))
* 1370 - air pressure value (psi only)
* 1380 - transmission mode, detailed (D/N/R/M)
Data for bars are entered in format "H~~0~~130", H means the bar is horizontal (or V for vertical), leftmost position represents value 0, rightmost position represents value 130. Empty text defaults to "H~~0~~1".
506
edits

Navigation menu