Tips

Tip system

There are several ways to add tips to your interior, however, here I will write only about the most up-to-date and recommended one. All actions are done in the interior metadata file (the main file of your interior in lua/tardis/interiors folder)

Adding part tips (the tips related to specific parts, highlighted with control sequences etc.)

Add a new section called PartTips for interior parameters (inside section T.Interior, alongside Parts = {...}, Controls = {...}, ...)

Add the tips like:

PartTips = {
    <part1_name> = <tip1_params>,
    <part2_name> = <tip2_params>,
    ...
},

<tipX_params> are specified like this:

    { pos = Vector(<tip_coords>), right = <true/false>, down = <true/false>, }

right and down options specify the direction, in which the tip is drawn (right = false, down = true means "left and down")

If the part has the control name configured (see previous post), the text of the tip is automatically added and you don't need to specify anything else If the part has no control name configured, but you want a standard tip text, you can add control = "<control_name>", to <tipX_params> Otherwise, or if you want to change the text of the tip, you should add text = "<tip_text>", to <tipX_params>

Examples:

Parts = {
    ...
    default_throttle = "teleport",
    ...
}, 
...
PartTips = {
    default_throttle     = {pos = Vector(-8.87, -50, 5.5),     right = false, down = true,},
    default_typewriter   = {pos = Vector(19, 48.80, 2.07)      right = false, down = true, control = "coordinates" },
    default_dematcircuit = {pos = Vector(-43.16, -31.01, 4.7), right = true,  down = true, text = "Dematerialisation Circuit" },
}

Adding custom tips (the tips which aren't connected to any of the parts)

If tip isn't related to a part, you need to add a new section called CustomTips for interior parameters (inside section T.Interior, alongside Parts = {...}, Controls = {...}, ...)

Adding of the tips is the same, but you always need to specify the tip text

Example:

Parts = {...}, ...
CustomTips = {
    {pos = Vector(8.8, 5, 5.5), right = false, down = true, text = "Nothing to see here, it's just air", },
    ...
}

(Optional) Configure tip settings

There are default values for settings, so you don't need to specify those If you want to, add a new section called TipSettings for interior parameters (inside section T.Interior, alongside Parts = {...}, Controls = {...}, ...)

There are currently three tip settings. Example:

TipSettings={
    style="white_on_grey",
    view_range_min=70,
    view_range_max=100,
},

IMPORTANT: if you have tip settings specified in Tips={...} section, you should change it This way of adding tips WILL NOT be supported in the future updates