script_gui.cpp File Reference

Window for configuring the Scripts More...

#include "../stdafx.h"
#include "../table/sprites.h"
#include "../error.h"
#include "../settings_gui.h"
#include "../querystring_gui.h"
#include "../stringfilter_type.h"
#include "../company_base.h"
#include "../company_gui.h"
#include "../dropdown_type.h"
#include "../dropdown_func.h"
#include "../window_func.h"
#include "../network/network.h"
#include "../hotkeys.h"
#include "../company_cmd.h"
#include "../misc_cmd.h"
#include "../timer/timer.h"
#include "../timer/timer_window.h"
#include "script_gui.h"
#include "script_log.hpp"
#include "script_scanner.hpp"
#include "script_config.hpp"
#include "../ai/ai.hpp"
#include "../ai/ai_config.hpp"
#include "../ai/ai_info.hpp"
#include "../ai/ai_instance.hpp"
#include "../game/game.hpp"
#include "../game/game_config.hpp"
#include "../game/game_info.hpp"
#include "../game/game_instance.hpp"
#include "table/strings.h"
#include "../safeguards.h"

Go to the source code of this file.

Data Structures
struct	ScriptListWindow
	Window that let you choose an available Script. More...
struct	ScriptSettingsWindow
	Window for settings the parameters of an AI. More...
struct	ScriptTextfileWindow
	Window for displaying the textfile of a AI. More...
struct	ScriptDebugWindow
	Window with everything an AI prints via ScriptLog. More...
struct	ScriptDebugWindow::FilterState

Functions
static ScriptConfig *	GetConfig (CompanyID slot)
void	ShowScriptListWindow (CompanyID slot, bool show_all)
	Open the Script list window to chose a script for the given company slot.
void	ShowScriptSettingsWindow (CompanyID slot)
	Open the Script settings window to change the Script settings for a Script.
void	ShowScriptTextfileWindow (TextfileType file_type, CompanyID slot)
	Open the Script version of the textfile window.
static bool	SetScriptButtonColour (NWidgetCore &button, bool dead, bool paused)
	Set the widget colour of a button based on the state of the script.
std::unique_ptr< NWidgetBase >	MakeCompanyButtonRowsScriptDebug ()
	Make a number of rows with buttons for each company for the Script debug window.
Window *	ShowScriptDebugWindow (CompanyID show_company, bool new_window)
	Open the Script debug window and select the given company.
void	InitializeScriptGui ()
	Reset the Script windows to their initial state.
void	ShowScriptDebugWindowIfScriptError ()
	Open the AI debug window if one of the AI scripts has crashed.

Variables
static constexpr NWidgetPart	_nested_script_list_widgets []
	Widgets for the AI list window.
static WindowDesc	_script_list_desc (WDP_CENTER, "settings_script_list", 200, 234, WC_SCRIPT_LIST, WC_NONE, 0, _nested_script_list_widgets)
	Window definition for the ai list window.
static constexpr NWidgetPart	_nested_script_settings_widgets []
	Widgets for the Script settings window.
static WindowDesc	_script_settings_desc (WDP_CENTER, "settings_script", 500, 208, WC_SCRIPT_SETTINGS, WC_NONE, 0, _nested_script_settings_widgets)
	Window definition for the Script settings window.
static constexpr NWidgetPart	_nested_script_debug_widgets []
	Widgets for the Script debug window.
static WindowDesc	_script_debug_desc (WDP_AUTO, "script_debug", 600, 450, WC_SCRIPT_DEBUG, WC_NONE, 0, _nested_script_debug_widgets, &ScriptDebugWindow::hotkeys)
	Window definition for the Script debug window.

Detailed Description

Window for configuring the Scripts

Definition in file script_gui.cpp.

Function Documentation

GetConfig()

static ScriptConfig * GetConfig ( CompanyID  slot )

static

Definition at line 45 of file script_gui.cpp.

InitializeScriptGui()

void InitializeScriptGui

(

)

Reset the Script windows to their initial state.

Definition at line 1337 of file script_gui.cpp.

References INVALID_COMPANY, and ScriptDebugWindow::FilterState::script_debug_company.

MakeCompanyButtonRowsScriptDebug()

std::unique_ptr< NWidgetBase > MakeCompanyButtonRowsScriptDebug

(

)

Make a number of rows with buttons for each company for the Script debug window.

Definition at line 1236 of file script_gui.cpp.

References MakeCompanyButtonRows(), WID_SCRD_COMPANY_BUTTON_END, and WID_SCRD_COMPANY_BUTTON_START.

SetScriptButtonColour()

static bool SetScriptButtonColour ( NWidgetCore &  button, bool  dead, bool  paused  )

static

Set the widget colour of a button based on the state of the script.

(dead or alive)

Parameters

button	the button to update.
dead	true if the script is dead, otherwise false.
paused	true if the script is paused, otherwise false.

Returns

true if the colour was changed and the window need to be marked as dirty.

Definition at line 676 of file script_gui.cpp.

References NWidgetCore::colour.

Referenced by ScriptDebugWindow::UpdateAIButtonsState(), and ScriptDebugWindow::UpdateGSButtonState().

ShowScriptDebugWindow()

Window * ShowScriptDebugWindow	(	CompanyID	show_company,
		bool	new_window
	)

Open the Script debug window and select the given company.

