Paradise Station 13 - Modules - TypesVar Details - Proc Details

title

Vars

current_title_screenCurrently set title screen
title_images_poolThe list of image files available to be picked for title screen

Procs

fill_title_images_poolIterates over all files in TITLE_SCREENS_LOCATION and loads all valid title screens to title_screens var.
get_title_htmlTries to read title html from config, if none found - backups to DEFAULT_TITLE_HTML
hide_title_screen_fromHide the title screen from specific client.
pick_title_imagePicks title image from title_images_pool list. If the list is empty, DEFAULT_TITLE_HTML is returned
set_noticeAdds a notice to the main title screen in the form of big red text!
set_title_htmlReplaces html of title screen
set_title_imageChanges title image to desired
show_title_screen_toShow the title screen to specific client.
show_title_screen_to_all_new_playersShow the title screen to all new players.
validate_filenameChecks wheter passed title is valid Currently validates extension and checks whether it's special image like default title screen etc.

Var Details

current_title_screen

Currently set title screen

title_images_pool

The list of image files available to be picked for title screen

Proc Details

fill_title_images_pool

Iterates over all files in TITLE_SCREENS_LOCATION and loads all valid title screens to title_screens var.

get_title_html

Tries to read title html from config, if none found - backups to DEFAULT_TITLE_HTML

hide_title_screen_from

Hide the title screen from specific client.

pick_title_image

Picks title image from title_images_pool list. If the list is empty, DEFAULT_TITLE_HTML is returned

set_notice

Adds a notice to the main title screen in the form of big red text!

set_title_html

Replaces html of title screen

set_title_image

Changes title image to desired

show_title_screen_to

Show the title screen to specific client.

show_title_screen_to_all_new_players

Show the title screen to all new players.

validate_filename

Checks wheter passed title is valid Currently validates extension and checks whether it's special image like default title screen etc.