Script-to-game

Description

^AngelScript^ Documents game functions which scripts can invoke to control it.

Namespaces
namespace	Script2Game
namespace	ScriptValueTypes
namespace	AngelOgre
namespace	AngelImGui

Data Structures
struct	ScriptValueTypes::box
struct	ScriptValueTypes::color
struct	ScriptValueTypes::degree
struct	ScriptValueTypes::quaternion
struct	ScriptValueTypes::radian
struct	ScriptValueTypes::vector2
struct	ScriptValueTypes::vector3
class	Script2Game::AircraftEngineClass
class	Script2Game::ImDrawList
class	AngelOgre::AnimationState
class	AngelOgre::AnimationStateSet
class	AngelOgre::Entity
class	AngelOgre::GpuProgramParametersPtr
class	AngelOgre::HardwarePixelBufferPtr
class	AngelOgre::Image
class	AngelOgre::Light
class	AngelOgre::ManualObject
class	AngelOgre::MaterialManager
class	AngelOgre::MaterialPtr
class	AngelOgre::MeshManager
class	AngelOgre::MeshPtr
class	AngelOgre::MovableObject
class	AngelOgre::Node
class	AngelOgre::SceneNode
class	AngelOgre::Overlay
class	AngelOgre::OverlayElement
class	AngelOgre::OverlayManager
class	AngelOgre::Pass
class	AngelOgre::PixelBox
class	AngelOgre::Root
class	AngelOgre::SceneManager
class	AngelOgre::SubMesh
class	AngelOgre::Technique
class	AngelOgre::TextureManager
class	AngelOgre::TexturePtr
class	AngelOgre::TextureUnitState
class	AngelOgre::Timer
class	Script2Game::AutopilotClass
class	Script2Game::BeamClass
class	Script2Game::CacheSystemClass
class	Script2Game::ConsoleClass
class	Script2Game::CVarClass
class	Script2Game::DashBoardManagerClass
class	Script2Game::EngineClass
class	Script2Game::GameScriptClass
class	Script2Game::GenericDocContextClass
class	Script2Game::GenericDocumentClass
class	Script2Game::InputEngineClass
class	Script2Game::LocalStorageClass
class	Script2Game::ProceduralManagerClass
class	Script2Game::ProceduralObjectClass
class	Script2Game::ProceduralPointClass
class	Script2Game::ProceduralRoadClass
class	Script2Game::ScrewpropClass
class	Script2Game::SoundClass
class	Script2Game::SoundScriptInstanceClass
class	Script2Game::SoundScriptTemplateClass
class	Script2Game::TerrainClass
class	Script2Game::TerrainEditorObjectClass
class	Script2Game::TurbojetClass
class	Script2Game::TurbopropClass
class	Script2Game::VehicleAIClass

Enumerations
enum	Script2Game::ImGuiStyleVar
enum	Script2Game::ImGuiTabBarFlags
enum	Script2Game::ImGuiTabItemFlags
enum	AngelOgre::IndexType
enum	AngelOgre::TransformSpace
enum	AngelOgre::RenderOperation
enum	AngelOgre::ImageFilter
enum	AngelOgre::HardwareBufferLockOptions
enum	AngelOgre::LightTypes
enum	AngelOgre::GuiMetricsMode
enum	AngelOgre::GuiHorizontalAlignment

