Parameters

• color color

  Color to dim

• multiplier number

  What to multiply the red, green, and blue values by

• alpha number default: 255

  Alpha to use in dimmed color

Returns

• color

  Dimmed color

Example Usage

print(ix.util.DimColor(Color(100, 100, 100, 255), 0.5))
 > 50 50 50 255

Parameters

• panel panel

  Panel to draw the blur for

• amount number default: 5

  Intensity of the blur. This should be kept between 0 and 10 for performance reasons

• passes number default: 0.2

  Quality of the blur. This should be kept as default

• alpha number default: 255

  Opacity of the blur

Example Usage

function PANEL:Paint(width, height)
	ix.util.DrawBlur(self)
end

Parameters

• x number

  X-position of the rectangle

• y number

  Y-position of the rectangle

• width number

  Width of the rectangle

• height number

  Height of the rectangle

• amount number default: 5

  Intensity of the blur. This should be kept between 0 and 10 for performance reasons

• passes number default: 0.2

  Quality of the blur. This should be kept as default

• alpha number default: 255

  Opacity of the blur

Example Usage

hook.Add("HUDPaint", "MyHUDPaint", function()
	ix.util.DrawBlurAt(0, 0, ScrW(), ScrH())
end)

Parameters

• text string

  Text to draw

• x number

  X-position of the text

• y number

  Y-position of the text

• color color

  Color of the text to draw

• alignX number default: TEXT_ALIGN_LEFT

  Horizontal alignment of the text, using one of the TEXT_ALIGN_* constants

• alignY number default: TEXT_ALIGN_LEFT

  Vertical alignment of the text, using one of the TEXT_ALIGN_* constants

• font string default: "ixGenericFont"

  Font to use for the text

• alpha number default: color.a * 0.575

  Alpha of the shadow

Parameters

• entity Entity

  Entity to play sounds from

• sounds table

  Sound paths to play

• delay number

  [opt=0] How long to wait before starting to play the sounds

• spacing number

  [opt=0.1] How long to wait between playing each sound

• volume number

  [opt=75] The sound level of each sound

• pitch number

  [opt=100] Pitch percentage of each sound

Returns

• number

  How long the entire sequence of sounds will take to play

Parameters

• input string

  String to expand

• bNoUpperFirst boolean default: false

  Whether or not to avoid capitalizing the first character. This is useful for lowerCamelCase

Returns

• string

  Expanded CamelCase string

Example Usage

print(ix.util.ExpandCamelCase("HelloWorld"))
 > Hello World

Parameters

• identifier string

  Search query

• bAllowPatterns boolean default: false

  Whether or not to accept Lua patterns in identifier

Returns

• player

  Player that matches the given search query - this will be nil if a player could not be found

Parameters

• format string

  Format string

• Arguments tab or ...

  to pass to the formatted string. If passed a table, it will use that table as the lookup table for the named arguments. If passed multiple arguments, it will replace the arguments in the string in order.

Example Usage

print(ix.util.FormatStringNamed("Hi, my name is {name}.", {name = "Bobby"}))
 > Hi, my name is Bobby.

print(ix.util.FormatStringNamed("Hi, my name is {name}.", "Bobby"))
 > Hi, my name is Bobby.

Returns

• Iterator

Example Usage

for client, character in ix.util.GetCharacters() do
	print(client, character)
end
> Player [1][Bot01]    character[1]
> Player [2][Bot02]    character[2]
-- etc.

Parameters

• materialPath string

  Path to the material

Returns

• material

  The cached material

OR
• nil

  If the material doesn't exist in the filesystem

Parameters

• text string

  Text to interpret a length of time from

Returns

• number

  Amount of seconds from the length interpreted from the given string

OR
• 0

  If the given string does not have a valid time

Example Usage

print(ix.util.GetStringTime("5y2d7w"))
 > 162086400 -- 5 years, 2 days, 7 weeks

Parameters

• value

  Value to get the type of

Returns

• ix.type

  Type of value

Example Usage

print(ix.util.GetTypeFromValue("hello"))
 > 2 -- i.e the value of ix.type.string

See Also

• ix.type

Returns

• number

  Current time in UTC

Parameters

• fileName string

  Path of the Lua file to include. The path is relative to the file that is currently running this function

• realm string optional

  Realm that this file should be included in. You should usually ignore this since it will be automatically be chosen based on the SERVER and CLIENT globals. This value should either be "server" or "client" if it is filled in manually

Parameters

• directory string

  Directory to include files from

• bFromLua boolean optional

  Whether or not to search from the base lua/ folder, instead of contextually basing from schema/ or gamemode/

See Also

• ix.util.Include

Parameters

• input

  Input to check

Returns

• bool

  Whether or not the input is a color

Parameters

• destination table

  The table you want the source table to merge with

• source table

  The table you want to merge with the destination table

Returns

• any

  table

Parameters

• drawFunc function

  Function to call when it needs to be drawn

Parameters

• type ix.type

  Type to check for

• input

  Value to sanitize

Returns

• any

  Sanitized value

Example Usage

print(ix.util.SanitizeType(ix.type.number, "123"))
> 123
print(ix.util.SanitizeType(ix.type.bool, 1))
> true

See Also

• ix.type

Parameters

• a string

  First string to check

• b string

  Second string to check

Returns

• bool

  Whether or not the strings are equivalent

Parameters

• name string

  String to strip prefix from

Returns

• string

  String stripped of prefix

Example Usage

print(ix.util.StripRealmPrefix("sv_init.lua"))
 > init.lua

Parameters

• text string

  Text to wrap

• maxWidth number

  Maximum allowed width in pixels

• font string default: "ixChatFont"

  Font to use for the text