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

Namespaces
	Script2Game
	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.

	ScriptValueTypes
	Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.

	AngelOgre
	OGRE-AngelScript bindings; Actually named `Ogre` in the scripts, just changed for docs to separate things; Each of these objects is a loose subset of it's OGRE counterpart, see OGRE API Docs.

	AngelImGui
	DearIMGUI-AngelScript bindings; Actually named `ImGui` in the scripts, just changed for docs to separate things; Note we use somewhat outdated version (v1.73) with hand-rolled bindings and some source tweaks.

Data Structures
struct	ScriptValueTypes::color
	Binding of Ogre::ColourValue. More...

struct	ScriptValueTypes::degree
	Binding of Ogre::Degree. More...

struct	ScriptValueTypes::quaternion
	Binding of Ogre::Quaternion. More...

struct	ScriptValueTypes::radian
	Binding of Ogre::Radian. More...

struct	ScriptValueTypes::vector2
	Binding of Ogre::Vector2. More...

struct	ScriptValueTypes::vector3
	Binding of Ogre::Vector3. More...

class	Script2Game::ImDrawList
	Obtain using AngelImGui::GetWindowDrawList(); see AngelImGui. More...

class	AngelOgre::AnimationState
	Represents a single named skeletal animation track present in the mesh. More...

class	AngelOgre::AnimationStateSet
	A manager for skeletal animation tracks in the entity. More...

class	AngelOgre::Entity
	Defines an instance of a discrete, movable object based on a Mesh. More...

class	AngelOgre::MovableObject
	Abstract class defining a movable object in a scene. More...

class	AngelOgre::Node

class	AngelOgre::SceneNode
	Class representing a node in the scene graph. More...

class	AngelOgre::Overlay

class	AngelOgre::OverlayManager
	a singleton - use `Ogre::OverlayManager::getSingleton()` to retrieve instance. More...

class	AngelOgre::Root
	a singleton - use `Ogre::Root::getSingleton()` to retrieve instance. More...

class	AngelOgre::SceneManager
	Encapsulates everything renderable by OGRE - use `game.getSceneManager()` to get it. More...

class	AngelOgre::TextureManager
	a singleton - use `Ogre::TextureManager::getSingleton()` to retrieve instance. More...

class	AngelOgre::TexturePtr

class	Script2Game::BeamClass
	Binding of RoR::Actor; a softbody-physics gameplay object, can be anything from soda can to space shuttle. More...

class	Script2Game::CacheSystemClass
	Binding of RoR::CacheSystem; A database of all installed game content, allowing search and live updating. More...

class	Script2Game::ConsoleClass
	Binding of RoR::Console; provides console variables (cvars), usually defined in RoR.cfg file. More...

class	Script2Game::CVarClass
	Binding of RoR::CVar; A console variable, usually defined in RoR.cfg but also created by users or scripts. More...

class	Script2Game::EngineSimClass
	Binding of RoR::EngineSim; A land vehicle engine + transmission. More...

class	Script2Game::GameScriptClass
	Binding of RoR::GameScript; A general class that will provide you with general functions. More...

class	Script2Game::GenericDocContextClass
	Binding of RoR::GenericDocContext; Traverses document tokens; See 'demo_script.as' for an example. More...

class	Script2Game::GenericDocumentClass
	Binding of RoR::GenericDocument; Parses TRUCK/TOBJ/ODEF/CHARACTER file formats. More...

class	Script2Game::InputEngineClass
	Binding of RoR::InputEngine; Manages input devices, their configuration (input.map ...) and state. More...

class	Script2Game::LocalStorageClass
	Binding of RoR::LocalStorage; A class that allows your script to store data persistently. More...

class	Script2Game::ProceduralManagerClass
	Binding of RoR::ProceduralManager; generates dynamic roads for terrain. More...

class	Script2Game::ProceduralObjectClass
	Binding of RoR::ProceduralObject; a spline for generating dynamic roads. More...

class	Script2Game::ProceduralPointClass
	Binding of RoR::ProceduralPoint;. More...

class	Script2Game::ProceduralRoadClass
	Binding of RoR::ProceduralRoad; a dynamically generated road mesh. More...

class	Script2Game::SoundClass
	Binding of RoR::Sound; a single sound sample positioned in 3D space (spatial audio). More...