Parameters

show_company	Display debug information about this AI company.
new_window	Show in new window instead of existing window.

Definition at line 1303 of file script_gui.cpp.

References _network_server, _networking, _script_debug_desc, BringWindowToFrontById(), ScriptDebugWindow::ChangeToScript(), FindWindowByClass(), FindWindowById(), INVALID_STRING_ID, ScriptDebugWindow::FilterState::script_debug_company, ShowErrorMessage(), WC_SCRIPT_DEBUG, Window::window_class, Window::window_number, and WL_INFO.

Referenced by ScriptDebugWindow::ChangeToScript(), AIInstance::Died(), GameInstance::Died(), MenuClickHelp(), MainToolbarWindow::OnHotkey(), ScriptDebugWindow::ScriptDebugGlobalHotkeys(), and ShowScriptDebugWindowIfScriptError().

ShowScriptDebugWindowIfScriptError()

void ShowScriptDebugWindowIfScriptError

(

)

Open the AI debug window if one of the AI scripts has crashed.

Definition at line 1343 of file script_gui.cpp.

References _network_server, _networking, Game::GetGameInstance(), ScriptInstance::IsDead(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Iterate(), OWNER_DEITY, and ShowScriptDebugWindow().

Referenced by StartScripts().

ShowScriptListWindow()

void ShowScriptListWindow	(	CompanyID	slot,
		bool	show_all
	)

Open the Script list window to chose a script for the given company slot.

Parameters

slot	The slot to change the script of.
show_all	Whether to show all available versions.

Definition at line 277 of file script_gui.cpp.

References _script_list_desc, CloseWindowByClass(), and WC_SCRIPT_LIST.

Referenced by AIConfigWindow::OnClick(), and GSConfigWindow::OnClick().

ShowScriptSettingsWindow()

void ShowScriptSettingsWindow

(

CompanyID

slot

)

Open the Script settings window to change the Script settings for a Script.

Parameters

slot	The CompanyID of the Script to change the settings.

Definition at line 619 of file script_gui.cpp.

References _script_settings_desc, CloseWindowByClass(), WC_SCRIPT_LIST, and WC_SCRIPT_SETTINGS.

Referenced by AIConfigWindow::OnClick(), and ScriptDebugWindow::OnClick().

ShowScriptTextfileWindow()

void ShowScriptTextfileWindow	(	TextfileType	file_type,
		CompanyID	slot
	)

Open the Script version of the textfile window.

Parameters

file_type	The type of textfile to display.
slot	The slot the Script is using.

Definition at line 661 of file script_gui.cpp.

References CloseWindowById(), and WC_TEXTFILE.

Referenced by AIConfigWindow::OnClick(), and GSConfigWindow::OnClick().

Variable Documentation

_nested_script_debug_widgets

constexpr NWidgetPart _nested_script_debug_widgets[]

staticconstexpr

Widgets for the Script debug window.

Definition at line 1242 of file script_gui.cpp.

_nested_script_list_widgets

constexpr NWidgetPart _nested_script_list_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
    NWidget(WWT_CAPTION, COLOUR_MAUVE, WID_SCRL_CAPTION), SetDataTip(STR_AI_LIST_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_SCRL_LIST), SetMinimalSize(188, 112), SetFill(1, 1), SetResize(1, 1), SetMatrixDataTip(1, 0, STR_AI_LIST_TOOLTIP), SetScrollbar(WID_SCRL_SCROLLBAR),
    NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_SCRL_SCROLLBAR),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_MAUVE, WID_SCRL_INFO_BG), SetMinimalTextLines(8, WidgetDimensions::unscaled.framerect.Vertical() + WidgetDimensions::unscaled.vsep_normal * 3), SetResize(1, 0),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
      NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRL_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_LIST_ACCEPT, STR_AI_LIST_ACCEPT_TOOLTIP),
      NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRL_CANCEL), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_LIST_CANCEL, STR_AI_LIST_CANCEL_TOOLTIP),
    EndContainer(),
    NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
  EndContainer(),
}

Widgets for the AI list window.

Definition at line 243 of file script_gui.cpp.

_nested_script_settings_widgets

constexpr NWidgetPart _nested_script_settings_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
    NWidget(WWT_CAPTION, COLOUR_MAUVE, WID_SCRS_CAPTION), SetDataTip(STR_AI_SETTINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_MATRIX, COLOUR_MAUVE, WID_SCRS_BACKGROUND), SetMinimalSize(188, 182), SetResize(1, 1), SetFill(1, 0), SetMatrixDataTip(1, 0, STR_NULL), SetScrollbar(WID_SCRS_SCROLLBAR),
    NWidget(NWID_VSCROLLBAR, COLOUR_MAUVE, WID_SCRS_SCROLLBAR),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
      NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRS_ACCEPT), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_SETTINGS_CLOSE, STR_NULL),
      NWidget(WWT_PUSHTXTBTN, COLOUR_MAUVE, WID_SCRS_RESET), SetResize(1, 0), SetFill(1, 0), SetDataTip(STR_AI_SETTINGS_RESET, STR_NULL),
    EndContainer(),
    NWidget(WWT_RESIZEBOX, COLOUR_MAUVE),
  EndContainer(),
}

Widgets for the Script settings window.

Definition at line 588 of file script_gui.cpp.