Functions Reference

Functions Reference

Write an intro for this page above the generated block.

Function	Description
TARDIS:AddButtonOption(data: tardis_setting)	-
TARDIS:AddControl(control: tardis_control)	-
TARDIS:AddControlSequence(cseq: tardis_sequence)	-
TARDIS:AddCustomMusic(name: string, url: string)	-
TARDIS:AddCustomVersion(main_id: string, version_id: string, version: tardis_version_entry)	-
TARDIS:AddExterior(exterior: tardis_exterior_metadata)	-
TARDIS:AddGUITheme(theme: tardis_gui_theme)	-
TARDIS:AddIconPack(iconpack: tardis_icon_pack)	-
TARDIS:AddInterior(interior: tardis_metadata)	-
TARDIS:AddInteriorTemplate(id: string, template: tardis_metadata)	-
TARDIS:AddKeyBind(id: string, data: table)	-
TARDIS:AddKeyBind(id: string, data: table)	-
TARDIS:AddLanguage(language: tardis_language)	-
TARDIS:AddLanguageExtension(extension: tardis_language_extension)	-
TARDIS:AddLocation(pos: Vector, ang: Angle, name: string, map: string)	-
TARDIS:AddMigration(name: string, date: string, func: fun(self: TARDIS))	-
TARDIS:AddPart(part: gmod_tardis_part)	-
TARDIS:AddScreen(name: string, options: tardis_screen_options, func: fun(self: TARDIS, ext: gmod_tardis, int: gmod_tardis_interior, frame: tardis_screen_frame, screen: TardisScreen))	-
TARDIS:AddSetting(data: tardis_setting)	-
TARDIS:AddTipStyle(style: tardis_tip)	-
TARDIS:CheckPP(ply: Player, ent: Entity) -> boolean?	Prop Protection
TARDIS:Control(control_id: string, ply: Player, part: gmod_tardis_part?)	-
TARDIS:CopyTable(tbl: T, lookup_table: table?) -> T	a modified version of table.Copy() to deal with Vectors / Angles / ...
TARDIS:CreateExteriorMetadata(id: string) -> tardis_exterior_metadata	-
TARDIS:CreateScreenFont(name: string, font: tardis_screen_font)	-
TARDIS:ErrorMessage(ply: Player, message: string, ...)	-
TARDIS:GetBind(id: string) -> table?	-
TARDIS:GetBindKey(id: string) -> BUTTON_CODE?	-
TARDIS:GetBinds() -> { [string] = table? }	-
TARDIS:GetBuildString() -> string	-
TARDIS:GetControl(id: string, ent: (gmod_tardis|gmod_tardis_interior)?) -> tardis_control?	-
TARDIS:GetControls() -> table<string,tardis_control>	-
TARDIS:GetControlSequence(id: string) -> tardis_sequence?	-
TARDIS:GetCurrentEvent(ent: (Player|gmod_tardis)?, autoonly: boolean?) -> integer?	-
TARDIS:GetCustomSetting(int_id: string, setting_id: string, ent: Entity?, default_val: any)	-
TARDIS:GetCustomSettings(ent: Entity?) -> table<string,table<string,any>>	-
TARDIS:GetEventName(event: integer?, id: boolean?) -> string?	-
TARDIS:GetExteriorCategories() -> { [string] = { [string] = true } }	-
TARDIS:GetExteriorEnt(ply: Player?) -> gmod_tardis?	-
TARDIS:GetExteriorEnts(ply: Player?) -> gmod_tardis[]	-
TARDIS:GetExteriorIcon(id: string, config_override: table?) -> string?	-
TARDIS:GetExteriors() -> table<string,table>	-
TARDIS:GetGUITheme(id: string) -> tardis_gui_theme?	-
TARDIS:GetGUIThemeElement(theme_id: (string|table), section: string, element: string?, no_defaults: boolean?) -> string?	-
TARDIS:GetGUIThemes() -> table<string,tardis_gui_theme>	-
TARDIS:GetIcon(category: string, id: string, config_override: table?) -> string?	-
TARDIS:GetIconPack(id: string) -> tardis_icon_pack?	-
TARDIS:GetIconPacks() -> table<string,tardis_icon_pack>	-
TARDIS:GetInterior(id: string) -> tardis_metadata?	-
TARDIS:GetInteriorEnt(ply: Player?) -> gmod_tardis_interior?	-
TARDIS:GetInteriorEnts(ply: Player?) -> gmod_tardis_interior[]	-
TARDIS:GetInteriorIcon(id: string, config_override: table?) -> string?	-
TARDIS:GetInteriors() -> table<string,tardis_metadata>	-
TARDIS:GetKeyName(key: BUTTON_CODE?) -> string?	-
TARDIS:GetLanguage() -> string	-
TARDIS:GetLanguages() -> { [string] = { Name = string, Base = string?, Extends = string?, Phrases = table<string,string>, ... }, ... }	-
TARDIS:GetLocalPos(ent: Entity, ply: Player?) -> Vector?, Angle?	-
TARDIS:GetMainVersionId(int_id: string?) -> string?	-
TARDIS:GetMissingIcon(category: string, config_override: table?) -> string?	-
TARDIS:GetPart(ent: Entity, id: string) -> gmod_tardis_part	-
TARDIS:GetParts(ent: Entity) -> (false|table<string,gmod_tardis_part>)?	-
TARDIS:GetPhrase(phrase: string?, ...) -> string	-
TARDIS:GetPhraseIfExists(phrase: string?, ...) -> string?	-
TARDIS:GetScreenFont(screen: TardisScreen, name: string) -> string	-
TARDIS:GetSetting(id: string, src: Entity?, no_default: boolean?)	-
TARDIS:GetSettingData(id: string) -> tardis_setting	-
TARDIS:GetSettingsData() -> table<string,tardis_setting>	-
TARDIS:GetSpawnIcon(id: string, config_override: table?) -> string?	-
TARDIS:GetTARDISName(metadata: tardis_metadata) -> string	-
TARDIS:GetTipStyle(id: string) -> tardis_tip	-
TARDIS:GetTipStyles() -> table<string,tardis_tip>	-
TARDIS:GetVersion() -> tardis_version	-
TARDIS:GetVersionString(version: tardis_version?) -> string	-
TARDIS:HUDScreen(window: Panel?)	-
TARDIS:ImportExterior(int_id: string, import_options: table?) -> boolean	supported import_options: ext_id base name category modify_func
TARDIS:IsBindDown(id: string) -> boolean?	-
TARDIS:IsBindDown(ply: Player, id: string) -> boolean?	-
TARDIS:IsFavoriteInt(id: string, ent: Entity?) -> boolean	-
TARDIS:IsSonicInstalled() -> boolean	-
TARDIS:LoadFolder(folder: string?, addonly: boolean?, noprefix: boolean?)	-
TARDIS:Message(ply: Player, message: string, ...)	-
TARDIS:NewControl() -> tardis_control	Functionally identical to {} but gives proper type checking for controls
TARDIS:NewControlSequence() -> tardis_sequence	Functionally identical to {} but gives proper type checking for control sequences
TARDIS:NewExterior() -> tardis_exterior_metadata	Functionally identical to E = {} but gives proper type checking for exteriors
TARDIS:NewGUITheme() -> tardis_gui_theme	Functionally identical to {} but gives proper type checking for GUI themes
TARDIS:NewIconPack() -> tardis_icon_pack	Functionally identical to {} but gives proper type checking for icon packs
TARDIS:NewInterior() -> tardis_metadata	Functionally identical to T = {} but gives proper type checking for interiors
TARDIS:NewInteriorTemplate(def: table) -> tardis_metadata	Types a partial template literal as tardis_metadata without literal-checking it (templates are partial metadata merged into an interior on apply, so downstream .Interior/.Exterior access must resolve). Mirrors NewInterior.
TARDIS:NewLanguage() -> tardis_language	Functionally identical to {} but gives proper type checking for languages
TARDIS:NewPart() -> gmod_tardis_part	Functionally identical to PART = {} but gives proper type checking for parts
TARDIS:NewTipStyle() -> tardis_tip	Functionally identical to {} but gives proper type checking for tip styles
TARDIS:PhraseExists(phrase: string?) -> boolean	-
TARDIS:PopToScreen(name: string, ply: Player?)	-
TARDIS:RemoveControl(id: string)	-
TARDIS:RemoveCustomMusic(index: integer)	-
TARDIS:RemoveHUDScreen()	-
TARDIS:RemoveKeyBind(id: string)	-
TARDIS:RemoveKeyBind(id: string)	-
TARDIS:RemoveLocation(map: string, index: integer)	-
TARDIS:RemoveTipStyle(id: string)	-
TARDIS:ResetCustomSettings(int_id: string?)	-
TARDIS:ScreenActive(name: string) -> TardisScreen[]?	-
TARDIS:SelectDoorVersionID(id: (string|tardis_version_entry), ent: Entity?) -> string?	-
TARDIS:SelectNewRandomInterior(current: string?, ent: Entity?) -> string?	-
TARDIS:SelectSpawnID(id: string, ent: Entity?) -> string?	-
TARDIS:SetCustomSetting(int_id: string, setting_id: string, value: any)	-
TARDIS:SetFavoriteInt(id: string, favorite: boolean)	-
TARDIS:SetKeyBind(id: string, key: integer)	-
TARDIS:SetSetting(id: string, value: any, ignore_convar: boolean?)	-
TARDIS:ShouldUseClassicDoors(ent: Entity?) -> boolean	-
TARDIS:SkipEvent()	-
TARDIS:SpawnByID(id: string)	-
TARDIS:SpawnTARDIS(ply: Player, customData: table, force: boolean?) -> gmod_tardis?	-
TARDIS:StatusMessage(ply: Player, name: string, condition: boolean, enabled_msg: string?, disabled_msg: string?)	-
TARDIS:ToggleCustomSetting(int_id: string, setting_id: string)	-
TARDIS:ToggleFavoriteInt(id: string)	-
TARDIS:TogglePart(part: gmod_tardis_part)	-
TARDIS:UpdateLanguage()	-