OpenTTD Source 20241224-master-gf74b0cf984
ScriptDebugWindow Struct Reference

Window with everything an AI prints via ScriptLog. More...

Inheritance diagram for ScriptDebugWindow:
Window ZeroedMemoryAllocator

Data Structures

struct  FilterState
 

Public Member Functions

ScriptLogTypes::LogData & GetLogData () const
 
bool IsDead () const
 Check whether the currently selected AI/GS is dead.
 
bool IsValidDebugCompany (CompanyID company) const
 Check whether a company is a valid AI company or GS.
 
void SelectValidDebugCompany ()
 Ensure that script_debug_company refers to a valid AI company or GS, or is set to INVALID_COMPANY.
 
 ScriptDebugWindow (WindowDesc &desc, WindowNumber number, Owner show_company)
 Constructor for the window.
 
void OnInit () override
 Notification that the nested widget tree gets initialized.
 
void UpdateWidgetSize (WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
 Update size and resize step of a widget in the window.
 
void OnPaint () override
 The window must be repainted.
 
void SetStringParameters (WidgetID widget) const override
 Initialize string parameters for a widget.
 
void DrawWidget (const Rect &r, WidgetID widget) const override
 Draw the contents of a nested widget.
 
void DrawWidgetCompanyButton (const Rect &r, WidgetID widget, int start) const
 Draw a company button icon.
 
void DrawWidgetLog (const Rect &r) const
 Draw the AI/GS log.
 
void UpdateLogScroll ()
 Update the scrollbar and scroll position of the log panel.
 
void UpdateAIButtonsState ()
 Update state of all Company (AI) buttons.
 
void UpdateGSButtonState ()
 Update state of game script button.
 
void ChangeToScript (CompanyID show_script, bool new_window=false)
 Change all settings to select another Script.
 
void OnClick (Point pt, WidgetID widget, int click_count) override
 A click with the left mouse button has been made on the window.
 
void OnEditboxChanged (WidgetID wid) override
 The text in an editbox has been edited.
 
void OnInvalidateData (int data=0, bool gui_scope=true) override
 Some data on this window has become invalid.
 
void OnResize () override
 Called after the window got resized.
 
- Public Member Functions inherited from Window
 Window (WindowDesc &desc)
 Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.
 
voidoperator new[] (size_t size)=delete
 Helper allocation function to disallow something.
 
template<class NWID >
const NWID * GetWidget (WidgetID widnum) const
 Get the nested widget with number widnum from the nested widget tree.
 
template<class NWID >
NWID * GetWidget (WidgetID widnum)
 Get the nested widget with number widnum from the nested widget tree.
 
const ScrollbarGetScrollbar (WidgetID widnum) const
 Return the Scrollbar to a widget index.
 
ScrollbarGetScrollbar (WidgetID widnum)
 Return the Scrollbar to a widget index.
 
const QueryStringGetQueryString (WidgetID widnum) const
 Return the querystring associated to a editbox.
 
QueryStringGetQueryString (WidgetID widnum)
 Return the querystring associated to a editbox.
 
void UpdateQueryStringSize ()
 Update size of all QueryStrings of this window.
 
virtual const struct TextbufGetFocusedTextbuf () const
 Get the current input text buffer.
 
virtual Point GetCaretPosition () const
 Get the current caret position if an edit box has the focus.
 
virtual Rect GetTextBoundingRect (const char *from, const char *to) const
 Get the bounding rectangle for a text range if an edit box has the focus.
 
virtual ptrdiff_t GetTextCharacterAtPosition (const Point &pt) const
 Get the character that is rendered at a position by the focused edit box.
 
void InitNested (WindowNumber number=0)
 Perform complete initialization of the Window with nested widgets, to allow use.
 
void CreateNestedTree ()
 Perform the first part of the initialization of a nested widget tree.
 
void FinishInitNested (WindowNumber window_number=0)
 Perform the second part of the initialization of a nested widget tree.
 
template<typename T , std::enable_if_t< std::is_base_of< StrongTypedefBase, T >::value, int > = 0>
void FinishInitNested (T number)
 
void SetTimeout ()
 Set the timeout flag of the window and initiate the timer.
 
void SetWhiteBorder ()
 Set the timeout flag of the window and initiate the timer.
 
void DisableAllWidgetHighlight ()
 Disable the highlighted status of all widgets.
 
void SetWidgetHighlight (WidgetID widget_index, TextColour highlighted_colour)
 Sets the highlighted status of a widget.
 
bool IsWidgetHighlighted (WidgetID widget_index) const
 Gets the highlighted status of a widget.
 
void SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
 Sets the enabled/disabled status of a widget.
 
void DisableWidget (WidgetID widget_index)
 Sets a widget to disabled.
 
void EnableWidget (WidgetID widget_index)
 Sets a widget to Enabled.
 
bool IsWidgetDisabled (WidgetID widget_index) const
 Gets the enabled/disabled status of a widget.
 
bool IsWidgetFocused (WidgetID widget_index) const
 Check if given widget is focused within this window.
 
bool IsWidgetGloballyFocused (WidgetID widget_index) const
 Check if given widget has user input focus.
 
void SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
 Sets the lowered/raised status of a widget.
 
void ToggleWidgetLoweredState (WidgetID widget_index)
 Invert the lowered/raised status of a widget.
 
void LowerWidget (WidgetID widget_index)
 Marks a widget as lowered.
 
void RaiseWidget (WidgetID widget_index)
 Marks a widget as raised.
 
void RaiseWidgetWhenLowered (WidgetID widget_index)
 Marks a widget as raised and dirty (redraw), when it is marked as lowered.
 
bool IsWidgetLowered (WidgetID widget_index) const
 Gets the lowered state of a widget.
 
void UnfocusFocusedWidget ()
 Makes no widget on this window have focus.
 
bool SetFocusedWidget (WidgetID widget_index)
 Set focus within this window to the given widget.
 
EventState HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
 Process keypress for editbox widget.
 
virtual void InsertTextString (WidgetID wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
 Insert a text string at the cursor position into the edit box widget.
 
void HandleButtonClick (WidgetID widget)
 Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
 
int GetRowFromWidget (int clickpos, WidgetID widget, int padding, int line_height=-1) const
 Compute the row of a widget that a user clicked in.
 
void RaiseButtons (bool autoraise=false)
 Raise the buttons of the window.
 
template<typename... Args>
void SetWidgetsDisabledState (bool disab_stat, Args... widgets)
 Sets the enabled/disabled status of a list of widgets.
 
template<typename... Args>
void SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
 Sets the lowered/raised status of a list of widgets.
 
template<typename... Args>
void RaiseWidgetsWhenLowered (Args... widgets)
 Raises the widgets and sets widgets dirty that are lowered.
 
void SetWidgetDirty (WidgetID widget_index) const
 Invalidate a widget, i.e.
 
void DrawWidgets () const
 Paint all widgets of a window.
 
void DrawViewport () const
 Draw the viewport of this window.
 
void DrawSortButtonState (WidgetID widget, SortButtonState state) const
 Draw a sort button's up or down arrow symbol.
 
WindowFindChildWindow (WindowClass wc=WC_INVALID) const
 Find the Window whose parent pointer points to this window.
 
void CloseChildWindows (WindowClass wc=WC_INVALID) const
 Close all children a window might have in a head-recursive manner.
 
virtual void Close (int data=0)
 Hide the window and all its child windows, and mark them for a later deletion.
 
void SetDirty () const
 Mark entire window as dirty (in need of re-paint)
 
void ReInit (int rx=0, int ry=0, bool reposition=false)
 Re-initialize a window, and optionally change its size.
 
bool IsShaded () const
 Is window shaded currently?
 
void SetShaded (bool make_shaded)
 Set the shaded state of the window to make_shaded.
 
void ScheduleResize ()
 Mark this window as resized and in need of OnResize() event.
 
void ProcessScheduledResize ()
 Process scheduled OnResize() event.
 
void InvalidateData (int data=0, bool gui_scope=true)
 Mark this window's data as invalid (in need of re-computing)
 
void ProcessScheduledInvalidations ()
 Process all scheduled invalidations.
 
void ProcessHighlightedInvalidations ()
 Process all invalidation of highlighted widgets.
 
virtual void ApplyDefaults ()
 Read default values from WindowDesc configuration an apply them to the window.
 
virtual Point OnInitialPosition (int16_t sm_width, int16_t sm_height, int window_number)
 Compute the initial position of the window.
 
virtual void OnFocus ()
 The window has gained focus.
 
virtual void OnFocusLost (bool closing)
 The window has lost focus.
 
virtual EventState OnKeyPress (char32_t key, uint16_t keycode)
 A key has been pressed.
 
virtual EventState OnHotkey (int hotkey)
 A hotkey has been pressed.
 
virtual EventState OnCTRLStateChange ()
 The state of the control key has changed.
 
virtual bool OnRightClick (Point pt, WidgetID widget)
 A click with the right mouse button has been made on the window.
 
virtual void OnHover (Point pt, WidgetID widget)
 The mouse is hovering over a widget in the window, perform an action for it.
 
virtual bool OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond)
 Event to display a custom tooltip.
 
virtual void OnMouseDrag (Point pt, WidgetID widget)
 An 'object' is being dragged at the provided position, highlight the target if possible.
 
virtual void OnDragDrop (Point pt, WidgetID widget)
 A dragged 'object' has been released.
 
virtual void OnScroll (Point delta)
 Handle the request for (viewport) scrolling.
 
virtual void OnMouseOver (Point pt, WidgetID widget)
 The mouse is currently moving over the window or has just moved outside of the window.
 
virtual void OnMouseWheel (int wheel)
 The mouse wheel has been turned.
 
virtual void OnMouseLoop ()
 Called for every mouse loop run, which is at least once per (game) tick.
 
virtual void OnGameTick ()
 Called once per (game) tick.
 
virtual void OnRealtimeTick (uint delta_ms)
 Called periodically.
 
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
 
virtual void OnDropdownSelect (WidgetID widget, int index)
 A dropdown option associated to this window has been selected.
 
virtual void OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
 A dropdown window associated to this window has been closed.
 
virtual void OnQueryTextFinished (std::optional< std::string > str)
 The query window opened from this window has closed.
 
virtual void OnPlaceObject (Point pt, TileIndex tile)
 The user clicked some place on the map when a tile highlight mode has been set.
 
virtual bool OnVehicleSelect (const struct Vehicle *v)
 The user clicked on a vehicle while HT_VEHICLE has been set.
 
virtual bool OnVehicleSelect (VehicleList::const_iterator begin, VehicleList::const_iterator end)
 The user clicked on a vehicle while HT_VEHICLE has been set.
 
virtual void OnPlaceObjectAbort ()
 The user cancelled a tile highlight mode that has been set.
 
virtual void OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
 The user is dragging over the map when the tile highlight mode has been set.
 
virtual void OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
 The user has dragged over the map when the tile highlight mode has been set.
 
virtual void OnPlacePresize (Point pt, TileIndex tile)
 The user moves over the map when a tile highlight mode has been set when the special mouse mode has been set to 'PRESIZE' mode.
 
virtual bool IsNewGRFInspectable () const
 Is the data related to this window NewGRF inspectable?
 
virtual void ShowNewGRFInspectWindow () const
 Show the NewGRF inspection window.
 
template<>
const NWidgetBaseGetWidget (WidgetID widnum) const
 Specialized case of Window::GetWidget for the nested widget base class.
 
- Public Member Functions inherited from ZeroedMemoryAllocator
void * operator new (size_t size)
 Memory allocator for a single class instance.
 
void * operator new[] (size_t size)
 Memory allocator for an array of class instances.
 
void operator delete (void *ptr)
 Memory release for a single class instance.
 
void operator delete[] (void *ptr)
 Memory release for an array of class instances.
 

Static Public Member Functions

static EventState ScriptDebugGlobalHotkeys (int hotkey)
 Handler for global hotkeys of the ScriptDebugWindow.
 
- Static Public Member Functions inherited from Window
static int SortButtonWidth ()
 Get width of up/down arrow of sort button state.
 
static void DeleteClosedWindows ()
 Delete all closed windows.
 

Data Fields

int redraw_timer
 Timer for redrawing the window, otherwise it'll happen every tick.
 
int last_vscroll_pos
 Last position of the scrolling.
 
bool autoscroll
 Whether automatically scrolling should be enabled or not.
 
bool show_break_box
 Whether the break/debug box is visible.
 
QueryString break_editbox
 Break editbox.
 
StringFilter break_string_filter
 Log filter for break.
 
int highlight_row
 The output row that matches the given string, or -1.
 
Scrollbarvscroll
 Cache of the vertical scrollbar.
 
Scrollbarhscroll
 Cache of the horizontal scrollbar.
 
FilterState filter
 
- Data Fields inherited from Window
WindowDescwindow_desc
 Window description.
 
WindowFlags flags
 Window flags.
 
WindowClass window_class
 Window class.
 
WindowNumber window_number
 Window number within the window class.
 
int scale
 Scale of this window – used to determine how to resize.
 
uint8_t timeout_timer
 Timer value of the WF_TIMEOUT for flags.
 
uint8_t white_border_timer
 Timer value of the WF_WHITE_BORDER for flags.
 
int left
 x position of left edge of the window
 
int top
 y position of top edge of the window
 
int width
 width of the window (number of pixels to the right in x direction)
 
int height
 Height of the window (number of pixels down in y direction)
 
ResizeInfo resize
 Resize information.
 
Owner owner
 The owner of the content shown in this window. Company colour is acquired from this variable.
 
ViewportDataviewport
 Pointer to viewport data, if present.
 
const NWidgetCorenested_focus
 Currently focused nested widget, or nullptr if no nested widget has focus.
 
std::map< WidgetID, QueryString * > querystrings
 QueryString associated to WWT_EDITBOX widgets.
 
std::unique_ptr< NWidgetBasenested_root
 Root of the nested tree.
 
WidgetLookup widget_lookup
 Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
 
NWidgetStackedshade_select
 Selection widget (NWID_SELECTION) to use for shading the window. If nullptr, window cannot shade.
 
Dimension unshaded_size
 Last known unshaded size (only valid while shaded).
 
WidgetID mouse_capture_widget
 ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
 
Windowparent
 Parent window.
 
WindowList::iterator z_position
 

Static Public Attributes

static const uint MAX_BREAK_STR_STRING_LENGTH = 256
 Maximum length of the break string.
 
static FilterState initial_state
 
static HotkeyList hotkeys
 

Additional Inherited Members

- Public Types inherited from Window
using IteratorToFront = WindowIterator< false >
 Iterate in Z order towards front.
 
using IteratorToBack = WindowIterator< true >
 Iterate in Z order towards back.
 
using Iterate = AllWindows< false >
 Iterate all windows in whatever order is easiest.
 
using IterateFromBack = AllWindows< false >
 Iterate all windows in Z order from back to front.
 
using IterateFromFront = AllWindows< true >
 Iterate all windows in Z order from front to back.
 
- Protected Member Functions inherited from Window
void InitializeData (WindowNumber window_number)
 Initializes the data (except the position and initial size) of a new Window.
 
void InitializePositionSize (int x, int y, int min_width, int min_height)
 Set the position and smallest size of the window.
 
virtual void FindWindowPlacementAndResize (int def_width, int def_height)
 Resize window towards the default size.
 
virtual ~Window ()
 Remove window and all its child windows from the window stack.
 
- Protected Attributes inherited from Window
std::vector< intscheduled_invalidation_data
 Data of scheduled OnInvalidateData() calls.
 
bool scheduled_resize
 Set if window has been resized.
 

Detailed Description

Window with everything an AI prints via ScriptLog.

Definition at line 692 of file script_gui.cpp.

Constructor & Destructor Documentation

◆ ScriptDebugWindow()

◆ ~ScriptDebugWindow()

ScriptDebugWindow::~ScriptDebugWindow ( )
inline

Definition at line 819 of file script_gui.cpp.

Member Function Documentation

◆ ChangeToScript()

void ScriptDebugWindow::ChangeToScript ( CompanyID  show_script,
bool  new_window = false 
)
inline

Change all settings to select another Script.

Parameters
show_aiThe new AI to show.
new_windowOpen the script in a new window.

Definition at line 1015 of file script_gui.cpp.

References CloseWindowByClass(), Scrollbar::GetPosition(), Window::GetWidget(), Window::InvalidateData(), IsValidDebugCompany(), ScriptDebugWindow::FilterState::script_debug_company, ShowScriptDebugWindow(), and WC_SCRIPT_SETTINGS.

Referenced by OnClick(), ScriptDebugWindow(), SelectValidDebugCompany(), and ShowScriptDebugWindow().

◆ DrawWidget()

void ScriptDebugWindow::DrawWidget ( const Rect r,
WidgetID  widget 
) const
inlineoverridevirtual

Draw the contents of a nested widget.

Parameters
rRectangle occupied by the widget.
widgetNumber of the widget to draw.
Note
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 862 of file script_gui.cpp.

References DrawWidgetCompanyButton(), DrawWidgetLog(), IsInsideBS(), MAX_COMPANIES, WID_SCRD_COMPANY_BUTTON_START, and WID_SCRD_LOG_PANEL.

◆ DrawWidgetCompanyButton()

void ScriptDebugWindow::DrawWidgetCompanyButton ( const Rect r,
WidgetID  widget,
int  start 
) const
inline

Draw a company button icon.

Parameters
rRect area to draw within.
widgetWidget index to start.
startWidget index of first company button.

Definition at line 883 of file script_gui.cpp.

References CenterBounds(), DrawCompanyIcon(), GetSpriteSize(), Window::GetWidget(), and Window::IsWidgetDisabled().

Referenced by DrawWidget().

◆ DrawWidgetLog()

◆ GetLogData()

ScriptLogTypes::LogData & ScriptDebugWindow::GetLogData ( ) const
inline

Definition at line 720 of file script_gui.cpp.

◆ IsDead()

bool ScriptDebugWindow::IsDead ( ) const
inline

◆ IsValidDebugCompany()

bool ScriptDebugWindow::IsValidDebugCompany ( CompanyID  company) const
inline

Check whether a company is a valid AI company or GS.

Parameters
companyCompany to check for validity.
Returns
true if company is valid for debugging.

Definition at line 744 of file script_gui.cpp.

References Game::GetInstance(), INVALID_COMPANY, Company::IsValidAiID(), and OWNER_DEITY.

Referenced by ChangeToScript(), and SelectValidDebugCompany().

◆ OnClick()

◆ OnEditboxChanged()

void ScriptDebugWindow::OnEditboxChanged ( WidgetID  widget)
inlineoverridevirtual

The text in an editbox has been edited.

Parameters
widgetThe widget of the editbox.

Reimplemented from Window.

Definition at line 1107 of file script_gui.cpp.

References ScriptDebugWindow::FilterState::break_string, Textbuf::buf, Window::GetWidget(), StringFilter::SetFilterTerm(), and WID_SCRD_BREAK_STR_EDIT_BOX.

◆ OnInit()

void ScriptDebugWindow::OnInit ( )
inlineoverridevirtual

Notification that the nested widget tree gets initialized.

The event can be used to perform general computations.

Note
nested_root and/or widget_lookup (normally accessed via GetWidget()) may not exist during this call.

Reimplemented from Window.

Definition at line 809 of file script_gui.cpp.

References _settings_client, GUISettings::ai_developer_tools, ScriptDebugWindow::FilterState::break_check_enabled, Window::GetWidget(), ClientSettings::gui, Window::InvalidateData(), Window::SetWidgetsDisabledState(), SZSP_HORIZONTAL, WID_SCRD_BREAK_STR_EDIT_BOX, WID_SCRD_BREAK_STR_ON_OFF_BTN, WID_SCRD_BREAK_STRING_WIDGETS, and WID_SCRD_MATCH_CASE_BTN.

◆ OnInvalidateData()

◆ OnPaint()

void ScriptDebugWindow::OnPaint ( )
inlineoverridevirtual

The window must be repainted.

Note
This method should not change any state, it should only use drawing functions.

Reimplemented from Window.

Definition at line 832 of file script_gui.cpp.

References Window::DrawWidgets(), SelectValidDebugCompany(), and UpdateLogScroll().

◆ OnResize()

void ScriptDebugWindow::OnResize ( )
inlineoverridevirtual

Called after the window got resized.

For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.

Reimplemented from Window.

Definition at line 1190 of file script_gui.cpp.

References WidgetDimensions::scaled, Scrollbar::SetCapacityFromWidget(), and WID_SCRD_LOG_PANEL.

◆ ScriptDebugGlobalHotkeys()

static EventState ScriptDebugWindow::ScriptDebugGlobalHotkeys ( int  hotkey)
inlinestatic

Handler for global hotkeys of the ScriptDebugWindow.

Parameters
hotkeyHotkey
Returns
ES_HANDLED if hotkey was accepted.

Definition at line 1201 of file script_gui.cpp.

References ES_NOT_HANDLED, Window::GetWidget(), INVALID_COMPANY, Window::OnHotkey(), and ShowScriptDebugWindow().

◆ SelectValidDebugCompany()

void ScriptDebugWindow::SelectValidDebugCompany ( )
inline

Ensure that script_debug_company refers to a valid AI company or GS, or is set to INVALID_COMPANY.

If no valid company is selected, it selects the first valid AI or GS if any.

Definition at line 757 of file script_gui.cpp.

References ChangeToScript(), Game::GetInstance(), INVALID_COMPANY, IsValidDebugCompany(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Iterate(), OWNER_DEITY, and ScriptDebugWindow::FilterState::script_debug_company.

Referenced by OnInvalidateData(), OnPaint(), and ScriptDebugWindow().

◆ SetStringParameters()

void ScriptDebugWindow::SetStringParameters ( WidgetID  widget) const
inlineoverridevirtual

Initialize string parameters for a widget.

Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.

Parameters
widgetWidget number.

Reimplemented from Window.

Definition at line 841 of file script_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), Game::GetInfo(), ScriptInfo::GetName(), ScriptInfo::GetVersion(), Window::GetWidget(), INVALID_COMPANY, Company::IsValidAiID(), OWNER_DEITY, ScriptDebugWindow::FilterState::script_debug_company, SetDParam(), SetDParamStr(), and WID_SCRD_NAME_TEXT.

◆ UpdateAIButtonsState()

◆ UpdateGSButtonState()

◆ UpdateLogScroll()

◆ UpdateWidgetSize()

void ScriptDebugWindow::UpdateWidgetSize ( WidgetID  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
)
inlineoverridevirtual

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters
widgetWidget number.
[in,out]sizeSize of the widget.
paddingRecommended amount of space between the widget content and the widget edge.
[in,out]fillFill step of the widget.
[in,out]resizeResize step of the widget.

Reimplemented from Window.

Definition at line 824 of file script_gui.cpp.

References WidgetDimensions::framerect, FS_NORMAL, GetCharacterHeight(), Window::resize, WidgetDimensions::scaled, RectPadding::Vertical(), WidgetDimensions::vsep_normal, and WID_SCRD_LOG_PANEL.

Field Documentation

◆ autoscroll

bool ScriptDebugWindow::autoscroll

Whether automatically scrolling should be enabled or not.

Definition at line 711 of file script_gui.cpp.

◆ break_editbox

QueryString ScriptDebugWindow::break_editbox

Break editbox.

Definition at line 713 of file script_gui.cpp.

Referenced by ScriptDebugWindow().

◆ break_string_filter

StringFilter ScriptDebugWindow::break_string_filter

Log filter for break.

Definition at line 714 of file script_gui.cpp.

◆ filter

FilterState ScriptDebugWindow::filter

Definition at line 718 of file script_gui.cpp.

◆ highlight_row

int ScriptDebugWindow::highlight_row

The output row that matches the given string, or -1.

Definition at line 715 of file script_gui.cpp.

◆ hotkeys

HotkeyList ScriptDebugWindow::hotkeys
inlinestatic
Initial value:
{"aidebug", {
Hotkey('2', "company_2", WID_SCRD_COMPANY_BUTTON_START + 1),
Hotkey('3', "company_3", WID_SCRD_COMPANY_BUTTON_START + 2),
Hotkey('4', "company_4", WID_SCRD_COMPANY_BUTTON_START + 3),
Hotkey('5', "company_5", WID_SCRD_COMPANY_BUTTON_START + 4),
Hotkey('6', "company_6", WID_SCRD_COMPANY_BUTTON_START + 5),
Hotkey('7', "company_7", WID_SCRD_COMPANY_BUTTON_START + 6),
Hotkey('8', "company_8", WID_SCRD_COMPANY_BUTTON_START + 7),
Hotkey('9', "company_9", WID_SCRD_COMPANY_BUTTON_START + 8),
Hotkey(0, "company_10", WID_SCRD_COMPANY_BUTTON_START + 9),
Hotkey(0, "company_11", WID_SCRD_COMPANY_BUTTON_START + 10),
Hotkey(0, "company_12", WID_SCRD_COMPANY_BUTTON_START + 11),
Hotkey(0, "company_13", WID_SCRD_COMPANY_BUTTON_START + 12),
Hotkey(0, "company_14", WID_SCRD_COMPANY_BUTTON_START + 13),
Hotkey(0, "company_15", WID_SCRD_COMPANY_BUTTON_START + 14),
Hotkey('S', "settings", WID_SCRD_SETTINGS),
Hotkey('0', "game_script", WID_SCRD_SCRIPT_GAME),
Hotkey('B', "break_toggle", WID_SCRD_BREAK_STR_ON_OFF_BTN),
Hotkey('F', "break_string", WID_SCRD_BREAK_STR_EDIT_BOX),
Hotkey('C', "match_case", WID_SCRD_MATCH_CASE_BTN),
Hotkey(WKC_RETURN, "continue", WID_SCRD_CONTINUE_BTN),
@ WID_SCRD_SCRIPT_GAME
Game Script button.
@ WID_SCRD_RELOAD_TOGGLE
Reload button.
@ WID_SCRD_SETTINGS
Settings button.
@ WID_SCRD_BREAK_STR_EDIT_BOX
Edit box for the string to break on.
@ WID_SCRD_COMPANY_BUTTON_START
Buttons in the VIEW.
@ WID_SCRD_MATCH_CASE_BTN
Checkbox to use match caching or not.
@ WID_SCRD_BREAK_STR_ON_OFF_BTN
Enable breaking on string.
@ WID_SCRD_CONTINUE_BTN
Continue button.
All data for a single hotkey.
Definition hotkeys.h:21
static EventState ScriptDebugGlobalHotkeys(int hotkey)
Handler for global hotkeys of the ScriptDebugWindow.

Definition at line 1209 of file script_gui.cpp.

◆ hscroll

Scrollbar* ScriptDebugWindow::hscroll

Cache of the horizontal scrollbar.

Definition at line 717 of file script_gui.cpp.

◆ initial_state

FilterState ScriptDebugWindow::initial_state
inlinestatic
Initial value:
= {
"",
true,
false,
}
@ INVALID_COMPANY
An invalid company.

Definition at line 702 of file script_gui.cpp.

◆ last_vscroll_pos

int ScriptDebugWindow::last_vscroll_pos

Last position of the scrolling.

Definition at line 710 of file script_gui.cpp.

◆ MAX_BREAK_STR_STRING_LENGTH

const uint ScriptDebugWindow::MAX_BREAK_STR_STRING_LENGTH = 256
static

Maximum length of the break string.

Definition at line 693 of file script_gui.cpp.

◆ redraw_timer

int ScriptDebugWindow::redraw_timer

Timer for redrawing the window, otherwise it'll happen every tick.

Definition at line 709 of file script_gui.cpp.

◆ show_break_box

bool ScriptDebugWindow::show_break_box

Whether the break/debug box is visible.

Definition at line 712 of file script_gui.cpp.

◆ vscroll

Scrollbar* ScriptDebugWindow::vscroll

Cache of the vertical scrollbar.

Definition at line 716 of file script_gui.cpp.


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