Functions
struct ScriptValueTypes::quaternion	ScriptValueTypes::Slerp (float, const quaternion &in, const quaternion &in, bool &in)
quaternion	ScriptValueTypes::SlerpExtraSpins (float, const quaternion &in, const quaternion &in, int &in)
void	ScriptValueTypes::Intermediate (const quaternion &in, const quaternion &in, const quaternion &in, const quaternion &in, const quaternion &in)
quaternion	ScriptValueTypes::Squad (float, const quaternion &in, const quaternion &in, const quaternion &in, const quaternion &in, bool &in)
quaternion	ScriptValueTypes::nlerp (float, const quaternion &in, const quaternion &in, bool &in)
void	AngelImGui::Columns (int=1, const string &in=string(), bool=true)
void	AngelImGui::NextColumn ()
int	AngelImGui::GetColumnIndex ()
float	AngelImGui::GetColumnWidth (int=-1)
float	AngelImGui::GetColumnOffset (int=-1)
void	AngelImGui::SetColumnOffset (int, float)
int	AngelImGui::GetColumnsCount ()
void	AngelImGui::PushID (const string &in)
void	AngelImGui::PushID (int int_id)
void	AngelImGui::PopID ()
uint	AngelImGui::GetID (const string &in)
bool	AngelImGui::BeginMainMenuBar ()
void	AngelImGui::EndMainMenuBar ()
bool	AngelImGui::BeginMenuBar ()
void	AngelImGui::EndMenuBar ()
bool	AngelImGui::BeginMenu (const string &in, bool=true)
void	AngelImGui::EndMenu ()
bool	AngelImGui::MenuItem (const string &in, const string &in=string(), bool=false, bool=true)
bool	AngelImGui::MenuItem (const string &in, const string &in, bool &inout, bool=true)
void	AngelImGui::OpenPopup (const string &in)
bool	AngelImGui::BeginPopup (const string &in, int=0)
bool	AngelImGui::BeginPopupContextItem (const string &in=string(), int=1)
bool	AngelImGui::BeginPopupContextWindow (const string &in=string(), int=1, bool=true)
bool	AngelImGui::BeginPopupContextVoid (const string &in=string(), int=1)
bool	AngelImGui::BeginPopupModal (const string &in, bool &inout=null, int=0)
void	AngelImGui::EndPopup ()
void	AngelImGui::CloseCurrentPopup ()
bool	AngelImGui::BeginTabBar (const string &in, int=0)
bool	AngelImGui::BeginTabItem (const string &in, int=0)
bool	AngelImGui::BeginTabItem (const string &in, bool &inout, int=0)
void	AngelImGui::SetTabItemClosed (const string &in)
void	AngelImGui::BeginTooltip ()
void	AngelImGui::EndTooltip ()
void	AngelImGui::SetTooltip (const string &in)
void	AngelImGui::PushClipRect (const vector2 &, const vector2 &, bool)
void	AngelImGui::PopClipRect ()
void	AngelImGui::SetKeyboardFocusHere (int=0)
bool	AngelImGui::IsItemHovered (int=0)
bool	AngelImGui::IsItemActive ()
bool	AngelImGui::IsItemClicked (int=0)
bool	AngelImGui::IsItemVisible ()
bool	AngelImGui::IsAnyItemHovered ()
bool	AngelImGui::IsAnyItemActive ()
vector2	AngelImGui::GetItemRectMin ()
vector2	AngelImGui::GetItemRectMax ()
vector2	AngelImGui::GetItemRectSize ()
void	AngelImGui::SetItemAllowOverlap ()
bool	AngelImGui::IsWindowFocused (int=0)
bool	AngelImGui::IsWindowHovered (int=0)
bool	AngelImGui::IsRectVisible (const vector2 &)
bool	AngelImGui::IsRectVisible (const vector2 &, const vector2 &)
float	AngelImGui::GetTime ()
int	AngelImGui::GetFrameCount ()
vector2	AngelImGui::CalcTextSize (const string &in, bool hide_text_after_double_hash=false, float wrap_width=-1.0f)
void	AngelImGui::CalcListClipping (int, float, int &inout, int &inout)
bool	AngelImGui::BeginChildFrame (uint, const vector2 &, int=0)
void	AngelImGui::EndChildFrame ()
int	AngelImGui::GetKeyIndex (int)
bool	AngelImGui::IsKeyDown (int)
bool	AngelImGui::IsKeyPressed (int, bool=true)
bool	AngelImGui::IsKeyReleased (int)
bool	AngelImGui::IsMouseDown (int)
bool	AngelImGui::IsMouseClicked (int, bool=false)
bool	AngelImGui::IsMouseDoubleClicked (int)
bool	AngelImGui::IsMouseReleased (int)
bool	AngelImGui::IsMouseDragging (int=0, float=-1.0f)
bool	AngelImGui::IsMouseHoveringRect (const vector2 &in, const vector2 &in, bool=true)
vector2	AngelImGui::GetMousePos ()
vector2	AngelImGui::GetMousePosOnOpeningCurrentPopup ()
vector2	AngelImGui::GetMouseDragDelta (int=0, float=-1.0f)
void	AngelImGui::ResetMouseDragDelta (int=0)
int	AngelImGui::GetMouseCursor ()
void	AngelImGui::SetMouseCursor (int)
void	AngelImGui::CaptureKeyboardFromApp (bool=true)
void	AngelImGui::CaptureMouseFromApp (bool=true)
string	AngelImGui::GetClipboardText ()
void	AngelImGui::SetClipboardText (const string &in)
void	AngelImGui::PlotLines (const string &in label, array< float > &in values, int values_count, int values_offset=0, const string &in overlay_text=string(), float scale_min=FLT_MAX, float scale_max=FLT_MAX, vector2 graph_size=vector2(0, 0))
void	AngelImGui::Text (const string &in)
void	AngelImGui::TextDisabled (const string &in)
void	AngelImGui::TextColored (color col, const string &in)
void	AngelImGui::TextWrapped (const string &in)
void	AngelImGui::LabelText (const string &in, const string &in)
void	AngelImGui::Bullet ()
void	AngelImGui::BulletText (const string &in)
bool	AngelImGui::Button (const string &in, vector2=vector2(0, 0))
bool	AngelImGui::SmallButton (const string &in)
bool	AngelImGui::InvisibleButton (const string &in, vector2)
void	AngelImGui::Image (const Ogre::TexturePtr &in, vector2)
bool	AngelImGui::Checkbox (const string &in, bool &inout)
bool	AngelImGui::CheckboxFlags (const string &in, uint &inout, uint)
bool	AngelImGui::RadioButton (const string &in, bool)
bool	AngelImGui::RadioButton (const string &in, int &inout, int)

Variables
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoTitleBar
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoResize
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoMove
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoScrollbar
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoScrollWithMouse
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoCollapse
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_AlwaysAutoResize
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoBackground
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoSavedSettings
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoMouseInputs
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_MenuBar
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_HorizontalScrollbar
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoFocusOnAppearing
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoBringToFrontOnFocus
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_AlwaysVerticalScrollbar
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_AlwaysHorizontalScrollbar
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_AlwaysUseWindowPadding
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoNavInputs
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoNavFocus
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_UnsavedDocument
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoNav
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoDecoration
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoInputs
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Text
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TextDisabled
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_WindowBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ChildBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_PopupBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Border
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_BorderShadow
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_FrameBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_FrameBgHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_FrameBgActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TitleBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TitleBgActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TitleBgCollapsed
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_MenuBarBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ScrollbarBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ScrollbarGrab
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ScrollbarGrabHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ScrollbarGrabActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_CheckMark
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_SliderGrab
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_SliderGrabActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Button
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ButtonHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ButtonActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Header
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_HeaderHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_HeaderActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Separator
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_SeparatorHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_SeparatorActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ResizeGrip
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ResizeGripHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ResizeGripActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Tab
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TabHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TabActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TabUnfocused
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TabUnfocusedActive
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_PlotLines
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_PlotLinesHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_PlotHistogram
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_PlotHistogramHovered
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TextSelectedBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_DragDropTarget
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_NavHighlight
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_NavWindowingHighlight
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_NavWindowingDimBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ModalWindowDimBg
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_Always
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_Once
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_FirstUseEver
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_Appearing

Enumeration Type Documentation

GuiHorizontalAlignment

enum AngelOgre::GuiHorizontalAlignment

Enumerator
GHA_LEFT
GHA_CENTER
GHA_RIGHT

Definition at line 120 of file AngelOgre_enums.h.

GuiMetricsMode

enum AngelOgre::GuiMetricsMode

Enumerator
GMM_PIXELS
GMM_RELATIVE
GMM_RELATIVE_ASPECT_ADJUSTED

Definition at line 112 of file AngelOgre_enums.h.

HardwareBufferLockOptions

enum AngelOgre::HardwareBufferLockOptions

Locking options (binding of enum Ogre::HardwareBuffer::LockOptions)

Enumerator
HBL_NORMAL	Normal mode, ie allows read/write and contents are preserved. This kind of lock allows reading and writing from the buffer - it’s also the least optimal because basically you’re telling the card you could be doing anything at all. If you’re not using a shadow buffer, it requires the buffer to be transferred from the card and back again. If you’re using a shadow buffer the effect is minimal.
HBL_DISCARD	Discards the entire buffer while locking. This means you are happy for the card to discard the entire current contents of the buffer. Implicitly this means you are not going to read the data - it also means that the card can avoid any stalls if the buffer is currently being rendered from, because it will actually give you an entirely different one. Use this wherever possible when you are locking a buffer which was not created with a shadow buffer. If you are using a shadow buffer it matters less, although with a shadow buffer it’s preferable to lock the entire buffer at once, because that allows the shadow buffer to use HBL_DISCARD when it uploads the updated contents to the real buffer. Note Only useful on buffers created with the HBU_CPU_TO_GPU flag.
HBL_READ_ONLY	Lock the buffer for reading only. Not allowed in buffers which are created with HBU_GPU_ONLY. Mandatory on static buffers, i.e. those created without the HBU_DYNAMIC flag.
HBL_NO_OVERWRITE	As HBL_WRITE_ONLY, except the application guarantees not to overwrite any region of the buffer which has already been used in this frame, can allow some optimisation on some APIs. Note Only useful on buffers with no shadow buffer.
HBL_WRITE_ONLY	Lock the buffer for writing only.

Definition at line 63 of file AngelOgre_enums.h.

ImageFilter

enum AngelOgre::ImageFilter

Binding of enum Ogre::Image::Filter

Enumerator
FILTER_NEAREST
FILTER_LINEAR
FILTER_BILINEAR