class	Script2Game::SoundScriptInstanceClass
	Binding of RoR::SoundScriptInstance; instance of SoundScriptTemplateClass. More...

class	Script2Game::SoundScriptTemplateClass
	Binding of RoR::SoundScriptTemplate; a customizable sound effect. More...

class	Script2Game::TerrainClass
	Binding of RoR::Terrain; represents a loaded terrain. More...

class	Script2Game::TerrainEditorObjectClass
	Binding of RoR::TerrainEditorObject; use `game.getEditorObjects()` to obtain live instances. More...

class	Script2Game::VehicleAIClass
	Binding of RoR::VehicleAI; Vehicle driving AI using waypoints. More...

Enumerations
enum	Script2Game::ImGuiStyleVar { Script2Game::ImGuiStyleVar_Alpha, Script2Game::ImGuiStyleVar_WindowPadding, Script2Game::ImGuiStyleVar_WindowRounding, Script2Game::ImGuiStyleVar_WindowBorderSize, Script2Game::ImGuiStyleVar_WindowMinSize, Script2Game::ImGuiStyleVar_WindowTitleAlign, Script2Game::ImGuiStyleVar_ChildRounding, Script2Game::ImGuiStyleVar_ChildBorderSize, Script2Game::ImGuiStyleVar_PopupRounding, Script2Game::ImGuiStyleVar_PopupBorderSize, Script2Game::ImGuiStyleVar_FramePadding, Script2Game::ImGuiStyleVar_FrameRounding, Script2Game::ImGuiStyleVar_FrameBorderSize, Script2Game::ImGuiStyleVar_ItemSpacing, Script2Game::ImGuiStyleVar_ItemInnerSpacing, Script2Game::ImGuiStyleVar_IndentSpacing, Script2Game::ImGuiStyleVar_ScrollbarSize, Script2Game::ImGuiStyleVar_ScrollbarRounding, Script2Game::ImGuiStyleVar_GrabMinSize, Script2Game::ImGuiStyleVar_GrabRounding, Script2Game::ImGuiStyleVar_TabRounding, Script2Game::ImGuiStyleVar_ButtonTextAlign, Script2Game::ImGuiStyleVar_SelectableTextAlign }

enum	Script2Game::ImGuiTabBarFlags { Script2Game::ImGuiTabBarFlags_None, Script2Game::ImGuiTabBarFlags_Reorderable, Script2Game::ImGuiTabBarFlags_AutoSelectNewTabs, Script2Game::ImGuiTabBarFlags_TabListPopupButton, Script2Game::ImGuiTabBarFlags_NoCloseWithMiddleMouseButton, Script2Game::ImGuiTabBarFlags_NoTabListScrollingButtons, Script2Game::ImGuiTabBarFlags_NoTooltip, Script2Game::ImGuiTabBarFlags_FittingPolicyResizeDown, Script2Game::ImGuiTabBarFlags_FittingPolicyScroll, Script2Game::ImGuiTabBarFlags_FittingPolicyMask_, Script2Game::ImGuiTabBarFlags_FittingPolicyDefault_ }
	Flags for AngelImGui::BeginTabBar() More...

enum	Script2Game::ImGuiTabItemFlags { Script2Game::ImGuiTabItemFlags_None, Script2Game::ImGuiTabItemFlags_UnsavedDocument, Script2Game::ImGuiTabItemFlags_SetSelected, Script2Game::ImGuiTabItemFlags_NoCloseWithMiddleMouseButton, Script2Game::ImGuiTabItemFlags_NoPushId }

enum	AngelOgre::GuiMetricsMode { AngelOgre::GMM_PIXELS, AngelOgre::GMM_RELATIVE, AngelOgre::GMM_RELATIVE_ASPECT_ADJUSTED }

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)
	BeginTabItem() without X close button. More...

bool	AngelImGui::BeginTabItem (const string &in, bool &inout, int=0)
	BeginTabItem() with X close button. More...

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))
	Data plotting - we wrap the 'getter func' variant to resemble the 'float*' variant. More...

void	AngelOgre::show ()

void	AngelOgre::hide ()

bool	AngelOgre::isVisible () const

void	AngelOgre::setPosition (float, float)

void	AngelOgre::setDimensions (float, float)

float	AngelOgre::getLeft () const

float	AngelOgre::getTop () const

float	AngelOgre::getWidth () const

float	AngelOgre::getHeight () const

void	AngelOgre::setLeft (float)

void	AngelOgre::setTop (float)

void	AngelOgre::setWidth (float)

void	AngelOgre::setHeight (float)

const string &	AngelOgre::getMaterialName () const

void	AngelOgre::setMaterialName (const string &in, const string &in)

void	AngelOgre::setCaption (const string &in)

const string &	AngelOgre::getCaption () const

void	AngelOgre::setColour (const color &in)

const color &	AngelOgre::getColour () const

GuiMetricsMode	AngelOgre::getMetricsMode () const

void	AngelOgre::setMetricsMode (GuiMetricsMode)

GuiHorizontalAlignment	AngelOgre::getHorizontalAlignment () const

void	AngelOgre::setHorizontalAlignment (GuiHorizontalAlignment)

Variables
enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoTitleBar
	Disable title-bar. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoResize
	Disable user resizing with the lower-right grip. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoMove
	Disable user moving the window. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoScrollbar
	Disable scrollbars (window can still scroll with mouse or programmatically) More...

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. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoCollapse
	Disable user collapsing window by double-clicking on it. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_AlwaysAutoResize
	Resize every window to its content every frame. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoBackground
	Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f). More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoSavedSettings
	Never load/save settings in .ini file. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoMouseInputs
	Disable catching mouse, hovering test with pass through. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_MenuBar
	Has a menu-bar. More...

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. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoFocusOnAppearing
	Disable taking focus when transitioning from hidden to visible state. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoBringToFrontOnFocus
	Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus) More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_AlwaysVerticalScrollbar
	Always show vertical scrollbar (even if ContentSize.y < Size.y) More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_AlwaysHorizontalScrollbar
	Always show horizontal scrollbar (even if ContentSize.x < Size.x) More...

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) More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoNavInputs
	No gamepad/keyboard navigation within the window. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoNavFocus
	No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB) More...

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. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoNav
	ImGuiWindowFlags_NoNavInputs \| ImGuiWindowFlags_NoNavFocus,. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoDecoration
	ImGuiWindowFlags_NoTitleBar \| ImGuiWindowFlags_NoResize \| ImGuiWindowFlags_NoScrollbar \| ImGuiWindowFlags_NoCollapse,. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiWindowFlags_NoInputs
	ImGuiWindowFlags_NoMouseInputs \| ImGuiWindowFlags_NoNavInputs \| ImGuiWindowFlags_NoNavFocus,. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Text
	Enumeration for AngelImGui::PushStyleColor() / AngelImGui::PopStyleColor() More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_TextDisabled

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_WindowBg
	Background of normal windows. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ChildBg
	Background of child windows. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_PopupBg
	Background of popups, menus, tooltips windows. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_Border

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_BorderShadow

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_FrameBg
	Background of checkbox, radio button, plot, slider, text input. More...

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
	Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem. More...

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
	Gamepad/keyboard: current highlighted item. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_NavWindowingHighlight
	Highlight window when using CTRL+TAB. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_NavWindowingDimBg
	Darken/colorize entire screen behind the CTRL+TAB window list, when active. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCol_ModalWindowDimBg
	Darken/colorize entire screen behind a modal window, when one is active. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_Always
	Enumateration for SetWindow*(), SetNextWindow(), SetNextItem**() functions; Represent a condition. More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_Once
	Set the variable once per runtime session (only the first call with succeed) More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_FirstUseEver
	Set the variable if the object/window has no persistently saved data (no entry in .ini file) More...

enum Script2Game::ImGuiStyleVar	Script2Game::ImGuiCond_Appearing
	Set the variable if the object/window is appearing after being hidden/inactive (or the first time) More...

enum AngelOgre::GuiMetricsMode	AngelOgre::GHA_LEFT

enum AngelOgre::GuiMetricsMode	AngelOgre::GHA_CENTER

class AngelOgre::OverlayManager &	AngelOgre::getName

Detailed Description

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

Enumeration Type Documentation

◆ GuiMetricsMode

enum AngelOgre::GuiMetricsMode

Enumerator
GMM_PIXELS
GMM_RELATIVE
GMM_RELATIVE_ASPECT_ADJUSTED

Definition at line 13 of file AngelOgre_OverlayElement.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.

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 ( )

◆ 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 )

◆ 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 ( )

◆ getCaption()

const string& AngelOgre::getCaption ( ) const

◆ GetClipboardText()

string AngelImGui::GetClipboardText ( )

◆ getColour()

const color& AngelOgre::getColour ( ) const

◆ GetColumnIndex()

int AngelImGui::GetColumnIndex ( )

◆ GetColumnOffset()

float AngelImGui::GetColumnOffset ( int = -1 )

◆ GetColumnsCount()

int AngelImGui::GetColumnsCount ( )

◆ GetColumnWidth()

float AngelImGui::GetColumnWidth ( int = -1 )

◆ GetFrameCount()

int AngelImGui::GetFrameCount ( )

◆ getHeight()

float AngelOgre::getHeight ( ) const

◆ getHorizontalAlignment()

GuiHorizontalAlignment AngelOgre::getHorizontalAlignment ( ) const

◆ GetID()

uint AngelImGui::GetID ( const string & in )

◆ GetItemRectMax()

vector2 AngelImGui::GetItemRectMax ( )

◆ GetItemRectMin()

vector2 AngelImGui::GetItemRectMin ( )

◆ GetItemRectSize()

vector2 AngelImGui::GetItemRectSize ( )

◆ GetKeyIndex()

int AngelImGui::GetKeyIndex ( int )

◆ getLeft()

float AngelOgre::getLeft ( ) const

◆ getMaterialName()

const string& AngelOgre::getMaterialName ( ) const

◆ getMetricsMode()

GuiMetricsMode AngelOgre::getMetricsMode ( ) const

◆ 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 ( )

◆ getTop()

float AngelOgre::getTop ( ) const

◆ getWidth()

float AngelOgre::getWidth ( ) const

◆ hide()

void AngelOgre::hide ( )

◆ Intermediate()

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

◆ 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 &
	)

◆ isVisible()

bool AngelOgre::isVisible ( ) const

◆ IsWindowFocused()

bool AngelImGui::IsWindowFocused ( int = 0 )

◆ IsWindowHovered()

bool AngelImGui::IsWindowHovered ( int = 0 )

◆ 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 )

◆ ResetMouseDragDelta()

void AngelImGui::ResetMouseDragDelta ( int = 0 )

◆ setCaption()

void AngelOgre::setCaption ( const string & in )

◆ SetClipboardText()

void AngelImGui::SetClipboardText ( const string & in )

◆ setColour()

void AngelOgre::setColour ( const color & in )

◆ SetColumnOffset()

void AngelImGui::SetColumnOffset	(	int	,
		float
	)

◆ setDimensions()

void AngelOgre::setDimensions	(	float	,
		float
	)

◆ setHeight()

void AngelOgre::setHeight ( float )

◆ setHorizontalAlignment()

void AngelOgre::setHorizontalAlignment ( GuiHorizontalAlignment )

◆ SetItemAllowOverlap()

void AngelImGui::SetItemAllowOverlap ( )

◆ SetKeyboardFocusHere()

void AngelImGui::SetKeyboardFocusHere ( int = 0 )

◆ setLeft()

void AngelOgre::setLeft ( float )

◆ setMaterialName()

void AngelOgre::setMaterialName	(	const string &	in,
		const string &	in
	)

◆ setMetricsMode()

void AngelOgre::setMetricsMode ( GuiMetricsMode )

◆ SetMouseCursor()

void AngelImGui::SetMouseCursor ( int )

◆ setPosition()

void AngelOgre::setPosition	(	float	,
		float
	)

◆ SetTabItemClosed()

void AngelImGui::SetTabItemClosed ( const string & in )

◆ SetTooltip()

void AngelImGui::SetTooltip ( const string & in )

◆ setTop()

void AngelOgre::setTop ( float )

◆ setWidth()

void AngelOgre::setWidth ( float )

◆ show()

void AngelOgre::show ( )

◆ 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
	)

◆ Squad()

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

Variable Documentation

◆ getName

enum AngelOgre::GuiMetricsMode AngelOgre::getName

◆ GHA_CENTER

enum AngelOgre::GuiMetricsMode AngelOgre::GHA_CENTER

◆ GHA_LEFT

enum AngelOgre::GuiMetricsMode AngelOgre::GHA_LEFT

◆ 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.

Namespaces

Data Structures

Enumerations

Functions

Variables