In fact a static class managing static things. More...

Static Public Member Functions
static void	InvokeOnPauseMenuToggled ()

static void	ReEmitWindowTextInput (object sender, TextInputEventArgs e)

static void	ReEmitWindowKeyDown (object sender, TextInputEventArgs e)

static void	Initialize ()
	Should be called in IAssemblyPlugin.Initialize.

static void	OnLoadCompleted ()

static void	Dispose ()
	Should be called in IAssemblyPlugin.Dispose.

static void	CUIDebug_Command (string[] args)

static void	CUIDebugProps_Command (string[] args)

static void	CUIMG_Command (string[] args)

static void	CUIDrawOrder_Command (string[] args)

static void	CUIPrintTree_Command (string[] args)

static void	PrintSprites_Command (string[] args)

static string	WrapInColor (object msg, string color)
	$"‖color:{color}‖{msg}‖end‖"

static string	ArrayToString (IEnumerable< object > array)
	Serializes the array.

static void	Log (object msg, Color? color=null, [CallerFilePath] string source="", [CallerLineNumber] int lineNumber=0)
	Prints a message to console.

static void	Warning (object msg, Color? color=null, [CallerFilePath] string source="", [CallerLineNumber] int lineNumber=0)

static string	GetCallerFolderPath ([CallerFilePath] string source="")
	xd

static void	Info (object msg, [CallerFilePath] string source="", [CallerLineNumber] int lineNumber=0)
	Prints debug message with source path Works only if debug is true.

static void	CheckOtherPatches (string msg="")

static void	CheckPatches (string typeName, string methodName)

static void	GUI_InputBlockingMenuOpen_Postfix (ref bool __result)

static void	GUI_TogglePauseMenu_Postfix ()

static CUIComponent	Create (string componentName)
	Just an experimant Creates empty CUIComponent from class name.

static void	PrintColors_Command (string[] args)

static void	CUICreateLuaTypesFile_Command (string[] args)

static void	CUICreatePalette_Command (string[] args)

static void	CUICreatePaletteSet_Command (string[] args)

static void	CUILoadPaletteSet_Command (string[] args)

static void	PrintKeysCommand (string[] args)

static void	PaletteDemo_Command (string[] args)

static void	Palette_Command (string[] args)

static void	DrawTexture (SpriteBatch sb, CUIRect cuirect, Texture2D texture, Color cl, CUISpriteDrawMode drawMode=CUISpriteDrawMode.Resize)

static void	DrawRectangle (SpriteBatch sb, CUIRect cuirect, Color cl, CUISprite sprite, float depth=0.0f)

static void	DrawBorders (SpriteBatch sb, CUIComponent component, float depth=0.0f)

static void	Error (object msg, int maxPrints=1, int tolerate=5, bool silent=false)

Static Public Attributes
static string	CUITexturePath = "CUI.png"

static CUI	Instance
	A singleton.

static bool	Debug
	This affects logging.

static Harmony	harmony

static Random	Random = new Random()

static int	UserCount = 0
	In theory multiple mods could use same CUI instance, i clean it up when UserCount drops to 0.

const float	Pi2 = (float)(Math.PI / 2.0)

static SamplerState	NoSmoothing

static Dictionary< string, int >	Errors = new()

Properties
static Vector2	GameScreenSize `[get]`

static Rectangle	GameScreenRect `[get]`

static string	ModDir `[get, set]`
	Root folder of the mod, used to deduce lua folder location.

static bool	UseLua = true `[get, set]`
	If false CUI won't waste time on registering lua types and creating types file.

static string	LuaFolder `[get, set]`
	Should point to lua folder, if you want lua types file.

static string	AssetsPath `[get, set]`
	Path to assets folder with all CUI stuff.

static string	PalettesPath `[get, set]`

static string	PGNAssets `[get, set]`
	If set CUI will also check this folder when loading textures.

static CUIMainComponent	Main `[get]`
	Orchestrates Drawing and updates, there could be only one CUI.Main is located under vanilla GUI.

static CUIMainComponent	TopMain `[get]`
	Orchestrates Drawing and updates, there could be only one CUI.TopMain is located above vanilla GUI.

static CUIInput	Input `[get]`
	Snapshot of mouse and keyboard state.

static CUITextureManager	TextureManager `[get]`
	Safe texture manager </summary.

static CUIFocusResolver	FocusResolver `[get]`
	Adapter to vanilla focus system, don't use.

static CUILuaRegistrar	LuaRegistrar `[get]`

static CUIComponent	FocusedComponent `[get, set]`

static bool	UseCursedPatches = true `[get, set]`
	If true other compiled mods that use CUI will break But if false then you'll have to setup hooks with lua or separate compiled plugin.

static string	HookIdentifier `[get, set]`
	It's used as harmony id and lua hooks id, it's deduced automatically from calling assembly name It's should be unique per mod or there will be conflicts You can set it to any string if you want.

static string	CUIHookID `[get]`

static bool	Disposed = true `[get, set]`

static bool	InputBlockingMenuOpen `[get]`

static List< Func< bool > >	IsBlockingPredicates `[get]`

Events
static Action	OnInit
	Called on first Initialize.

static Action	OnDispose
	Called on last Dispose.

static Action< TextInputEventArgs >	OnWindowTextInput

static Action< TextInputEventArgs >	OnWindowKeyDown

static Action	OnPauseMenuToggled

Detailed Description

In fact a static class managing static things.

Definition at line 15 of file CUIErrors.cs.

Member Function Documentation

◆ ArrayToString()

static string CrabUI.CUI.ArrayToString ( IEnumerable< object > array )

static

Serializes the array.

Definition at line 29 of file CUI Logging.cs.

    {
      return $"[{String.Join(", ", array.Select(o => o.ToString()))}]";
    }

◆ CheckOtherPatches()

static void CrabUI.CUI.CheckOtherPatches ( string msg = "" )

static

Definition at line 20 of file CUI Patches.cs.

    {
      CUI.Log(msg);
      CUI.Log($"Harmony.GetAllPatchedMethods:", Color.Lime);
      foreach (MethodBase mb in Harmony.GetAllPatchedMethods())
      {
        Patches patches = Harmony.GetPatchInfo(mb);
 
        if (patches.Prefixes.Count() > 0 || patches.Postfixes.Count() > 0)
        {
          CUI.Log($"{mb.DeclaringType}.{mb.Name}:");
          if (patches.Prefixes.Count() > 0)
          {
            CUI.Log($"    Prefixes:");
            foreach (Patch patch in patches.Prefixes) { CUI.Log($"        {patch.owner}"); }
          }
 
          if (patches.Postfixes.Count() > 0)
          {
            CUI.Log($"    Postfixes:");
            foreach (Patch patch in patches.Postfixes) { CUI.Log($"        {patch.owner}"); }
          }
        }
      }
    }

◆ CheckPatches()

static void CrabUI.CUI.CheckPatches	(	string	typeName,
		string	methodName )

static

Definition at line 46 of file CUI Patches.cs.

    {
      CUI.Log($"Harmony.GetAllPatchedMethods:", Color.Lime);
      foreach (MethodBase mb in Harmony.GetAllPatchedMethods())
      {
        if (
          !string.Equals(typeName, mb.DeclaringType.Name, StringComparison.OrdinalIgnoreCase) ||
          !string.Equals(methodName, mb.Name, StringComparison.OrdinalIgnoreCase)
        ) continue;
 
        Patches patches = Harmony.GetPatchInfo(mb);
 
        if (patches.Prefixes.Count() > 0 || patches.Postfixes.Count() > 0)
        {
          CUI.Log($"{mb.DeclaringType}.{mb.Name}:");
          if (patches.Prefixes.Count() > 0)
          {
            CUI.Log($"    Prefixes:");
            foreach (Patch patch in patches.Prefixes) { CUI.Log($"        {patch.owner}"); }
          }
 
          if (patches.Postfixes.Count() > 0)
          {
            CUI.Log($"    Postfixes:");
            foreach (Patch patch in patches.Postfixes) { CUI.Log($"        {patch.owner}"); }
          }
        }
      }
    }

◆ Create()

static CUIComponent CrabUI.CUI.Create ( string componentName )

static

Just an experimant Creates empty CUIComponent from class name.

Parameters

componentName

Returns

Definition at line 24 of file CUIBuilder.cs.

    {
      return (CUIComponent)Activator.CreateInstance(CUIReflection.GetComponentTypeByName(componentName));
    }

◆ CUICreateLuaTypesFile_Command()

static void CrabUI.CUI.CUICreateLuaTypesFile_Command ( string[] args )

static

Definition at line 50 of file CUICommands.cs.

    {
      CUI.LuaRegistrar.ConstructLuaStaticsFile();
    }

◆ CUICreatePalette_Command()

static void CrabUI.CUI.CUICreatePalette_Command ( string[] args )

static

Definition at line 56 of file CUICommands.cs.

    {
      string name = args.ElementAtOrDefault(0);
      Color colorA = CUIExtensions.ParseColor((args.ElementAtOrDefault(1) ?? "white"));
      Color colorB = CUIExtensions.ParseColor((args.ElementAtOrDefault(2) ?? "black"));
      CUIPalette palette = CUIPalette.CreatePaletteFromColors(name, colorA, colorB);
      CUIPalette.Primary = palette;
    }

◆ CUICreatePaletteSet_Command()

static void CrabUI.CUI.CUICreatePaletteSet_Command ( string[] args )

static

Definition at line 65 of file CUICommands.cs.

    {
      CUIPalette.SaveSet(
        args.ElementAtOrDefault(0),
        args.ElementAtOrDefault(1),
        args.ElementAtOrDefault(2),
        args.ElementAtOrDefault(3),
        args.ElementAtOrDefault(4)
      );
    }

◆ CUIDebug_Command()

static void CrabUI.CUI.CUIDebug_Command ( string[] args )

static

Definition at line 31 of file Debug Commands.cs.

    {
      if (CUIDebugWindow.Main == null) CUIDebugWindow.Open();
      else CUIDebugWindow.Close();
    }

◆ CUIDebugProps_Command()

static void CrabUI.CUI.CUIDebugProps_Command ( string[] args )

static

Definition at line 37 of file Debug Commands.cs.

    {
      if (CUIPropsDebug.Opened) CUI.Log($"Already opened");
      else CUIPropsDebug.Open();
    }

◆ CUIDrawOrder_Command()

static void CrabUI.CUI.CUIDrawOrder_Command ( string[] args )

static

Definition at line 44 of file Debug Commands.cs.

    {
      foreach (CUIComponent c in CUI.Main.Flat) { CUI.Log(c); }
    }

◆ CUILoadPaletteSet_Command()

static void CrabUI.CUI.CUILoadPaletteSet_Command ( string[] args )

static

Definition at line 76 of file CUICommands.cs.

    {
      CUIPalette.LoadSet(Path.Combine(CUIPalette.PaletteSetsPath, args.ElementAtOrDefault(0)));
    }

◆ CUIPrintTree_Command()

static void CrabUI.CUI.CUIPrintTree_Command ( string[] args )

static

Definition at line 49 of file Debug Commands.cs.

    {
      CUI.Main?.PrintTree();
      CUI.TopMain?.PrintTree();
    }

◆ Dispose()

static void CrabUI.CUI.Dispose ( )

static

Should be called in IAssemblyPlugin.Dispose.

Definition at line 250 of file CUI.cs.

    {
      GhostDetector.Deactivate();
      CUIDebug.Log($"CUI.Dispose {HookIdentifier} Instance:[{Instance?.GetHashCode()}] UserCount:{UserCount}", Color.Lime);
 
      UserCount--;
 
      if (UserCount <= 0)
      {
        RemoveCommands();
        // harmony.UnpatchAll(harmony.Id);
        harmony.UnpatchAll();
 
        TextureManager.Dispose();
        CUIDebugEventComponent.CapturedIDs.Clear();
        OnDispose?.Invoke();
        Disposed = true;
 
        Instance.isBlockingPredicates.Clear();
        Errors.Clear();
 
        LuaRegistrar.Deregister();
 
        Instance = null;
        UserCount = 0;
 
        CUIDebug.Log($"CUI.Disposed {HookIdentifier} Instance:[{Instance?.GetHashCode()}] UserCount:{UserCount}", Color.Lime);
      }
 
      GameMain.Instance.Window.TextInput -= ReEmitWindowTextInput;
      GameMain.Instance.Window.KeyDown -= ReEmitWindowKeyDown;
      //GameMain.Instance.Window.KeyUp -= ReEmitWindowKeyUp;
    }

◆ DrawBorders()

static void CrabUI.CUI.DrawBorders	(	SpriteBatch	sb,
		CUIComponent	component,
		float	depth = 0::0f )

static

Definition at line 72 of file CUIDrawing.cs.

    {
      Texture2D texture = component.BorderSprite.Texture;
      Rectangle sourceRect = texture.Bounds;
 
      Rectangle targetRect;
      Color cl;
      float rotation = 0.0f;
      float thickness = 1.0f;
      bool visible = false;
 
      // Right
      visible = component.RigthBorder?.Visible ?? component.Border?.Visible ?? false;
      thickness = component.RigthBorder?.Thickness ?? component.Border?.Thickness ?? 0;
      cl = component.RigthBorder?.Color ?? component.Border?.Color ?? Color.Transparent;
      targetRect = CUIRect.CreateRect(
        component.Real.Left + component.Real.Width,
        component.Real.Top,
        component.Real.Height,
        thickness
      );
      sourceRect = CUIRect.CreateRect(
        0, 0,
        targetRect.Width, texture.Height
      );
      rotation = Pi2;
      sb.Draw(texture, targetRect, sourceRect, cl, rotation, Vector2.Zero, SpriteEffects.None, depth);
 
      //Left
      visible = component.LeftBorder?.Visible ?? component.Border?.Visible ?? false;
      thickness = component.LeftBorder?.Thickness ?? component.Border?.Thickness ?? 0;
      cl = component.LeftBorder?.Color ?? component.Border?.Color ?? Color.Transparent;
      targetRect = CUIRect.CreateRect(
        component.Real.Left + thickness,
        component.Real.Top,
        component.Real.Height,
        thickness
      );
      sourceRect = CUIRect.CreateRect(
        0, 0,
        targetRect.Width, texture.Height
      );
      rotation = Pi2;
      sb.Draw(texture, targetRect, sourceRect, cl, rotation, Vector2.Zero, SpriteEffects.FlipVertically, depth);
 
 
      //Top
      visible = component.TopBorder?.Visible ?? component.Border?.Visible ?? false;
      thickness = component.TopBorder?.Thickness ?? component.Border?.Thickness ?? 0;
      cl = component.TopBorder?.Color ?? component.Border?.Color ?? Color.Transparent;
      targetRect = CUIRect.CreateRect(
        component.Real.Left,
        component.Real.Top,
        component.Real.Width,
        thickness
      );
      sourceRect = CUIRect.CreateRect(
        0, 0,
        targetRect.Width, texture.Height
      );
      rotation = 0.0f;
      sb.Draw(texture, targetRect, sourceRect, cl, rotation, Vector2.Zero, SpriteEffects.None, depth);
 
 
 
      //Bottom
      visible = component.BottomBorder?.Visible ?? component.Border?.Visible ?? false;
      thickness = component.BottomBorder?.Thickness ?? component.Border?.Thickness ?? 0;
      cl = component.BottomBorder?.Color ?? component.Border?.Color ?? Color.Transparent;
      targetRect = CUIRect.CreateRect(
        component.Real.Left,
        component.Real.Bottom - thickness,
        component.Real.Width,
        thickness
      );
      sourceRect = CUIRect.CreateRect(
        0, 0,
        targetRect.Width, texture.Height
      );
      rotation = 0;
      sb.Draw(texture, targetRect, sourceRect, cl, rotation, Vector2.Zero, SpriteEffects.FlipVertically, depth);
 
 
    }

◆ DrawRectangle()

static void CrabUI.CUI.DrawRectangle	(	SpriteBatch	sb,
		CUIRect	cuirect,
		Color	cl,
		CUISprite	sprite,
		float	depth = 0::0f )

static

Definition at line 47 of file CUIDrawing.cs.

    {
      Rectangle sourceRect = sprite.DrawMode switch
      {
        CUISpriteDrawMode.Resize => sprite.SourceRect,
        CUISpriteDrawMode.Wrap => new Rectangle(0, 0, (int)cuirect.Width, (int)cuirect.Height),
        CUISpriteDrawMode.Static => cuirect.Box,
        CUISpriteDrawMode.StaticDeep => cuirect.Zoom(0.9f),
        _ => sprite.SourceRect,
      };
 
      Rectangle rect = new Rectangle(
        (int)(cuirect.Left + sprite.Offset.X * cuirect.Width),
        (int)(cuirect.Top + sprite.Offset.Y * cuirect.Height),
        (int)(cuirect.Width),
        (int)(cuirect.Height)
      );
 
      //rect = cuirect.Box;
 
      sb.Draw(sprite.Texture, rect, sourceRect, cl, sprite.Rotation, sprite.Origin, sprite.Effects, depth);
    }

◆ DrawTexture()

static void CrabUI.CUI.DrawTexture	(	SpriteBatch	sb,
		CUIRect	cuirect,
		Texture2D	texture,
		Color	cl,
		CUISpriteDrawMode	drawMode = CUISpriteDrawMode::Resize )

static

Definition at line 34 of file CUIDrawing.cs.

    {
      Rectangle sourceRect = drawMode switch
      {
        CUISpriteDrawMode.Resize => texture.Bounds,
        CUISpriteDrawMode.Wrap => new Rectangle(0, 0, (int)cuirect.Width, (int)cuirect.Height),
        CUISpriteDrawMode.Static => cuirect.Box,
        CUISpriteDrawMode.StaticDeep => cuirect.Zoom(0.9f),
        _ => texture.Bounds,
      };
 
      sb.Draw(texture, cuirect.Box, sourceRect, cl, 0.0f, Vector2.Zero, SpriteEffects.None, 0);
    }

◆ Error()

static void CrabUI.CUI.Error	(	object	msg,
		int	maxPrints = 1,
		int	tolerate = 5,
		bool	silent = false )

static

Definition at line 18 of file CUIErrors.cs.

    {
      string s = $"{msg}";
      if (!Errors.ContainsKey(s)) Errors[s] = 1;
      else Errors[s] = Errors[s] + 1;
      if (silent) return;
      if (tolerate < Errors[s] && Errors[s] <= maxPrints) Log($"CUI: {s} x{Errors[s]}", Color.Orange);
    }

◆ GetCallerFolderPath()

static string CrabUI.CUI.GetCallerFolderPath ( [CallerFilePath] string source = "" )

static

xd

Parameters

source This should be injected by compiler, don't set

◆ GUI_InputBlockingMenuOpen_Postfix()

static void CrabUI.CUI.GUI_InputBlockingMenuOpen_Postfix ( ref bool __result )

static

Definition at line 262 of file CUI Patches.cs.

    {
      if (GhostDetector.Check()) return;
      __result = __result || CUI.InputBlockingMenuOpen;
    }

◆ GUI_TogglePauseMenu_Postfix()

static void CrabUI.CUI.GUI_TogglePauseMenu_Postfix ( )

static

Definition at line 268 of file CUI Patches.cs.

    {
      if (GhostDetector.Check()) return;
      try
      {
        if (GUI.PauseMenu != null)
        {
          GUIFrame frame = GUI.PauseMenu;
          GUIComponent pauseMenuInner = frame.GetChild(1);
          GUIComponent list = frame.GetChild(1).GetChild(0);
          GUIButton resumeButton = (GUIButton)list.GetChild(0);
 
          GUIButton.OnClickedHandler oldHandler = resumeButton.OnClicked;
 
          resumeButton.OnClicked = (GUIButton button, object obj) =>
          {
            bool guh = oldHandler(button, obj);
            CUI.InvokeOnPauseMenuToggled();
            return guh;
          };
        }
      }
      catch (Exception e) { CUI.Warning(e); }
 
      CUI.InvokeOnPauseMenuToggled();
    }

◆ Info()

static void CrabUI.CUI.Info	(	object	msg,
		[CallerFilePath] string	source = "",
		[CallerLineNumber] int	lineNumber = 0 )

static

Prints debug message with source path Works only if debug is true.

Definition at line 66 of file CUI Logging.cs.

    {
      if (Debug == true)
      {
        var fi = new FileInfo(source);
 
        Log($"{fi.Directory.Name}/{fi.Name}:{lineNumber}", Color.Yellow * 0.5f);
        Log(msg, Color.Yellow);
      }
    }

◆ Initialize()

static void CrabUI.CUI.Initialize ( )

static

Should be called in IAssemblyPlugin.Initialize.

Definition at line 196 of file CUI.cs.

    {
      CUIDebug.Log($"CUI.Initialize {HookIdentifier} Instance:[{Instance?.GetHashCode()}] UserCount:{UserCount}", Color.Lime);
      if (Instance == null)
      {
        GhostDetector.Activate();
        Disposed = false;
        HookIdentifier ??= Assembly.GetCallingAssembly().GetName().Name ?? "";
 
        Instance = new CUI();
 
        Stopwatch sw = Stopwatch.StartNew();
        if (HookIdentifier == null || HookIdentifier == "") CUI.Warning($"Warning: CUI.HookIdentifier is not set, this mod may conflict with other mods that use CUI");
 
        InitStatic();
        // this should init only static stuff that doesn't depend on instance
        OnInit?.Invoke();
 
        Instance.CreateMains();
 
        GameMain.Instance.Window.TextInput += ReEmitWindowTextInput;
        GameMain.Instance.Window.KeyDown += ReEmitWindowKeyDown;
        //GameMain.Instance.Window.KeyUp += ReEmitWindowKeyUp;
        CUIDebug.Log($"CUI.OnInit?.Invoke took {sw.ElapsedMilliseconds}ms");
 
        sw.Restart();
 
        harmony = new Harmony(CUIHookID);
        PatchAll();
        CUIDebug.Log($"CUI.PatchAll took {sw.ElapsedMilliseconds}ms");
 
        AddCommands();
        AddDebugCommands();
 
        sw.Restart();
        LuaRegistrar.Register();
        CUIDebug.Log($"CUI.LuaRegistrar.Register took {sw.ElapsedMilliseconds}ms");
      }
 
      UserCount++;
 
      CUIDebug.Log($"CUI.Initialized {HookIdentifier} Instance:[{Instance?.GetHashCode()}] UserCount:{UserCount}", Color.Lime);
    }

◆ Log()

static void CrabUI.CUI.Log	(	object	msg,
		Color?	color = null,
		[CallerFilePath] string	source = "",
		[CallerLineNumber] int	lineNumber = 0 )

static

Prints a message to console.

Definition at line 37 of file CUI Logging.cs.

    {
      color ??= Color.Cyan;
 
      // var fi = new FileInfo(source);
      // LuaCsLogger.LogMessage($"{fi.Directory.Name}/{fi.Name}:{lineNumber}", color * 0.6f, color * 0.6f);
 
      LuaCsLogger.LogMessage($"{msg ?? "null"}", color * 0.8f, color);
    }

◆ OnLoadCompleted()

static void CrabUI.CUI.OnLoadCompleted ( )

static

Definition at line 240 of file CUI.cs.

    {
      //Idk doesn't work
      //CUIMultiModResolver.FindOtherInputs();
    }

◆ Palette_Command()

static void CrabUI.CUI.Palette_Command ( string[] args )

static

Definition at line 101 of file CUICommands.cs.

    {
      try
      {
        CUIPalette palette = CUIPalette.LoadedPalettes?.GetValueOrDefault(args.ElementAtOrDefault(0) ?? "");
        if (palette != null) CUIPalette.Primary = palette;
      }
      catch (Exception e) { CUI.Warning(e); }
    }

◆ PaletteDemo_Command()

static void CrabUI.CUI.PaletteDemo_Command ( string[] args )

static

Definition at line 96 of file CUICommands.cs.

    {
      try { CUIPalette.PaletteDemo(); } catch (Exception e) { CUI.Warning(e); }
    }

◆ PrintColors_Command()

static void CrabUI.CUI.PrintColors_Command ( string[] args )

static

Definition at line 42 of file CUICommands.cs.

    {
      foreach (PropertyInfo prop in typeof(Color).GetProperties(BindingFlags.Static | BindingFlags.Public))
      {
        CUI.Log($"{prop} {prop.GetValue(null)}", (Color)prop.GetValue(null));
      }
    }

◆ PrintKeysCommand()

static void CrabUI.CUI.PrintKeysCommand ( string[] args )

static

Definition at line 81 of file CUICommands.cs.

    {
      CUIDebug.PrintKeys = !CUIDebug.PrintKeys;
 
      if (CUIDebug.PrintKeys)
      {
        var values = typeof(Keys).GetEnumValues();
        foreach (var v in values)
        {
          Log($"{(int)v} {v}");
        }
        Log("---------------------------");
      }
    }

◆ PrintSprites_Command()

static void CrabUI.CUI.PrintSprites_Command ( string[] args )

static

Definition at line 55 of file Debug Commands.cs.

    {
      foreach (GUIComponentStyle style in GUIStyle.ComponentStyles)
      {
        CUI.Log($"{style.Name} {style.Sprites.Count}");
      }
    }

◆ Warning()

static void CrabUI.CUI.Warning	(	object	msg,
		Color?	color = null,
		[CallerFilePath] string	source = "",
		[CallerLineNumber] int	lineNumber = 0 )

static

Definition at line 47 of file CUI Logging.cs.

    {
      color ??= Color.Yellow;
      // var fi = new FileInfo(source);
      // LuaCsLogger.LogMessage($"{fi.Directory.Name}/{fi.Name}:{lineNumber}", color * 0.6f, color * 0.6f);
      LuaCsLogger.LogMessage($"{msg ?? "null"}", color * 0.8f, color);
    }

◆ WrapInColor()

static string CrabUI.CUI.WrapInColor	(	object	msg,
		string	color )

static

$"‖color:{color}‖{msg}‖end‖"

Definition at line 20 of file CUI Logging.cs.

    {
      return $"‖color:{color}‖{msg}‖end‖";
    }

Member Data Documentation

◆ CUITexturePath

string CrabUI.CUI.CUITexturePath = "CUI.png"

static

Definition at line 66 of file CUI.cs.

◆ Debug

bool CrabUI.CUI.Debug

static

This affects logging.

Definition at line 113 of file CUI.cs.

◆ Errors

Dictionary<string, int> CrabUI.CUI.Errors = new()

static

Definition at line 17 of file CUIErrors.cs.

◆ harmony

Harmony CrabUI.CUI.harmony

static

Definition at line 134 of file CUI.cs.

◆ Instance

CUI CrabUI.CUI.Instance

static

A singleton.

Definition at line 79 of file CUI.cs.

◆ NoSmoothing

SamplerState CrabUI.CUI.NoSmoothing

static

Initial value:

= new SamplerState()
    {
      Filter = TextureFilter.Point,
      AddressU = TextureAddressMode.Clamp,
      AddressV = TextureAddressMode.Clamp,
      AddressW = TextureAddressMode.Clamp,
      BorderColor = Color.White,
      MaxAnisotropy = 4,
      MaxMipLevel = 0,
      MipMapLevelOfDetailBias = -0.8f,
      ComparisonFunction = CompareFunction.Never,
      FilterMode = TextureFilterMode.Default,
    }

Definition at line 20 of file CUIDrawing.cs.

    {
      Filter = TextureFilter.Point,
      AddressU = TextureAddressMode.Clamp,
      AddressV = TextureAddressMode.Clamp,
      AddressW = TextureAddressMode.Clamp,
      BorderColor = Color.White,
      MaxAnisotropy = 4,
      MaxMipLevel = 0,
      MipMapLevelOfDetailBias = -0.8f,
      ComparisonFunction = CompareFunction.Never,
      FilterMode = TextureFilterMode.Default,
    };

◆ Pi2

const float CrabUI.CUI.Pi2 = (float)(Math.PI / 2.0)

static

Definition at line 17 of file CUIDrawing.cs.

◆ Random

Random CrabUI.CUI.Random = new Random()

static

Definition at line 135 of file CUI.cs.

◆ UserCount

int CrabUI.CUI.UserCount = 0

static

In theory multiple mods could use same CUI instance, i clean it up when UserCount drops to 0.

Definition at line 168 of file CUI.cs.

Property Documentation

◆ AssetsPath

string CrabUI.CUI.AssetsPath

staticgetset

Path to assets folder with all CUI stuff.

Definition at line 57 of file CUI.cs.

    {
      get => assetsPath;
      set
      {
        assetsPath = value;
        PalettesPath = Path.Combine(value, @"Palettes");
      }
    }

◆ CUIHookID

string CrabUI.CUI.CUIHookID

staticget

Definition at line 133 of file CUI.cs.

◆ Disposed

bool CrabUI.CUI.Disposed = true

staticgetset

Definition at line 145 of file CUI.cs.

145{ get; set; } = true;

◆ FocusedComponent

CUIComponent CrabUI.CUI.FocusedComponent

staticgetset

Definition at line 104 of file CUI.cs.

    {
      get => FocusResolver.FocusedCUIComponent;
      set => FocusResolver.FocusedCUIComponent = value;
    }

◆ FocusResolver

CUIFocusResolver CrabUI.CUI.FocusResolver

staticget

Adapter to vanilla focus system, don't use.

Definition at line 101 of file CUI.cs.

◆ GameScreenRect

Rectangle CrabUI.CUI.GameScreenRect

staticget

Definition at line 27 of file CUI.cs.

◆ GameScreenSize

Vector2 CrabUI.CUI.GameScreenSize

staticget

Definition at line 26 of file CUI.cs.

◆ HookIdentifier

string CrabUI.CUI.HookIdentifier

staticgetset

It's used as harmony id and lua hooks id, it's deduced automatically from calling assembly name
It's should be unique per mod or there will be conflicts
You can set it to any string if you want.

Definition at line 124 of file CUI.cs.

    {
      get => hookIdentifier;
      set
      {
        hookIdentifier = value?.Replace(' ', '_');
      }
    }

◆ Input

CUIInput CrabUI.CUI.Input

staticget

Snapshot of mouse and keyboard state.

Definition at line 93 of file CUI.cs.

◆ InputBlockingMenuOpen

bool CrabUI.CUI.InputBlockingMenuOpen

staticget

Definition at line 154 of file CUI.cs.

    {
      get
      {
        if (IsBlockingPredicates == null) return false;
        return IsBlockingPredicates.Any(p => p());
      }
    }

◆ IsBlockingPredicates

List<Func<bool> > CrabUI.CUI.IsBlockingPredicates

staticget

Definition at line 162 of file CUI.cs.

◆ LuaFolder

string CrabUI.CUI.LuaFolder

staticgetset

Should point to lua folder, if you want lua types file.

Definition at line 51 of file CUI.cs.

51{ get; set; }

◆ LuaRegistrar

CUILuaRegistrar CrabUI.CUI.LuaRegistrar

staticget

Definition at line 102 of file CUI.cs.

◆ Main

CUIMainComponent CrabUI.CUI.Main

staticget

Orchestrates Drawing and updates, there could be only one CUI.Main is located under vanilla GUI.

Definition at line 84 of file CUI.cs.

◆ ModDir

string CrabUI.CUI.ModDir

staticgetset

Root folder of the mod, used to deduce lua folder location.

Definition at line 34 of file CUI.cs.

    {
      get => modDir;
      set
      {
        modDir = value;
        LuaFolder = Path.Combine(value, @"Lua");
      }
    }

◆ PalettesPath

string CrabUI.CUI.PalettesPath

staticgetset

Definition at line 67 of file CUI.cs.

67{ get; set; }

◆ PGNAssets

string CrabUI.CUI.PGNAssets

staticgetset

If set CUI will also check this folder when loading textures.

Definition at line 74 of file CUI.cs.

74{ get; set; }

◆ TextureManager

CUITextureManager CrabUI.CUI.TextureManager

staticget

Safe texture manager </summary.

Definition at line 97 of file CUI.cs.

◆ TopMain

CUIMainComponent CrabUI.CUI.TopMain

staticget

Orchestrates Drawing and updates, there could be only one CUI.TopMain is located above vanilla GUI.

Definition at line 89 of file CUI.cs.

◆ UseCursedPatches

bool CrabUI.CUI.UseCursedPatches = true

staticgetset

If true other compiled mods that use CUI will break But if false then you'll have to setup hooks with lua or separate compiled plugin.

Definition at line 118 of file CUI.cs.

118{ get; set; } = true;

◆ UseLua

bool CrabUI.CUI.UseLua = true

staticgetset

If false CUI won't waste time on registering lua types and creating types file.

Definition at line 47 of file CUI.cs.

47{ get; set; } = true;

Event Documentation

◆ OnDispose

Action CrabUI.CUI.OnDispose

static

Called on last Dispose.

Definition at line 144 of file CUI.cs.

◆ OnInit

Action CrabUI.CUI.OnInit

static

Called on first Initialize.

Definition at line 140 of file CUI.cs.

◆ OnPauseMenuToggled

Action CrabUI.CUI.OnPauseMenuToggled

static

Definition at line 151 of file CUI.cs.

◆ OnWindowKeyDown

Action<TextInputEventArgs> CrabUI.CUI.OnWindowKeyDown

static

Definition at line 147 of file CUI.cs.

◆ OnWindowTextInput

Action<TextInputEventArgs> CrabUI.CUI.OnWindowTextInput

static

Definition at line 146 of file CUI.cs.

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

CSharp/Client/CrabUI/CUI.cs
CSharp/Client/CrabUI/Debug/Debug Commands.cs
CSharp/Client/CrabUI/Global/CUI Logging.cs
CSharp/Client/CrabUI/Global/CUI Patches.cs
CSharp/Client/CrabUI/Global/CUIBuilder.cs
CSharp/Client/CrabUI/Global/CUICommands.cs
CSharp/Client/CrabUI/Global/CUIDrawing.cs
CSharp/Client/CrabUI/Global/CUIErrors.cs

Static Public Member Functions

Static Public Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ ArrayToString()

◆ CheckOtherPatches()

◆ CheckPatches()

◆ Create()

◆ CUICreateLuaTypesFile_Command()

◆ CUICreatePalette_Command()

◆ CUICreatePaletteSet_Command()

◆ CUIDebug_Command()

◆ CUIDebugProps_Command()

◆ CUIDrawOrder_Command()

◆ CUILoadPaletteSet_Command()

◆ CUIPrintTree_Command()

◆ Dispose()

◆ DrawBorders()

◆ DrawRectangle()

◆ DrawTexture()

◆ Error()

◆ GetCallerFolderPath()

◆ GUI_InputBlockingMenuOpen_Postfix()

◆ GUI_TogglePauseMenu_Postfix()

◆ Info()

◆ Initialize()

◆ Log()

◆ OnLoadCompleted()

◆ Palette_Command()

◆ PaletteDemo_Command()

◆ PrintColors_Command()

◆ PrintKeysCommand()

◆ PrintSprites_Command()

◆ Warning()

◆ WrapInColor()

Member Data Documentation

◆ CUITexturePath

◆ Debug

◆ Errors

◆ harmony

◆ Instance

◆ NoSmoothing

◆ Pi2

◆ Random

◆ UserCount

Property Documentation

◆ AssetsPath

◆ CUIHookID

◆ Disposed

◆ FocusedComponent

◆ FocusResolver

◆ GameScreenRect

◆ GameScreenSize

◆ HookIdentifier

◆ Input

◆ InputBlockingMenuOpen

◆ IsBlockingPredicates

◆ LuaFolder

◆ LuaRegistrar

◆ Main

◆ ModDir

◆ PalettesPath

◆ PGNAssets

◆ TextureManager

◆ TopMain

◆ UseCursedPatches

◆ UseLua

Event Documentation

◆ OnDispose

◆ OnInit

◆ OnPauseMenuToggled

◆ OnWindowKeyDown

◆ OnWindowTextInput