Definition at line 55 of file AngelOgre_enums.h.

ImGuiStyleVar

enum Script2Game::ImGuiStyleVar

Enumerator
ImGuiStyleVar_Alpha	float Alpha
ImGuiStyleVar_WindowPadding	ImVec2 WindowPadding.
ImGuiStyleVar_WindowRounding	float WindowRounding
ImGuiStyleVar_WindowBorderSize	float WindowBorderSize
ImGuiStyleVar_WindowMinSize	ImVec2 WindowMinSize.
ImGuiStyleVar_WindowTitleAlign	ImVec2 WindowTitleAlign.
ImGuiStyleVar_ChildRounding	float ChildRounding
ImGuiStyleVar_ChildBorderSize	float ChildBorderSize
ImGuiStyleVar_PopupRounding	float PopupRounding
ImGuiStyleVar_PopupBorderSize	float PopupBorderSize
ImGuiStyleVar_FramePadding	ImVec2 FramePadding.
ImGuiStyleVar_FrameRounding	float FrameRounding
ImGuiStyleVar_FrameBorderSize	float FrameBorderSize
ImGuiStyleVar_ItemSpacing	ImVec2 ItemSpacing.
ImGuiStyleVar_ItemInnerSpacing	ImVec2 ItemInnerSpacing.
ImGuiStyleVar_IndentSpacing	float IndentSpacing
ImGuiStyleVar_ScrollbarSize	float ScrollbarSize
ImGuiStyleVar_ScrollbarRounding	float ScrollbarRounding
ImGuiStyleVar_GrabMinSize	float GrabMinSize
ImGuiStyleVar_GrabRounding	float GrabRounding
ImGuiStyleVar_TabRounding	float TabRounding
ImGuiStyleVar_ButtonTextAlign	ImVec2 ButtonTextAlign.
ImGuiStyleVar_SelectableTextAlign	ImVec2 SelectableTextAlign.

Definition at line 17 of file AngelImGui_enums.h.

ImGuiTabBarFlags

enum Script2Game::ImGuiTabBarFlags

Flags for AngelImGui::BeginTabBar()

Enumerator
ImGuiTabBarFlags_None
ImGuiTabBarFlags_Reorderable	Allow manually dragging tabs to re-order them + New tabs are appended at the end of list.
ImGuiTabBarFlags_AutoSelectNewTabs	Automatically select new tabs when they appear.
ImGuiTabBarFlags_TabListPopupButton	Disable buttons to open the tab list popup.
ImGuiTabBarFlags_NoCloseWithMiddleMouseButton	Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
ImGuiTabBarFlags_NoTabListScrollingButtons	Disable scrolling buttons (apply when fitting policy is ImGuiTabBarFlags_FittingPolicyScroll)
ImGuiTabBarFlags_NoTooltip	Disable tooltips when hovering a tab.
ImGuiTabBarFlags_FittingPolicyResizeDown	Resize tabs when they don't fit.
ImGuiTabBarFlags_FittingPolicyScroll	Add scroll buttons when tabs don't fit.
ImGuiTabBarFlags_FittingPolicyMask_	ImGuiTabBarFlags_FittingPolicyResizeDown | ImGuiTabBarFlags_FittingPolicyScroll,.
ImGuiTabBarFlags_FittingPolicyDefault_	ImGuiTabBarFlags_FittingPolicyResizeDown.

Definition at line 136 of file AngelImGui_enums.h.

ImGuiTabItemFlags

enum Script2Game::ImGuiTabItemFlags

Enumerator
ImGuiTabItemFlags_None
ImGuiTabItemFlags_UnsavedDocument	Append '*' to title without affecting the ID, as a convenience to avoid using the ### operator. Also: tab is selected on closure and closure is deferred by one frame to allow code to undo it without flicker.
ImGuiTabItemFlags_SetSelected	Trigger flag to programmatically make the tab selected when calling BeginTabItem()
ImGuiTabItemFlags_NoCloseWithMiddleMouseButton	Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
ImGuiTabItemFlags_NoPushId	Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()

Definition at line 152 of file AngelImGui_enums.h.

IndexType

enum AngelOgre::IndexType

Enumerator
IT_16BIT
IT_32BIT

Definition at line 18 of file AngelOgre_enums.h.

LightTypes

enum AngelOgre::LightTypes

Enumerates the types of light sources available.

Enumerator
LT_POINT	Point light sources give off light equally in all directions, so require only position not direction.
LT_DIRECTIONAL	Directional lights simulate parallel light beams from a distant source, hence have direction but no position.
LT_SPOTLIGHT	Spotlights simulate a cone of light from a source so require position and direction, plus extra values for falloff.

Definition at line 101 of file AngelOgre_enums.h.

