‪TechbloxModdingAPI  ‪v2.2.0
‪The unofficial Techblox modding API
TechbloxModdingAPI.App.Client Class Reference

‪The Techblox application that is running this code right now. More...

Public Member Functions

void CloseCurrentPrompt ()
 
void PromptUser (Error popup)
 ‪Open a popup which prompts the user to click a button. This reuses Techblox's error dialog popup More...
 
void SelectFirstPromptButton ()
 
void SelectSecondPromptButton ()
 

Static Protected Attributes

static Action< object, Error > EnqueueError
 
static Func< object > ErrorHandlerInstanceGetter
 

Package Functions

void CloseBetaPopup ()
 

Static Package Functions

static void Init ()
 

Properties

bool InMenu [get]
 ‪Whether Techblox is in the Main Menu More...
 
static Client Instance = new Client() [get]
 
Game[] MyGames [get]
 Game saves currently visible in the menu. These take a second to completely populate after the EnterMenu event fires. More...
 
string UnityVersion [get]
 ‪Unity version string. More...
 
string Version [get]
 ‪Techblox build version string. Usually this is in the form YYYY.mm.DD.HH.MM.SS More...
 

Events

static EventHandler< MenuEventArgsEnterMenu [add, remove]
 ‪An event that fires whenever the main menu is loaded. More...
 
static EventHandler< MenuEventArgsExitMenu [add, remove]
 ‪An event that fire whenever the main menu is exited. More...
 

Detailed Description

The Techblox application that is running this code right now.

Member Function Documentation

◆ CloseBetaPopup()

void TechbloxModdingAPI.App.Client.CloseBetaPopup ( )
inlinepackage

◆ CloseCurrentPrompt()

void TechbloxModdingAPI.App.Client.CloseCurrentPrompt ( )
inline

◆ Init()

static void TechbloxModdingAPI.App.Client.Init ( )
inlinestaticpackage

◆ PromptUser()

void TechbloxModdingAPI.App.Client.PromptUser ( Error  popup)
inline

‪Open a popup which prompts the user to click a button. This reuses Techblox's error dialog popup

Parameters
popup‪The popup to display. Use an instance of SingleChoicePrompt or DualChoicePrompt.

◆ SelectFirstPromptButton()

void TechbloxModdingAPI.App.Client.SelectFirstPromptButton ( )
inline

◆ SelectSecondPromptButton()

void TechbloxModdingAPI.App.Client.SelectSecondPromptButton ( )
inline

Member Data Documentation

◆ EnqueueError

Action<object, Error> TechbloxModdingAPI.App.Client.EnqueueError
staticprotected

◆ ErrorHandlerInstanceGetter

Func<object> TechbloxModdingAPI.App.Client.ErrorHandlerInstanceGetter
staticprotected

Property Documentation

◆ InMenu

bool TechbloxModdingAPI.App.Client.InMenu
get

‪Whether Techblox is in the Main Menu

true if in menu; false when loading or in a game.

◆ Instance

Client TechbloxModdingAPI.App.Client.Instance = new Client()
staticget

◆ MyGames

Game [] TechbloxModdingAPI.App.Client.MyGames
get

Game saves currently visible in the menu. These take a second to completely populate after the EnterMenu event fires.

My games.

◆ UnityVersion

string TechbloxModdingAPI.App.Client.UnityVersion
get

‪Unity version string.

The unity version.

◆ Version

string TechbloxModdingAPI.App.Client.Version
get

‪Techblox build version string. Usually this is in the form YYYY.mm.DD.HH.MM.SS

The version.

Event Documentation

◆ EnterMenu

EventHandler< MenuEventArgs> TechbloxModdingAPI.App.Client.EnterMenu
staticaddremove

‪An event that fires whenever the main menu is loaded.

◆ ExitMenu

EventHandler< MenuEventArgs> TechbloxModdingAPI.App.Client.ExitMenu
staticaddremove

‪An event that fire whenever the main menu is exited.


The documentation for this class was generated from the following file: