JCM:PIDS Preset

2024-02-27T20:45:16Z

Endrouze: Update link of the exemple pack

'''Joban PIDS''' refers to a series of '''Passenger Information Display System''' blocks that supports customization currently not present on the PIDS of the main MTR Mod'''.'''

These class has support for '''PIDS Variable''' and '''PIDS Preset. The following block supports these features:'''

* [[JCM:Old Tsueng Kwan O Line PIDS|Old Tsueng Kwan O Line PIDS]]

* [[JCM:Railway Vision PIDS|Railway Vision PIDS]]

* [[JCM:Railway Vision PIDS (SIL 1)|Railway Vision PIDS (SIL 1)]]

* [[JCM:Railway Vision PIDS (SIL 2)|Railway Vision PIDS (SIL 2)]]

=== Block Entity Data ===
{| class="wikitable"
|+
!Name
!Type
!Description
|-
| colspan="3" |All MTR Mod PIDS Properties
|-
|preset_id
|String
|The string of the Preset ID
|}

=== PIDS Preset ===
A PIDS preset is like a collection of configurations for the PIDS, things you can change including:

* Visibility of Weather/Time (RV PIDS Only)
* Font used
* Font Color
* Background Images
* Hide arrival override (Since [[JCM:1.1.5|v1.1.5]])
* Push arrival down even without hiding the arrivals (Since [[JCM:1.1.5|v1.1.5]])
*Colors for different cars (Since [[JCM:1.2.2|v1.2.2]])
For more detail of the implementation, you may download the [https://www.joban.org/JCM/1.1.5/Joban_Custom_Resources.zip Example Pack] to learn more.

==== Cars Color ====
You may now specify the color for the car display by adding a <code>carLengthColor</code> array for each preset, for example:

<code>"carLengthColor": [null, "00FFFF", "FF00FF"]</code>

This means:

* No color change for the 1st car
* Use color #00FFFF if the train is 2-car long
* Use color #FF00FF if the train is 3-car long
* No color change for other car length.

=== PIDS Variable (v1 only) ===
'''Note: PIDS Variable has been deprecated and removed in v2.0.0'''

A variable is like a placeholder, you can put a text formatted in a specific way, and that text will be replaced with something else (e.g. a dynamic value).
{| class="wikitable"
|+List of variables
!Variable Name
!Description
!Version Added
|-
|<code>{weather}</code>
|The weather of the current world, possible values are:
"Sunny", "Raining", "Thundering"
|v1.1.2
|-
|<code>{time}</code>
|The current world time, returns "HH:MM"
|v1.1.2
|-
|<code>{time_period}</code>
|The current time period, possible values are:
"Morning", "Afternoon", "Night"
|v1.1.2
|-
|<code>{weatherChin}</code>
|The weather of the current world in chinese.
Possible values are: "晴天", "下雨", "雷暴"
|v1.1.4
|-
|<code>{worldPlayer}</code>
|Current amount of player on the current world
|v1.1.4
|-
|<code>{day}</code>
|The day elapsed (Same as the one shown in F3 Screen)
|v1.1.5
|}
Simply put the '''Variable Name''' mentioned above in your PIDS as custom text, and it will work.

Joban Wiki - User contributions [en]

JCM:PIDS Preset