RenderOperation

enum AngelOgre::RenderOperation

The rendering operation type to perform; binding of Ogre::RenderOperation::OperationType

Enumerator
OT_POINT_LIST	A list of points, 1 vertex per point.
OT_LINE_LIST	A list of lines, 2 vertices per line.
OT_LINE_STRIP	A strip of connected lines, 1 vertex per line plus 1 start vertex.
OT_TRIANGLE_LIST	A list of triangles, 3 vertices per triangle.
OT_TRIANGLE_STRIP	A strip of triangles, 3 vertices for the first triangle, and 1 per triangle after that.
OT_TRIANGLE_FAN	A fan of triangles, 3 vertices for the first triangle, and 1 per triangle after that.

Definition at line 38 of file AngelOgre_enums.h.

TransformSpace

enum AngelOgre::TransformSpace

Enumeration denoting the spaces which a transform can be relative to.

Enumerator
TS_LOCAL	Transform is relative to the local space.
TS_PARENT	Transform is relative to the space of the parent node.
TS_WORLD	Transform is relative to world space.

Definition at line 26 of file AngelOgre_enums.h.

Function Documentation

BeginChildFrame()

bool AngelImGui::BeginChildFrame	(	uint	,
		const vector2 &	,
		int	= 0
	)

BeginMainMenuBar()

bool AngelImGui::BeginMainMenuBar

(

)

BeginMenu()

bool AngelImGui::BeginMenu	(	const string &	in,
		bool	= true
	)

BeginMenuBar()

bool AngelImGui::BeginMenuBar

(

)

BeginPopup()

bool AngelImGui::BeginPopup	(	const string &	in,
		int	= 0
	)

BeginPopupContextItem()

bool AngelImGui::BeginPopupContextItem	(	const string &	in = string(),
		int	= 1
	)

BeginPopupContextVoid()

bool AngelImGui::BeginPopupContextVoid	(	const string &	in = string(),
		int	= 1
	)

BeginPopupContextWindow()

bool AngelImGui::BeginPopupContextWindow	(	const string &	in = string(),
		int	= 1,
		bool	= true
	)

BeginPopupModal()

bool AngelImGui::BeginPopupModal	(	const string &	in,
		bool &	inout = null,
		int	= 0
	)

BeginTabBar()

bool AngelImGui::BeginTabBar	(	const string &	in,
		int	= 0
	)

BeginTabItem() [1/2]

bool AngelImGui::BeginTabItem	(	const string &	in,
		bool &	inout,
		int	= 0
	)

BeginTabItem() with X close button.

BeginTabItem() [2/2]

bool AngelImGui::BeginTabItem	(	const string &	in,
		int	= 0
	)

BeginTabItem() without X close button.

BeginTooltip()

void AngelImGui::BeginTooltip

(

)

Bullet()

void AngelImGui::Bullet

(

)

BulletText()

void AngelImGui::BulletText

(

const string &

in

)

Button()

bool AngelImGui::Button	(	const string &	in,
		vector2	= vector2(0, 0)
	)

CalcListClipping()

void AngelImGui::CalcListClipping	(	int	,
		float	,
		int &	inout,
		int &	inout
	)

CalcTextSize()

vector2 AngelImGui::CalcTextSize	(	const string &	in,
		bool	hide_text_after_double_hash = false,
		float	wrap_width = -1.0f
	)

CaptureKeyboardFromApp()

void AngelImGui::CaptureKeyboardFromApp

(

bool

= true

)

CaptureMouseFromApp()

void AngelImGui::CaptureMouseFromApp

(

bool

= true

)

Checkbox()

bool AngelImGui::Checkbox	(	const string &	in,
		bool &	inout
	)

CheckboxFlags()

bool AngelImGui::CheckboxFlags	(	const string &	in,
		uint &	inout,
		uint
	)

CloseCurrentPopup()

void AngelImGui::CloseCurrentPopup

(

)

Columns()

void AngelImGui::Columns	(	int	= 1,
		const string &	in = string(),
		bool	= true
	)

EndChildFrame()

void AngelImGui::EndChildFrame

(

)

EndMainMenuBar()

void AngelImGui::EndMainMenuBar

(

)

EndMenu()

void AngelImGui::EndMenu

(

)

EndMenuBar()

void AngelImGui::EndMenuBar

(

)

EndPopup()

void AngelImGui::EndPopup

(

)

EndTooltip()

void AngelImGui::EndTooltip

(

)

GetClipboardText()

string AngelImGui::GetClipboardText

(

)

GetColumnIndex()

int AngelImGui::GetColumnIndex

(

)

GetColumnOffset()

float AngelImGui::GetColumnOffset

(

int

= -1

)

GetColumnsCount()

int AngelImGui::GetColumnsCount

(

)

GetColumnWidth()

float AngelImGui::GetColumnWidth

(

int

= -1

)

GetFrameCount()

int AngelImGui::GetFrameCount

(

)

GetID()

uint AngelImGui::GetID

(

const string &

in

)

GetItemRectMax()

vector2 AngelImGui::GetItemRectMax

(

)

GetItemRectMin()

vector2 AngelImGui::GetItemRectMin

(

)

GetItemRectSize()

vector2 AngelImGui::GetItemRectSize

(

)

GetKeyIndex()

int AngelImGui::GetKeyIndex

(

int

)

GetMouseCursor()

int AngelImGui::GetMouseCursor

(

)

GetMouseDragDelta()

vector2 AngelImGui::GetMouseDragDelta	(	int	= 0,
		float	= -1.0f
	)

GetMousePos()

vector2 AngelImGui::GetMousePos

(

)

GetMousePosOnOpeningCurrentPopup()

vector2 AngelImGui::GetMousePosOnOpeningCurrentPopup

(

)

GetTime()

float AngelImGui::GetTime

(

)

Image()

void AngelImGui::Image	(	const Ogre::TexturePtr &	in,
		vector2
	)

Intermediate()

void ScriptValueTypes::Intermediate	(	const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in
	)

InvisibleButton()

bool AngelImGui::InvisibleButton	(	const string &	in,
		vector2
	)

IsAnyItemActive()

bool AngelImGui::IsAnyItemActive

(

)

IsAnyItemHovered()

bool AngelImGui::IsAnyItemHovered

(

)

IsItemActive()

bool AngelImGui::IsItemActive

(

)

IsItemClicked()

bool AngelImGui::IsItemClicked

(

int

= 0

)

IsItemHovered()

bool AngelImGui::IsItemHovered

(

int

= 0

)

IsItemVisible()

bool AngelImGui::IsItemVisible

(

)

IsKeyDown()

bool AngelImGui::IsKeyDown

(

int

)

IsKeyPressed()

bool AngelImGui::IsKeyPressed	(	int	,
		bool	= true
	)

IsKeyReleased()

bool AngelImGui::IsKeyReleased

(

int

)

IsMouseClicked()

bool AngelImGui::IsMouseClicked	(	int	,
		bool	= false
	)

IsMouseDoubleClicked()

bool AngelImGui::IsMouseDoubleClicked

(

int

)

IsMouseDown()

bool AngelImGui::IsMouseDown

(

int

)

IsMouseDragging()

bool AngelImGui::IsMouseDragging	(	int	= 0,
		float	= -1.0f
	)

IsMouseHoveringRect()

bool AngelImGui::IsMouseHoveringRect	(	const vector2 &	in,
		const vector2 &	in,
		bool	= true
	)

IsMouseReleased()

bool AngelImGui::IsMouseReleased

(

int

)

IsRectVisible() [1/2]

bool AngelImGui::IsRectVisible

(

const vector2 &

)

IsRectVisible() [2/2]

bool AngelImGui::IsRectVisible	(	const vector2 &	,
		const vector2 &
	)

IsWindowFocused()

bool AngelImGui::IsWindowFocused

(

int

= 0

)

IsWindowHovered()

bool AngelImGui::IsWindowHovered

(

int

= 0

)

LabelText()

void AngelImGui::LabelText	(	const string &	in,
		const string &	in
	)

MenuItem() [1/2]

bool AngelImGui::MenuItem	(	const string &	in,
		const string &	in,
		bool &	inout,
		bool	= true
	)

MenuItem() [2/2]

bool AngelImGui::MenuItem	(	const string &	in,
		const string &	in = string(),
		bool	= false,
		bool	= true
	)

NextColumn()

void AngelImGui::NextColumn

(

)

nlerp()

quaternion ScriptValueTypes::nlerp	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		bool &	in
	)

OpenPopup()

void AngelImGui::OpenPopup

(

const string &

in

)

PlotLines()

void AngelImGui::PlotLines	(	const string &in	label,
		array< float > &in	values,
		int	values_count,
		int	values_offset = 0,
		const string &in	overlay_text = string(),
		float	scale_min = FLT_MAX,
		float	scale_max = FLT_MAX,
		vector2	graph_size = vector2(0, 0)
	)

Data plotting - we wrap the 'getter func' variant to resemble the 'float*' variant.

PlotLines(const char* label, const float* values, int values_count, int values_offset = 0, const char* overlay_text = NULL, float scale_min = FLT_MAX, float scale_max = FLT_MAX, ImVec2 graph_size = ImVec2(0, 0), int stride = sizeof(float));

PopClipRect()

void AngelImGui::PopClipRect

(

)

PopID()

void AngelImGui::PopID

(

)

PushClipRect()

void AngelImGui::PushClipRect	(	const vector2 &	,
		const vector2 &	,
		bool
	)

PushID() [1/2]

void AngelImGui::PushID

(

const string &

in

)

PushID() [2/2]

void AngelImGui::PushID

(

int

int_id

)

RadioButton() [1/2]

bool AngelImGui::RadioButton	(	const string &	in,
		bool
	)

RadioButton() [2/2]

bool AngelImGui::RadioButton	(	const string &	in,
		int &	inout,
		int
	)

ResetMouseDragDelta()

void AngelImGui::ResetMouseDragDelta

(

int

= 0

)

SetClipboardText()

void AngelImGui::SetClipboardText

(

const string &

in

)

SetColumnOffset()

void AngelImGui::SetColumnOffset	(	int	,
		float
	)

SetItemAllowOverlap()

void AngelImGui::SetItemAllowOverlap

(

)

SetKeyboardFocusHere()

void AngelImGui::SetKeyboardFocusHere

(

int

= 0

)

SetMouseCursor()

void AngelImGui::SetMouseCursor

(

int

)

SetTabItemClosed()

void AngelImGui::SetTabItemClosed

(

const string &

in

)

SetTooltip()

void AngelImGui::SetTooltip

(

const string &

in

)

Slerp()

struct ScriptValueTypes::quaternion ScriptValueTypes::Slerp	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		bool &	in
	)

SlerpExtraSpins()

quaternion ScriptValueTypes::SlerpExtraSpins	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		int &	in
	)

SmallButton()

bool AngelImGui::SmallButton

(

const string &

in

)

Squad()

quaternion ScriptValueTypes::Squad	(	float	,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		const quaternion &	in,
		bool &	in
	)

Text()

void AngelImGui::Text

(

const string &

in

)

TextColored()

void AngelImGui::TextColored	(	color	col,
		const string &	in
	)

TextDisabled()

void AngelImGui::TextDisabled

(

const string &

in

)

TextWrapped()

void AngelImGui::TextWrapped

(

const string &

in

)

Variable Documentation

ImGuiCol_Border

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_Border

ImGuiCol_BorderShadow

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_BorderShadow

ImGuiCol_Button

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_Button

ImGuiCol_ButtonActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ButtonActive

ImGuiCol_ButtonHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ButtonHovered

ImGuiCol_CheckMark

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_CheckMark

ImGuiCol_ChildBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ChildBg

Background of child windows.

ImGuiCol_DragDropTarget

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_DragDropTarget

ImGuiCol_FrameBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_FrameBg

Background of checkbox, radio button, plot, slider, text input.

ImGuiCol_FrameBgActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_FrameBgActive

ImGuiCol_FrameBgHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_FrameBgHovered

ImGuiCol_Header

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_Header

Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem.

ImGuiCol_HeaderActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_HeaderActive

ImGuiCol_HeaderHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_HeaderHovered

ImGuiCol_MenuBarBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_MenuBarBg

ImGuiCol_ModalWindowDimBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ModalWindowDimBg

Darken/colorize entire screen behind a modal window, when one is active.

ImGuiCol_NavHighlight

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_NavHighlight

Gamepad/keyboard: current highlighted item.

ImGuiCol_NavWindowingDimBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_NavWindowingDimBg

Darken/colorize entire screen behind the CTRL+TAB window list, when active.

ImGuiCol_NavWindowingHighlight

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_NavWindowingHighlight

Highlight window when using CTRL+TAB.

ImGuiCol_PlotHistogram

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_PlotHistogram

ImGuiCol_PlotHistogramHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_PlotHistogramHovered

ImGuiCol_PlotLines

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_PlotLines

ImGuiCol_PlotLinesHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_PlotLinesHovered

ImGuiCol_PopupBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_PopupBg

Background of popups, menus, tooltips windows.

ImGuiCol_ResizeGrip

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ResizeGrip

ImGuiCol_ResizeGripActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ResizeGripActive

ImGuiCol_ResizeGripHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ResizeGripHovered

ImGuiCol_ScrollbarBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ScrollbarBg

ImGuiCol_ScrollbarGrab

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ScrollbarGrab

ImGuiCol_ScrollbarGrabActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ScrollbarGrabActive

ImGuiCol_ScrollbarGrabHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_ScrollbarGrabHovered

ImGuiCol_Separator

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_Separator

ImGuiCol_SeparatorActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_SeparatorActive

ImGuiCol_SeparatorHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_SeparatorHovered

ImGuiCol_SliderGrab

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_SliderGrab

ImGuiCol_SliderGrabActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_SliderGrabActive

ImGuiCol_Tab

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_Tab

ImGuiCol_TabActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TabActive

ImGuiCol_TabHovered

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TabHovered

ImGuiCol_TabUnfocused

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TabUnfocused

ImGuiCol_TabUnfocusedActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TabUnfocusedActive

ImGuiCol_Text

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_Text

Enumeration for AngelImGui::PushStyleColor() / AngelImGui::PopStyleColor()

ImGuiCol_TextDisabled

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TextDisabled

ImGuiCol_TextSelectedBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TextSelectedBg

ImGuiCol_TitleBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TitleBg

ImGuiCol_TitleBgActive

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TitleBgActive

ImGuiCol_TitleBgCollapsed

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_TitleBgCollapsed

ImGuiCol_WindowBg

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCol_WindowBg

Background of normal windows.

ImGuiCond_Always

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCond_Always

Enumateration for SetWindow***(), SetNextWindow***(), SetNextItem***() functions; Represent a condition.

Important: Treat as a regular enum! Do NOT combine multiple values using binary operators! All the functions above treat 0 as a shortcut to ImGuiCond_Always. Set the variable

ImGuiCond_Appearing

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCond_Appearing

Set the variable if the object/window is appearing after being hidden/inactive (or the first time)

ImGuiCond_FirstUseEver

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCond_FirstUseEver

Set the variable if the object/window has no persistently saved data (no entry in .ini file)

ImGuiCond_Once

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiCond_Once

Set the variable once per runtime session (only the first call with succeed)

ImGuiWindowFlags_AlwaysAutoResize

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_AlwaysAutoResize

Resize every window to its content every frame.

ImGuiWindowFlags_AlwaysHorizontalScrollbar

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_AlwaysHorizontalScrollbar

Always show horizontal scrollbar (even if ContentSize.x < Size.x)

ImGuiWindowFlags_AlwaysUseWindowPadding

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_AlwaysUseWindowPadding

Ensure child windows without border uses style.WindowPadding (ignored by default for non-bordered child windows, because more convenient)

ImGuiWindowFlags_AlwaysVerticalScrollbar

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_AlwaysVerticalScrollbar

Always show vertical scrollbar (even if ContentSize.y < Size.y)

ImGuiWindowFlags_HorizontalScrollbar

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_HorizontalScrollbar

Allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo in the "Horizontal Scrolling" section.

ImGuiWindowFlags_MenuBar

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_MenuBar

Has a menu-bar.

ImGuiWindowFlags_NoBackground

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoBackground

Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).

ImGuiWindowFlags_NoBringToFrontOnFocus

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoBringToFrontOnFocus

Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

ImGuiWindowFlags_NoCollapse

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoCollapse

Disable user collapsing window by double-clicking on it.

ImGuiWindowFlags_NoDecoration

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoDecoration

ImGuiWindowFlags_NoTitleBar | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoScrollbar | ImGuiWindowFlags_NoCollapse,.

ImGuiWindowFlags_NoFocusOnAppearing

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoFocusOnAppearing

Disable taking focus when transitioning from hidden to visible state.

ImGuiWindowFlags_NoInputs

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoInputs

ImGuiWindowFlags_NoMouseInputs | ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,.

ImGuiWindowFlags_NoMouseInputs

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoMouseInputs

Disable catching mouse, hovering test with pass through.

ImGuiWindowFlags_NoMove

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoMove

Disable user moving the window.

ImGuiWindowFlags_NoNav

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoNav

ImGuiWindowFlags_NoNavInputs | ImGuiWindowFlags_NoNavFocus,.

ImGuiWindowFlags_NoNavFocus

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoNavFocus

No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)

ImGuiWindowFlags_NoNavInputs

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoNavInputs

No gamepad/keyboard navigation within the window.

ImGuiWindowFlags_NoResize

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoResize

Disable user resizing with the lower-right grip.

ImGuiWindowFlags_NoSavedSettings

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoSavedSettings

Never load/save settings in .ini file.

ImGuiWindowFlags_NoScrollbar

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoScrollbar

Disable scrollbars (window can still scroll with mouse or programmatically)

ImGuiWindowFlags_NoScrollWithMouse

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoScrollWithMouse

Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set.

ImGuiWindowFlags_NoTitleBar

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_NoTitleBar

Disable title-bar.

ImGuiWindowFlags_UnsavedDocument

enum Script2Game::ImGuiStyleVar Script2Game::ImGuiWindowFlags_UnsavedDocument

Append '*' to title without affecting the ID, as a convenience to avoid using the ### operator. When used in a tab/docking context, tab is selected on closure and closure is deferred by one frame to allow code to cancel the closure (with a confirmation popup, etc.) without flicker.