UndertaleModLib Record of builtin variable information. Name of the builtin variable. Whether or not the builtin variable can be set. Whether or not the builtin variable is a global variable. Whether or not the builtin variable will automatically add an array index when compiled, if one is not already present. Record of builtin function information. Classification of function. A long list of known built-in GameMaker constants, functions, and variables. Used for compilation. Loads builtin functions purely based on functions used by game data already. Helper function to define a builtin function with any number of arguments. Helper function to define a builtin function with a specific number of arguments. Helper function to define a builtin function with a specific number of arguments, and a function classification. Helper function to define a global variable with the given name and assignability. Helper function to define a global automatic array variable with the given name and assignability. Helper function to define an instance (self) variable with the given name and assignability. Initializes the main builtin data (that is, what the tool intrinsically knows about). Code builder, used to generate instructions during compilation. Maps an opcode from Underanalyzer to an UndertaleInstruction opcode. Also handles bytecode 14 mappings. Context for managing groups of GML code import operations. Higher level than . This is mainly provided for basic scripting convenience. More complex operations may require more manual work. Associated game data for this import code context. Associated global decompile context for this import code context. Decompile settings to be used for any operations requiring decompilation. Whether this group will automatically create assets based on new code entry names, when necessary. If a new code entry is created, and assets fail to be created due to ambiguity (particularly for object collision events), then an exception may be thrown. In those cases, code entries should be manually resolved first, instead. Whether an exception will be thrown if a find and replace operation is a no-op. by default. This action will be called when main-thread operations should occur, and can be changed. When the action is called, supplied action argument *must* be executed synchronously. That is, the action must return only after the argument callback has completed execution. Compile group being used by this context, if not null. Set of code entries currently queued for compile on . List of operations queued for import. Initializes a new code import context. If is not provided, a new global context will be created. If is not provided, default settings will be used. Helper to link an existing code entry to a specific object event, creating event/action structures as necessary. Object to link to. Code entry to link. Main event type to link to. Event subtype to link to. Action to call when creating new data, which may require being changed on the main thread. Attempts to parse the collision event subtype for the given code entry name. True if succeeded, false otherwise. Finds or creates a code entry, given a code entry name. Decompiles an existing code entry to a string. Queues a code replace operation on this code import context. Existing (root) code entry to modify. GML source code to compile as replacement code. Queues a code append operation on this code import context. Upon importing, the original code entry will first be decompiled, and then the code string will be appended (with a newline in between). Existing (root) code entry to modify. GML source code to append to a decompiled string of the original code. Queues a code prepend operation on this code import context. Upon importing, the original code entry will first be decompiled, and then the code string will be prepended (with a newline in between). Existing (root) code entry to modify. GML source code to prepend to a decompiled string of the original code. Queues a find and replace operation on this code import context. Existing (root) code entry to modify. Code to search for in decompilation. String to replace all occurrences of with. Whether the search should be case sensitive or not. Queues a find and replace operation on this code import context, where string contents are compared on a line-by-line basis, trimming whitespace at the beginning and end of each. Existing (root) code entry to modify. Code to search for in decompilation. String to replace all occurrences of with. Whether the search should be case sensitive or not. Queues a regex find and replace operation on this code import context. Existing (root) code entry to modify. Pattern to match against in decompilation. String to replace all matches with. Whether the search should be case sensitive or not. Queues a replace operation on this code import context. Code entry that either already exists, or will be automatically created. GML source code to compile as replacement code. Queues a code append operation on this code import context. Upon importing, the original code entry will first be decompiled, and then the code string will be appended (with a newline in between). Code entry that either already exists, or will be automatically created. GML source code to append to a decompiled string of the original code. Queues a code prepend operation on this code import context. Upon importing, the original code entry will first be decompiled, and then the code string will be prepended (with a newline in between). Code entry that either already exists, or will be automatically created. GML source code to prepend to a decompiled string of the original code. Queues a find and replace operation on this code import context. Code entry that either already exists, or will be automatically created. Code to search for in decompilation. String to replace all occurrences of with. Whether the search should be case sensitive or not. Queues a find and replace operation on this code import context, where string contents are compared on a line-by-line basis, trimming whitespace at the beginning and end of each. Code entry that either already exists, or will be automatically created. Code to search for in decompilation. String to replace all occurrences of with. Whether the search should be case sensitive or not. Queues a regex find and replace operation on this code import context. Code entry that either already exists, or will be automatically created. Pattern to match against in decompilation. String to replace all matches with. Whether the search should be case sensitive or not. Performs all queued import operations, in order. Whether to throw an exception on a failed compile. Result from compilation. Context for managing groups of GML code compilation operations. Associated game data for this compile context. Associated global decompile context for this compile context. This action will be called when main-thread operations should occur, and can be changed. When the action is called, supplied action argument *must* be executed synchronously. That is, the action must return only after the argument callback has completed execution. Whether certain linking lookups (for strings, assets, etc.) should persist between multiple compiles. This should not be preferred: generally, multiple code operations should be queued instead. This should be used with care. When enabled, no game data should be modified between each compile; otherwise, string or asset duplication may occur, which can corrupt the data permanently. Hash code of the name of the current code entry being compiled. During main compile (not linking), this is the next try variable index that should be used. Stores a code entry and corresponding GML code to be compiled during an operation. Stores a code entry and corresponding GML code to be compiled during an operation. Stores a code entry, script, and function for a newly-created child code entry during linking. Each component (code, script, and function) may individually be . Stores a code entry, script, and function for a newly-created child code entry during linking. Each component (code, script, and function) may individually be . Initializes a new compile context. If is not provided, a new global context will be created. Queues a code replace operation on this compile context. Existing (root) code entry to modify. GML source code to compile as replacement code. Looks up a string ID during linking. if an ID was successfully found; otherwise. Looks up a string, or creates one, during linking. Looks up a string, or creates one, during linking. Also outputs the ID of the string. Registers a non-local variable during linking. Registers a local variable during linking, queuing the reference to be patched later. Registers a name token during initial main compile/parse, and returns its ID. Defines a single code local variable. Returns whether the two code entry names are similar (that is, the original code entry name is identical aside from some numbers that the new name does not exactly match). After verifying that an original code entry name and a new code entry name are similar, this method can be used to find the original short name from the original code entry name, being supplied the new short name without numbers. Performs all compilation operations that have been queued on this context. Code replacement operations will be performed first, followed by code append operations. Initializes linking lookup structures, if they have not already been. Dereferences all internal linking structures to reduce potential memory usage. Guesses the type of a script from a code entry's name. An error that occurred during compilation. Code entry the error occurred in. Base, but possibly uninformative, error message. Generates a more detailed error message than (e.g., with more context). Creates a compile error struct with the given code entry and source error from the inner compiler. Creates a compile error struct with the given code entry and exception. Result of a compilation. Whether all compilation operations were successful. List of errors generated during compilation. If is , this is . A standard successful result instance. A standard unsuccessful result instance, with no errors. Creates a compile result struct with the given information. Whether compilation was successful. If compilation was unsuccessful, the list of errors produced; otherwise, . Combines two compile results together, including any potential errors. Other compile result to combine with. A new combined compile result. Helper method to print all errors into a single string, delimited by newlines. Whether to print code entry names along with each error. String with all error messages. Interface for different types of code import operations. Code entry to be imported to, for this operation. Perform this import operation. Represents a code replace operation. Represents a code replace operation. Represents a code append operation (by decompiling existing code, and appending the code string to the end). Represents a code append operation (by decompiling existing code, and appending the code string to the end). Represents a code prepend operation (by decompiling existing code, and prepending the code string to the start). Represents a code prepend operation (by decompiling existing code, and prepending the code string to the start). Represents a code find and replace operation (by decompiling existing code, and performing find/replace on that string). Represents a code find and replace operation (by decompiling existing code, and performing find/replace on that string). Returns a list of ranges, representing trimmed lines from the given string. Replaces Search with Replacement on the given string, processing on a line-by-line basis, trimming each line's whitespace. Lookup of extended (break) instruction IDs to their mnemonics. Lookup of extended (break) instruction mnemonics to their IDs. Pattern:
^(.+)\\(argc=([0-9]+)\\)$
Options:
RegexOptions.Compiled
Explanation:
○ Match if at the beginning of the string.
○ 1st capture group.
○ Match a character other than '\n' greedily at least once.
○ Match the string "(argc=".
○ 2nd capture group.
○ Match a character in the set [0-9] atomically at least once.
○ Match ')'.
○ Match if at the end of the string or if before an ending newline.
Pattern:
^\\(locals=([0-9]+)\\,\\s*argc=([0-9]+)\\)$
Options:
RegexOptions.Compiled
Explanation:
○ Match if at the beginning of the string.
○ Match the string "(locals=".
○ 1st capture group.
○ Match a character in the set [0-9] atomically at least once.
○ Match ','.
○ Match a whitespace character atomically any number of times.
○ Match the string "argc=".
○ 2nd capture group.
○ Match a character in the set [0-9] atomically at least once.
○ Match ')'.
○ Match if at the end of the string or if before an ending newline.
Assembles a single , with the provided data, and possibly local variables. Labels are not allowed. Single assembly instruction to assemble. instance to use for finding information, and updating code. Lookup map of local variables to use when assembling the instruction. Main thread action to be called when updating data, if necessary. Must execute the supplied callback synchronously. Assembles a single , with the provided data, and no local variables. Labels are not allowed. Single assembly instruction to assemble. instance to use for finding information, and updating code. Main thread action to be called when updating data, if necessary. Must execute the supplied callback synchronously. Assembles a single , with the provided data, and possibly local variables. Labels are not allowed. Single assembly instruction to assemble. instance to use for finding information, and updating code. Lookup map of local variables to use when assembling the instruction. Output label name, if one was found while parsing the instruction, or if not. Main thread action to be called when updating data, if necessary. Must execute the supplied callback synchronously. Parses a resource name, using the given data. Assembles many instructions, separated by newlines, using the provided data. Assembly source to assemble. instance to use for finding information, and updating code. Main thread action to be called when updating data, if necessary. Must execute the supplied callback synchronously. Parses a string reference in assembly, using the given string list (may create new strings). Class that helps load game-specific data, which tailor some features (such as the decompiler) to specific games. Base app directory used for locating the "GameSpecificData" directory, which should be immediately inside. Represents the kind of condition to be evaluated. Value to be used during evaluation of condition, if applicable. Integer representing the order this definition should be evaluated/loaded in. The lower this number is, the earlier this definition will be evaluated and loaded. Built-in definitions currently use values 0 (for GameMaker builtins) and 1 (for games). List of conditions that will be evaluated sequentially, to match this game-specific definition. Filename to be loaded as an Underanalyzer game-specific config, when this definition successfully matches. If empty, null, or the file is otherwise nonexistent, this will be ignored. Evaluates this game-specific definition against the given game data, returning whether this definition should be loaded. True if this definition should be loaded; false otherwise. Loads this game-specific definition. Forces a full reload of all game-specific definition files. Loads game-specific definitions, if not loaded already. Call to force a full reload. Initializes the registry of game-specific data for the given game. A global game context to track data used by GML decompilation and compilation. Can be used for multiple runs of both the Underanalyzer decompiler and compiler, and is generally thread-safe after initialization. Associated game data for this decompile context. The current compile group being used for main compile, and for linking. Instantiates and initializes a global decompile context for the given . Note: This will recalculate the global functions belonging to the given , mutating its state. Therefore, this initialization operation is not thread-safe on its own. Builds the GlobalFunctions cache, required for Underanalyzer's decompiler to recognize function names in global scope. Prepares a global decompile context for compilation. Whether asset lookups should be forced to be re-created. Adds all assets from the supplied asset list to the destination lookup dictionary, encoding the supplied reference type if required. An animation curve entry in a data file. These were introduced in GameMaker 2.3.0 Unused enum: The curve type is set per channel unlike in GMS2 where it is set per animation curve Value is never set by the compiler Value is always set by the compiler The name of this animation curve. The graph type of this animation curve. The channels this animation curve has. Serializes the data file into a specified . Where to serialize to. Whether to include in the serialization. Deserializes from a specified to the current data file. Where to deserialize from. Whether to include in the deserialization. Where to deserialize from. Whether to include in the deserialization. A channel in an animation curve. The curve type determines how points flow to each other in a channel. Creates a linear progression between points. Creates a smooth progression between points using catmull-rom interpolation. Creates a curved progression by using points as the control points of a 2D Bézier curve. The curve type this channel uses. The amount of resolution generated between control points in both Catmull-Rom (smooth) and Bezier interpolation. The points in the channel. A point which can exist on a . The X coordinate of this point. GameMaker abbreviates this to "h". The Y coordinate of this point. GameMaker abbreviates this to "v". The Y position for the first bezier handle. Only used if the Channel is set to Bezier. The Y position for the first bezier handle. Only used if the Channel is set to Bezier. The X position for the second bezier handle. Only used if the Channel is set to Bezier. The Y position for the second bezier handle. Only used if the Channel is set to Bezier. Audio group entry in a data file. Audio Groups allow you to manage a set sound entries easier. You can use these for memory management, volume control and more.
Audio Groups are only available to use in the regular audio system
The name of the audio group. This is how the audio group is referenced from code. Relative path (from the main data file) to the audio group file, in GameMaker 2024.14 and above. Prior to 2024.14, audio groups were all numerically assigned filenames and all in the root directory. A background or tileset entry in a data file. For GameMaker Studio 2, this will only ever be a tileset. For GameMaker: Studio 1, this is usually a background, but is sometimes repurposed as use for a tileset as well. A tile id, which can be used for referencing specific tiles in a tileset. Game Maker Studio 2 only. The id of a specific tile. The name of the background. Whether the background should be transparent. Whether the background should get smoothed. Whether to preload the background. The this background uses. The version of the tileset format. Added in GameMaker Studio 2. The width of a tile in this tileset. Added in GameMaker Studio 2. The height of a tile in this tileset. Added in GameMaker Studio 2. The amount of extra empty pixels left and right next to a tile in this tileset. Added in GameMaker Studio 2. The amount of extra empty pixels above and below a tile in this tileset. Added in GameMaker Studio 2. The amount of columns this tileset has. Added in GameMaker Studio 2. The number of frames of the tileset animation. Added in GameMaker Studio 2. The amount of tiles this tileset has. Added in GameMaker Studio 2. Index of the exported sprite, if one was exported. Added in GameMaker 2023.8. The time for each frame in microseconds. Added in GameMaker Studio 2. All tile IDs of this tileset. Added in GameMaker Studio 2. Added in GameMaker 2024.14.1. Added in GameMaker 2024.14.1. A bytecode instruction. Possible opcodes an instruction can use. Possible types an instruction can be. Determines the instruction type of an opcode and returns it. The opcode to get the instruction type of. The instruction type of the supplied opcode. For unknown opcodes. Converts from bytecode 14 instruction opcodes to modern opcodes. Converts from modern instruction opcodes to bytecode 14 opcodes. Note: This is just object 0, but also occurs in places where no instance type was set Note: Used only in UndertaleVariable.VarID (which is not really even InstanceType) The InstanceType is an Instance ID inside a room, minus 100000 GMS2.3+, multidimensional array with pushaf GMS2.3+, multidimensional array with pushaf or popaf Objects (functions and variables) that can be referenced as part of a reference chain, in instructions. Parse a reference chain. This function assumes that all of the object data was read already, it only fills in ValueVariable/ValueFunction on instructions. Serializes a reference chain. This functions assumes that instructions have already been written to file (i.e. the CODE chunk was before FUNC/VARI, which is normally always the case). Helper to print a variable reference to a StringBuilder. The code entry for which the instruction belongs. Address of the instruction within its code entry. A lookup of block addresses to block indices for the code entry for which the instruction belongs. Inserts a string representation of this object at a specified index in a . The instance on where to insert the string representation. Address of the instruction within its code entry. The index on where to insert the string representation. If this is -1, it will use as the index instead. Note that performance of this function can be drastically different, depending on . For best results, it's recommended to leave it at -1. Adapts asset type IDs to the enum, across versions. Adapts the enum to asset type IDs, across versions. Checks whether the given pair of ID/type is guaranteed to be 2024.4+. That is, it does not exist in the game data when using old IDs. A code entry in a data file. The name of the code entry. Length of the code entry, in bytes. The amount of local variables this code entry has. Warning: This is actually a ushort internally, but it's an uint here for compatibility. The amount of arguments this code entry accepts. Offset, in bytes, where code should begin executing from within the bytecode of this code entry. Should be 0 for root-level (parent) code entries, and nonzero for child code entries. A list of bytecode instructions this code entry has. A flag set on certain code entries, which usually don't have locals attached to them. Parent entry of this code entry, if this is a child entry; otherwise. Child entries of this code entry, if a root-level (parent) entry; empty if a child entry. Creates an empty root code entry with the given name, along with an empty code locals entry (when necessary). The code entry (and possibly code locals entry) will be immediately added to the data. Data to add the new code to. Name of the new code entry to create. The new code entry. Creates an empty root code entry with the given name, along with an empty code locals entry (when necessary). Data to add the new code to. Name of the new code entry to create. The new code entry. Recalculates this code entry's length, based on the size of all instructions contained within. Finds and returns a set of all variables this code entry references. A set of all variables this code entry references. Finds and returns a list of all local variables this code entry references. A set of all local variables this code entry references. Finds and returns the index of the first try variable used, or -1 if none is found. Append instructions at the end of this code entry. The instructions to append. Replaces all instructions currently existing in this code entry with another set of instructions. The new instructions for this code entry. An embedded audio entry in a data file. The name of the embedded audio entry. This is a UTMT only attribute. GameMaker does not store names for them. The audio data of the embedded audio entry. An embedded image entry in a GameMaker data file. This is GMS2 only.
Not to be confused with the other "embedded" resources, this is a bit different.
Rough structure: EMBI - stands for "embedded images"? Couldn't figure out how to fill the chunk with any data by editing a project and recompiling... --- <normal FourCC and chunk length found in every chunk> Int32 - literally just the number 1, always (unknown) Array of some kind: Int32 - count of items in array Each item: 32-bit string pointer, some kind of texture page identifier? 32-bit pointer to something relating to a texture page entry? .
The name of the . The of this . An embedded texture entry in the data file. The name of the embedded texture entry. This is UTMT specific. The data file does not contain names for embedded textures. Whether or not this embedded texture is scaled. TODO: i think this is wrong? The amount of generated mipmap levels.
GameMaker Studio 2 only.
Size of the texture attached to this texture page in bytes. Only appears in GM 2022.3+. The position of the placeholder TextureBlockSize value to be overwritten in SerializeBlob.
Only used internally for GM 2022.3+ support.
The texture data in the embedded image. Helper variable for whether or not this texture is to be stored externally or not. Helper variable for whether or not a texture was loaded yet. Width of the texture. 2022.9+ only. Height of the texture. 2022.9+ only. Index of the texture in the texture group. 2022.9+ only. Helper reference to texture group info, if found in the data file. Helper for 2022.9+ support. Stores copy of the path to the data file. Serializes the in-file texture blob for this texture. Where to serialize to. Deserializes the in-file texture blob for this texture. Where to deserialize from. Assigns texture group info to every embedded texture in the supplied data file. Attempts to load the corresponding external texture. Should only happen in 2022.9 and above. The texture data of the external texture or a placeholder texture if it can't be loaded. Returns the parsed texture block size, or 0 if none is available, e.g. on older GM versions. Texture data in an . The underlying image of the texture. The width of the texture. In the case of an invalid or missing image, this will always be -1. The height of the texture. In the case of an invalid or missing image, this will always be -1. Whether this texture uses the QOI format. In the case of an invalid or missing image, this will always be . Whether this texture uses the BZ2 format. (Always used in combination with QOI.) In the case of an invalid or missing image, this will always be . If located within a data file, this is the upper bound on the end position of the image data (or start of the next texture blob). All data between the actual end position and this maximum end position should be 0x00 byte padding. Invoked whenever the effective value of any dependency property has been updated. Serializes the texture to any type of writer (can be any destination file). Unserializes the texture from any type of reader (can be from any source). to read the texture's image from. Upper bound on the end of the texture's image data (e.g., for padding). Whether to unserialize the image data using GameMaker 2022.5+ format. Sets the upper bound on the position of the end of the image stream, for use when loading a full data file. All data between the actual end position and this maximum end position should be padding (zero bytes). Details the possible extension kinds for a GameMaker data file. A DLL extension. A GML extension. TODO: unknown TODO: unknown A JavaScript extension. Details the possible variable types for GameMaker extensions. A string variable. A double variable. A class representing an argument for s. The variable type of this argument. Initializes a new instance of . Initializes a new instance of with a specified . A function in a . The name of the function. An identification number of the function. TODO: is this kind the same as extension kind? The return type of the function. TODO: The extension of the filename this function belongs to? A list of arguments this function takes. A file that's used in an . The filename of this extension file. The script name that gets called when the game ends. The script name that gets called when the game starts. The type of extension this belongs to. The functions this file has defined. An option that's used in an . The type of what the option value is. The option value is a boolean- The option value is a number. The option value is a string. The value of this option. The type of this option. An extension entry in a GameMaker data file. In which folder the extension is located. TODO: needs more GM8 research. This is a remnant from the legacy GameMaker7-8.1 extension editor (aka ExtMaker).
The runner reads this name, but ignores it. This probably shouldn't be changed anyway.
The name of the extension. TODO: unknown? The version of the extension. The files that this extension contains. The options that this extension contains. List of feature flag entries in a GameMaker data file, version 2022.8 and above. The list of feature flags. A filter effect as it's used in a GameMaker data file. These are GameMaker: Studio 2.3.6+ only. The name of the . TODO: fill this out please A font entry of a data file. The name of the font. The display name of the font. A helper variable on whether the Em size is a float. The font size in Ems. In Game Maker: Studio 2.3 and above, this is a float instead. On versions below, it is an uint. Whether to display the font in bold. Whether to display the font in italics The start of the character range for this font. TODO: Currently unknown value. Possibly related to ranges? (aka normal, ascii, digits, letters) The level of anti-aliasing that is applied. 0 for none, Game Maker: Studio 2 has 1 for on, while GameMaker: Studio 1 and earlier have values 1-3 for different anti-aliasing levels. The end of the character range for this font. The object that contains the texture for this font. The x scale this font uses. The y scale this font uses. TODO: currently unknown, needs investigation. Probably this - Was introduced in GM 2022.2. A spread value that's used for SDF rendering. TODO: what is spread, what is sdf? Was introduced in GM 2023.2. 0 if SDF is disabled for this font. Was introduced in GM 2023.6. TODO: give an explanation of what this does The glyphs that this font uses. The maximum offset from the baseline to the top of the font. Exists since bytecode 17, but seems to be only get checked in GM 2022.2+. Glyphs that a font can use. The code point of character for the glyph. The x position in the where the glyph can be found. The y position in the where the glyph can be found. The width of the glyph in pixels. The height of the glyph in pixels. The number of pixels to shift right when advancing to the next character. The number of pixels to horizontally offset the rendering of this glyph. The kerning for each glyph. Purpose unknown, always 0. Was introduced in GM 2024.11. A class representing kerning for a glyph. The code point of the preceding character. An amount of pixels to add to the existing . Makes a copy of this . The copy. Makes a copy of this . The copy. A function entry as it's used in a GameMaker data file. The name of the . The index of in . How often this is referenced in code. The first instruction in this function. The name of the code local entry which corresponds to a code entry. A collection of local variables. Creates an empty code locals entry with the given name. Data to add the new code to. Name of the new code locals entry to create. The new code locals entry. Returns whether this code local entry contains any local variables matching a name. The variable name to search for. if a variable matching the provided name exists, otherwise . A local variable. TODO: a better description for this. TODO: have no idea what this index does. The name of the local variable. Collision shapes an can use. A circular collision shape. A rectangular collision shape. A custom polygonal collision shape. A game object in a data file. The name of the game object. The sprite this game object uses. Whether the game object is visible. Whether the game object is solid. The depth level of the game object. Whether the game object is persistent. The parent game object this is inheriting from. The texture mask this game object is using. Whether this object uses GameMaker physics. Whether this game object should act as a sensor fixture. The collision shape the game object should use. The physics density of the game object. The physics restitution of the game object. The physics collision group this game object belongs to. The physics linear damping this game object uses. The physics angular damping this game object uses. The physics friction this game object uses. Whether this game object should start awake in the physics simulation. Whether this game object is kinematic. The vertices used for a of type . All the events that this game object has. Invoked whenever the effective value of any dependency property has been updated. Initialized an instance of . Finds or creates a code entry for the given event type and subtype, on this object. Main event type for the event. Subtype for the event. Data that this object belongs to. New or existing code entry corresponding to the event. Finds or creates a code entry for the given main event type (no subtype), on this object. Main event type for the event. Data that this object belongs to. New or existing code entry corresponding to the event. Finds or creates a code entry for the given keyboard event type and subtype, on this object. Main keyboard event type for the event. Keyboard subtype for the event. Data that this object belongs to. New or existing code entry corresponding to the event. Finds or creates a code entry for the given step event type and subtype, on this object. Main step event type for the event. Step subtype for the event. Data that this object belongs to. New or existing code entry corresponding to the event. Finds or creates a code entry for the given mouse event type and subtype, on this object. Main mouse event type for the event. Mouse subtype for the event. Data that this object belongs to. New or existing code entry corresponding to the event. Finds or creates a code entry for the given "other" event type and subtype, on this object. Main "other" event type for the event. "Other" subtype for the event. Data that this object belongs to. New or existing code entry corresponding to the event. Finds or creates a code entry for the given draw event type and subtype, on this object. Main draw event type for the event. Draw subtype for the event. Data that this object belongs to. New or existing code entry corresponding to the event. Generic events that an uses. The subtype of this event. GameMaker suffixes the action names with this ID. The available actions that will be performed for this event. This seems to always have 1 entry, it would need testing if maybe the games using drag-and-drop code are different An action in an event. The code entry that gets executed. Class representing a physics vertex used for a of type . The x position of the vertex. The y position of the vertex. The types an from an can be. Note, that subtypes exist as well. A creation event type. Has no subtypes, it's always 0 A destroy event type. Has no subtypes, it's always 0. An alarm event type. The subtype is 0-11, depending on the alarm id. A step event type. The subtype is . A collision event type. The subtype is the other 's id. A key down event type. The subtype is the key id, see . A mouse event type. The subtype is . A miscellaneous event type. The subtype is . A draw event type. The subtype is . A key pressed event type. The subtype is the key id, see . A key released event type. The subtype is the key id, see . A trigger event type. Only used in Pre- GameMaker Studio. A cleanup event type. Has no subtypes, always 0. A gesture event type. The subtype is . A pre-create event type. Has no subtypes, always 0. The subtypes for . Normal step event. The begin step event. The end step event. The subtypes for . The draw event. The draw GUI event. The resize event. The draw begin event. The draw end event. The draw GUI begin event. The draw GUI end event. The pre-draw event. The post-draw event. The subtypes for , and . Keycode representing no key. Keycode representing that any key. Keycode representing Backspace. Keycode representing Tab. Keycode representing Return. Keycode representing Enter. Keycode representing any Shift key. Keycode representing any Control key. Keycode representing any Alt key. Keycode representing the Pause key. Keycode representing the Escape key. Keycode representing the Space key. Keycode representing PageUp. Keycode representing PageDown. Keycode representing the End key. Keycode representing the Home key. Keycode representing the left arrow key. Keycode representing the up arrow key. Keycode representing the right arrow key. Keycode representing the down arrow key. Keycode representing the PrintScreen key. Keycode representing the Insert key. Keycode representing the Delete key. Keycode representing the 0 key. Keycode representing the 1 key. Keycode representing the 2 key. Keycode representing the 3 key. Keycode representing the 4 key. Keycode representing the 5 key. Keycode representing the 6 key. Keycode representing the 7 key. Keycode representing the 8 key. Keycode representing the 9 key. Keycode representing the A key. Keycode representing the B key. Keycode representing the C key. Keycode representing the D key. Keycode representing the E key. Keycode representing the F key. Keycode representing the G key. Keycode representing the H key. Keycode representing the I key. Keycode representing the J key. Keycode representing the K key. Keycode representing the L key. Keycode representing the M key. Keycode representing the N key. Keycode representing the O key. Keycode representing the P key. Keycode representing the Q key. Keycode representing the R key. Keycode representing the S key. Keycode representing the T key. Keycode representing the U key. Keycode representing the V key. Keycode representing the W key. Keycode representing the X key. Keycode representing the Y key. Keycode representing the Z key. Keycode representing the 0 key on the numeric keypad. Keycode representing the 1 key on the numeric keypad. Keycode representing the 2 key on the numeric keypad. Keycode representing the 3 key on the numeric keypad. Keycode representing the 4 key on the numeric keypad. Keycode representing the 5 key on the numeric keypad. Keycode representing the 6 key on the numeric keypad. Keycode representing the 7 key on the numeric keypad. Keycode representing the 8 key on the numeric keypad. Keycode representing the 9 key on the numeric keypad. Keycode representing the Multiply key on the numeric keypad. Keycode representing the Add key on the numeric keypad. Keycode representing the Subtract key on the numeric keypad. Keycode representing the Decimal Dot key on the numeric keypad. Keycode representing the Divide key on the numeric keypad. Keycode representing the F1 key. Keycode representing the F2 key. Keycode representing the F3 key. Keycode representing the F4 key. Keycode representing the F5 key. Keycode representing the F6 key. Keycode representing the F7 key. Keycode representing the F8 key. Keycode representing the F9 key. Keycode representing the F10 key. Keycode representing the F11 key. Keycode representing the F12 key. Keycode representing the left Shift key. Keycode representing the right Shift key. Keycode representing the left Control key. Keycode representing the right Control key. Keycode representing the left Alt key. Keycode representing the right Alt key. The subtypes for . The left-mouse button down event. The right-mouse button down event. The middle-mouse button down event. The no-mouse input event. The left-mouse button pressed event. The right-mouse button pressed event. The middle-mouse button pressed event. The left-mouse button released event. The right-mouse button released event. The middle-mouse button released event. The mouse enter event. The mouse leave event. The Joystick1 left event. Is only used in Pre-GameMaker Studio. The Joystick1 right event. Is only used in Pre-GameMaker Studio. The Joystick1 up event. Is only used in Pre-GameMaker Studio. The Joystick1 down event. Is only used in Pre-GameMaker Studio. The Joystick1 button1 event. Is only used in Pre-GameMaker Studio. The Joystick1 button2 event. Is only used in Pre-GameMaker Studio. The Joystick1 button3 event. Is only used in Pre-GameMaker Studio. The Joystick1 button4 event. Is only used in Pre-GameMaker Studio. The Joystick1 button5 event. Is only used in Pre-GameMaker Studio. The Joystick1 button6 event. Is only used in Pre-GameMaker Studio. The Joystick1 button7 event. Is only used in Pre-GameMaker Studio. The Joystick1 button8 event. Is only used in Pre-GameMaker Studio. The Joystick2 left event. Is only used in Pre-GameMaker Studio. The Joystick2 right event. Is only used in Pre-GameMaker Studio. The Joystick2 up event. Is only used in Pre-GameMaker Studio. The Joystick2 down event. Is only used in Pre-GameMaker Studio. The Joystick2 button1 event. Is only used in Pre-GameMaker Studio. The Joystick2 button2 event. Is only used in Pre-GameMaker Studio. The Joystick2 button3 event. Is only used in Pre-GameMaker Studio. The Joystick2 button4 event. Is only used in Pre-GameMaker Studio. The Joystick2 button5 event. Is only used in Pre-GameMaker Studio. The Joystick2 button6 event. Is only used in Pre-GameMaker Studio. The Joystick2 button7 event. Is only used in Pre-GameMaker Studio. The Joystick2 button8 event. Is only used in Pre-GameMaker Studio. The global left-mouse button down event. The global right-mouse button down event. The global middle-mouse button down event. The global left-mouse button pressed event. The global right-mouse button pressed event. The global middle-mouse button pressed event. The global left-mouse button released event. The global right-mouse button released event. The global middle-mouse button released event. The mouse-wheel up event. The mouse-wheel down event. The subtypes for . The outside room event. The intersect boundary event. The game start event. The game end event. The room start event. The room end event. The "No More Lives" event. Only used in GameMaker: Studio 1 and earlier. The animation end event. The path ended event. The "No More Health" event. Only used in GameMaker: Studio 1 and earlier. The User 0 event. The User 1 event. The User 2 event. The User 3 event. The User 4 event. The User 5 event. The User 6 event. The User 7 event. The User 8 event. The User 9 event. The User 10 event. The User 11 event. The User 12 event. The User 13 event. The User 14 event. The User 15 event. The User 16 event. The Outside View 0 event. The Outside View 1 event. The Outside View 2 event. The Outside View 3 event. The Outside View 4 event. The Outside View 5 event. The Outside View 6 event. The Outside View 7 event. The Intersect View 0 Boundary event. The Intersect View 1 Boundary event. The Intersect View 2 Boundary event. The Intersect View 3 Boundary event. The Intersect View 4 Boundary event. The Intersect View 5 Boundary event. The Intersect View 6 Boundary event. The Intersect View 7 Boundary event. The animation Update event for Skeletal Animation functions. The animation event for Skeletal Animation functions. The async image loaded event. The async sound loaded event. The async http event. The async dialog event. The async in-app purchase event. The async cloud event. The async networking event. The async Steam event. The async social event. The async push notification event. The async save/load event. The async audio recording event. The async audio playback event. The async system event. The subtypes for . The tap event. The double tap event. The drag start event. The dragging event. The drag end event. The flick event. The pinch start event. The pinch in event. The pinch out event. The pinch end event. The rotate start event. The rotating event. The rotate end event. The global tap event. The global double tap event. The global drag start event. The global dragging event. The global drag end event. The global flick event. The global pinch start event. The global pinch in event. The global pinch out event. The global pinch end event. The global rotate start event. The global rotating event. The global rotate end event. General info about a data file. Information flags a data file can use. Start the game as fullscreen. Use synchronization to avoid tearing. Use synchronization to avoid tearing. TODO: difference? Interpolate colours between pixels. Keep aspect ratio during scaling. Display mouse cursor. Allows window to be resized. Allows fullscreen switching TODO: ??? studioVersion = (infoFlags & InfoFlags.StudioVersionMask) >> 9 Whether Steam (or the YoYoPlayer) is enabled. When enabled, the game will write save data to %appdata%\GameName, otherwise it will write to %localappdata%\GameName Whether the game supports borderless window Tells the runner to run Javascript code This flag is set when a game is launched from the Gamemaker Studio 2 IDE using the 'Run' or 'Debug' options Obsolete version of . For the GX.games runner, allows the browser canvas to be transparent where nothing is drawn. For the Windows runner, reverts the swapchain to an older/legacy swap effect. Function classifications a data file can have. Indicates whether debugging support is disabled. The bytecode version of the data file. Likely padding, IsDebuggerDisabled and BytecodeVersion are written together as a 32-bit integer The file name of the runner. Which GameMaker configuration the data file was compiled with. The last object id of the data file. The last tile id of the data file. The game id of the data file. The DirectPlay GUID of the data file This is always empty in Game Maker: Studio. The name of the game. Different GameMaker release branches. LTS has some but not all features of equivalent newer versions. The GameMaker release branch of the data file. May be set to when features exempted from LTS are detected. The major version of the data file. If greater than 1, serialization produces "2.0.0.0" due to the flag no longer updating in data.win The minor version of the data file. The Release version of the data file. The build version of the data file. The default window width of the game. The default window height of the game. The info flags of the data file. The MD5 of the license used to compile the game. The CRC32 of the license used to compile the game. The UNIX timestamp the game was compiled. The name that gets displayed in the window. The function classifications of this data file. The Steam app id of the game. The port the data file exposes for the debugger. The room order of the data file. TODO: unknown, some sort of checksum. The FPS of the data file. GameMaker Studio 2 only. Whether the data file allows statistics. GameMaker Studio 2 only. TODO: more unknown checksum data. Whether the random UID's timestamp was initially offset. If or has an invalid length. Generates "info number" used for GMS2 UIDs. General options about a data file. Option flags a data file can use If the game should start in fullscreen. If pixels should be interpolated. If the new audio format should be used. If borderless window should be used. If the mouse cursor should be shown. If the window should be resizable. If the window should stay on top. If the resolution can be changed. Shader extension flag. Always set to int.MinValue Shader extension version. Always set to 2 Option flags the data file uses. The window scale. // TODO: is this a legacy gm thing, or still used today? The window color. TODO: unused? Legacy GM remnant? Is this the "Color outside the room region" thing? The Color depth the game uses. Used only in Game Maker 8 and earlier. The game's resolution. Used only in Game Maker 8 and earlier. The game's refresh rate. Used only in Game Maker 8 and earlier. Whether the game uses V-Sync. The priority of the game process. The higher the number, the more priority will be given to the game. Used only in Game Maker 8 and earlier. The background of the loading bar when loading GameMaker 8 games. The image of the loading bar when loading GameMaker 8 games. The image that gets shown when loading GameMaker 8 games. The transparency value of . 255 indicates fully opaque, 0 means fully transparent. A list of Constants that the game uses. A class for game constants. The name of the constant. The value of the constant. Serializes into a specified . Where to serialize to. Deserializes from a specified and with a specified entries count. Where to deserialize from. Count of entries to read. A global initialization entry in a data file. The object which contains the code. This code is executed at a global scope, before the first room of the game executes. The name of the particle system. The x-coordinate of the origin of the particle system. The y-coordinate of the origin of the particle system. The draw order of the particle system, determining whether new particles are drawn on top of or below older particles. Whether global space particles are enabled for the particle system, determining whether particles (don't) follow a system's position, if it moves. Added in GameMaker 2023.8. The emitters of the particle system. The name of the emitter Whether the emitter is enabled. Added in GameMaker 2023.6. The emit mode of the emitter. The amount of particles to emit. While the type of this property is , it should be reinterpreted as the bits of a in GameMaker 2023.8 and above. Added in GameMaker 2023.8. The minimum delay between particle emissions. Added in GameMaker 2023.8. The maximum delay between particle emissions. Added in GameMaker 2023.8. The time unit to use for and . Added in GameMaker 2023.8. The minimum interval between particle emissions. Added in GameMaker 2023.8. The maximum interval between particle emissions. Added in GameMaker 2023.8. The time unit to use for and . Added in GameMaker 2023.8. The distribution type of the emitter, determining how they are distributed around the emitter. The shape of the emitter. The x-coordinate of the emitter. The y-coordinate of the emitter. The width (in pixels) of the emitter. The height (in pixels) of the emitter. The angle of the emitter. The sprite that this emitter uses for its particles. The preset textures for the emitter to use. Added in GameMaker 2023.4. Added in GameMaker 2023.4. Added in GameMaker 2023.4. Added in GameMaker 2023.8, superseding . Added in GameMaker 2023.8, superseding . Added in GameMaker 2023.8, superseding . Added in GameMaker 2023.8, superseding . Added in GameMaker 2023.8, superseding . Added in GameMaker 2023.8, superseding . Added in GameMaker 2023.8, superseding . Added in GameMaker 2023.8, superseding . Only in use prior to GameMaker 2023.8, and considered the average of and beyond that version. Only in use prior to GameMaker 2023.8, and considered the average of and beyond that version. Only in use prior to GameMaker 2023.8, and considered the average of and beyond that version. Only in use prior to GameMaker 2023.8, and considered the average of and beyond that version. A Path entry in a GameMaker data file. The name of . Whether the Path is smooth between points, or is completely straight. Whether this Path is closed, aka if the last connecting back to the first. A number from 1 to 8 detailing how smooth a is between , with 1 being completely straight and 8 being the smoothest.
Only used if is enabled.
The collection of s this has. A point in a . The X position of the . The Y position of the . A percentage of how fast an moves until it hits the next .
.
A room in a data file. Certain flags a room can have. Whether the room has Views enabled. Clears the application surface with the window colour before drawing each frame. Whether the room should not clear the display buffer. Whether the room was made in GameMaker Studio 2 or above. Whether the room was made in GameMaker Studio 2.3 or above. Whether the room was made in GameMaker 2024.13 or above. Obsolete version of , retained for serialization purposes. The name of the room. The caption of the room. Legacy variable that's used in pre- Game Maker: Studio. The Width of the room. The height of the room. The speed of the current room in steps. TODO: GMS1 only? IIRC gms2 deals with it differently. Whether this room is persistant. The background color of this room. Whether the display buffer should be cleared with Window Color. The creation code of this room. The room flags this room has. The gravity towards x axis using room physics in m/s. The gravity towards y axis using room physics in m/s. The meters per pixel value for room physics. The width of the room grid in pixels. This is an UndertaleModTool-only property; it doesn't exist in game data. The height of the room grid in pixels. This is an UndertaleModTool-only property; it doesn't exist in game data. The thickness of the room grid in pixels. This is an UndertaleModTool-only property; it doesn't exist in game data. The list of backgrounds this room uses. The list of views this room uses. The list of game objects this room uses. The list of tiles this room uses. List of instance creation order IDs, used for the first room in the room order only, in GameMaker 2024.13 and above. The list of layers this room uses. Used in GameMaker Studio 2 only, as and are empty there. The list of sequences this room uses. Calls for in order to update the room background color.
Only used for GameMaker: Studio 2 rooms.
Checks whether is ordered by . if is ordered, and otherwise. Orders by depth. A that consists of: the selected layer (in the room editor), ordered layers array and selected layer index. This parameter is used only by LayerZIndexConverter (part of the room editor UI). The layer containing the background color.
Used by "BGColorConverter" of the UndertaleModTool room editor. This attribute is UMT-only and does not exist in GameMaker.
Invoked whenever the effective value of any dependency property has been updated. Initializes a new instance of . Initialize the room by setting every or (depending on the GameMaker version), and optionally calculate the room grid size. Whether to calculate the room grid width. Whether to calculate the room grid height. Interface for objects within rooms. X coordinate of the object. Y coordinate of the object. Instance id of the object. A background with properties as it's used in a room. The room parent this belongs to. This attribute is UMT-only and does not exist in GameMaker. The calculated horizontal render scale for the background texture. Used in the room editor.
This attribute is UMT-only and does not exist in GameMaker.
The calculated vertical render scale for the background texture. Used in the room editor.
This attribute is UMT-only and does not exist in GameMaker.
Whether this is enabled. Whether this acts as a foreground. The background asset this uses. The x coordinate of the background in the room. The y coordinate of the background in the room. Horizontal speed of the background. Vertical speed of the background. Whether this background is stretched Indicates whether this is tiled horizontally. Internally, GameMaker uses an integer value for storing the state, where 0 acts as and any other number as . This property is a wrapper for it, which is made for convenience. Indicates whether this is tiled vertically. Internally, GameMaker uses an integer value for storing the state, where 0 acts as and any other number as . This property is a wrapper for it, which is made for convenience. A horizontal offset used for proper background display in the room editor. This attribute is UMT-only and does not exist in GameMaker. A vertical offset used for proper background display in the room editor. This attribute is UMT-only and does not exist in GameMaker. A view with properties as it's used in a room. Whether this view is enabled. The x coordinate of the view in the room. The y coordinate of the view in the room. The width of the view. The height of the view. The x coordinate of the viewport on the screen. The y coordinate of the viewport on the screen. The width of the viewport on the screen. The height of the viewport on the screen. The horizontal border of the view for view following. The vertical border of the view for view following. The horizontal movement speed of the view. The vertical movement speed of the view. The object the view should follow. A game object with properties as it's used in a room. The x coordinate of this object. The y coordinate of this object. The game object that is used. The instance id of this object. The creation code for this object. The x scale that's applied for this object. The y scale that's applied for this object. The rotation of this object. The pre creation code of this object. The image speed of this object. Game Maker: Studio 2 only. The image index of this object. Game Maker: Studio 2 only. Whether this game object actually exists or not; if it does not exist. A wrapper for that returns the value being wrapped around available frames of the sprite.
For example, if this sprite has 3 frames, and the index is 5, then this will return 2.
This attribute is UMT-only and does not exist in GameMaker.
The opposite angle of the current rotation. This attribute is UMT-only and does not exist in GameMaker. A horizontal offset relative to top-left corner of the game object. Used for proper game object rotation display in the room editor and for determining .
This attribute is UMT-only and does not exist in GameMaker.
A vertical offset relative to top-left corner of the game object. Used for proper game object rotation display in the room editor and for determining .
This attribute is UMT-only and does not exist in GameMaker.
A horizontal offset used for proper game object position display in the room editor. This attribute is UMT-only and does not exist in GameMaker. A vertical offset used for proper game object display in the room editor. This attribute is UMT-only and does not exist in GameMaker. A tile with properties as it's used in a room. Whether this tile represents a or a .
for GameMaker Studio: 2 games, otherwise .
This attribute is UMT-only and does not exist in GameMaker.
The x coordinate of the tile in the room. The y coordinate of the tile in the room. From which tileset / background the tile stems from. From which sprite this tile stems from. From which object this tile stems from.
Will return a if is , a if it's .
The x coordinate of the tile in . The y coordinate of the tile in . The width of the tile. The height of the tile. The depth value of this tile. The instance id of this tile. The x scale that's applied for this tile. The y scale that's applied for this tile. Returns the texture page item of the tile. This attribute is UMT-only and does not exist in GameMaker. The layer type for a specific layer. In Game Maker: Studio 2, , are empty and are used instead. The layer is a path layer. It's unknown why this layer is saved in the game data, it doesn't have any data in it ( is ). The layer is a background layer. The layer is an instances layer. The layer is an assets layer. The layer is a tiles layer. The layer is an effects layer. The layer is a path layer, in 2024.13+ only. A layer with properties as it's used in a room. Game Maker: Studio 2 only. The room this layer belongs to. This is an UndertaleModTool-only property; it doesn't exist in game data. The name of the layer. The id of the layer. The type of this layer. The depth of this layer. Invokes PropertyChanged on the TileData property. Use when mutating the TileData e.g alongside XAML. Reads 2024.2+ compressed RLE tile data. Where to deserialize from. Writes 2024.2+ compressed RLE tile data. Where to serialize to. The opposite angle of the current rotation. This attribute is UMT-only and does not exist in GameMaker. A horizontal offset relative to top-left corner of the sprite instance. Used for proper sprite instance rotation display in the room editor and for determining .
This attribute is UMT-only and does not exist in GameMaker.
A vertical offset relative to top-left corner of the sprite instance. Used for proper sprite instance rotation display in the room editor and for determining .
This attribute is UMT-only and does not exist in GameMaker.
A horizontal offset used for proper sprite instance position display in the room editor. This attribute is UMT-only and does not exist in GameMaker. A vertical offset used for proper sprite instance display in the room editor. This attribute is UMT-only and does not exist in GameMaker. Generates a random name for this instance, as a utility for room editing. The opposite angle of the current rotation. This attribute is UMT-only and does not exist in GameMaker. Generates a random name for this instance, as a utility for room editing. Generates a random name for this instance, as a utility for room editing. A simple list of instance IDs, as used in GameMaker 2024.13 and above. A script entry in a data file. The name of the script entry. The object which contains the code. Whether or not this script is a constructor. Possible playback modes for sequences. Sequence plays one time and stops. Sequence loops to the beginning. Upon reaching either end, the sequence reverses direction. Playback mode of the sequence. Playback speed of the sequence, in the unit specified by . Unit used for . Length (duration) of the sequence. X origin of the sequence. Y origin of the sequence. Volume for audio in the sequence. Width of the sequence, used in GameMaker 2024.13 and above. Height of the sequence, used in GameMaker 2024.13 and above. List of broadcast message keyframes in the sequence. List of moment keyframes in the sequence. List of root-level tracks in the sequence. List of function IDs contained in the sequence. A keyframe of data stored within a sequence track, at a given time/duration, and for some number of channels. Type of data this keyframe will hold. Start time of the keyframe. Duration of the keyframe. Whether the keyframe has "stretch" enabled. (TODO: unsure what this means.) Whether the keyframe is disabled. Channels of the keyframe, containing actual values. Usually, there's 1 channel for 1D properties (such as image index/speed), and 2 channels for 2D properties (position, scale), etc. A channel for a keyframe, containing the channel number and the value for that channel. Channel ID to use. Generally starts at 0, and increments per each channel. Value of the keyframe for this channel. Broadcast message keyframe data, as used in a sequence. List of messages being broadcasted by this keyframe. Moment keyframe data, as used in a sequence. List of events being triggered by this keyframe. A track in a sequence, potentially containing keyframes or sub-tracks. Some known builtin track names. Some known track traits. Name for the type/model of track, such as "GMGroupTrack", "GMInstanceTrack", "GMRealTrack", etc. Name of the track. Can be user-assigned or the name of a property or asset. Builtin name for the track, representing the type of property, or 0 if not applicable. Traits for the track. Whether the track is a creation track. Tags for the track. List of sub-tracks of this track. Keyframe store of this track, or if none is used. Owned resources of this track (such as animation curves). String used for owned animation curve resources. Base interface used for track keyframes. Base implementation of track keyframes, containing a simple list of keyframes. Type used for keyframe data. List of keyframes in the track. Keyframe data implementation for a resource ID reference. Type of the resource being referenced. Type of the chunk for the resource being referenced. Resource ID reference. Keyframe data implementation for a simple 32-bit integer. Value of the 32-bit integer. Keyframe store for audio keyframes. Audio keyframe data, referencing sound assets. The mode of the audio keyframe. Keyframe store for instance keyframes. Instance keyframe data, referencing game object assets. Keyframe store for graphic keyframes. Graphic keyframe data, referencing sprite assets. Keyframe store for sequence keyframes (sub-sequences). Sequence keyframe data, referencing sequence assets. Keyframe store for sprite frame keyframes. Sprite frame keyframe data, which are simple frame indices. Keyframe store for boolean keyframes. Boolean keyframe data, which are simple integers. Keyframe store for string keyframes. String keyframe data, which are just string references. String reference for the keyframe. Base implementation for keyframe data that can use animation curves. Whether the referenced curve (if applicable) is an embeddded curve, using . If is , this represents the embedded animation curve. If is , this is a reference to an external animation curve asset. Keyframe data for a 32-bit integer that can be associated with an animation curve. 32-bit integer value. Keyframe store for integer keyframes that can be associated with an animation curve. Interpolation mode; 0 is for no interpolation, 1 is for linear interpolation. Keyframe data for a 32-bit float that can be associated with an animation curve. 32-bit float value. Keyframe store for float keyframes that can be associated with an animation curve. Interpolation mode; 0 is for no interpolation, 1 is for linear interpolation. Keyframe store for text keyframes. Text keyframe data, containing various text display properties. Text to be displayed. Whether line wrapping is enabled. Vertical alignment. Horizontal alignment. Font asset index. Keyframe store for particle system keyframes. Particle system keyframe data, referencing particle system assets. A function ID entry as used in . ID of the function entry. Name of the function. A shader entry for a data file. The vertex shader attributes a shader can have. The name of the vertex shader attribute. The name of the shader. The type the shader uses. The GLSL ES vertex code this shader uses. The GLSL ES fragment code this shader uses. The GLSL vertex code this shader uses. The GLSL fragment code this shader uses. The HLSL9 vertex code this shader uses. The HLSL9 fragment code this shader uses. The version of this shader entry. The HLSL11 Vertex data of this shader. The HLSL11 Pixel data of this shader. The PSSL Vertex data of this shader. The PSSL Pixel data of this shader. The Cg_PSVita Vertex data of this shader. The Cg_PSVita Pixel data of this shader. The Cg_PS3 Vertex data of this shader. The Cg_PS3 Pixel data of this shader. A list of Vertex Shader attributes this shader uses. Initializes a new instance of . Possible shader types a shader can have. All console shaders (and HLSL11?) are compiled using confidential SDK tools when GMAssetCompiler builds the game (for PSVita it's psp2cgc shader compiler). Shader uses GLSL_ES Shader uses GLSL Shader uses HLSL9 Shader uses HLSL11 Shader uses PSSL PSSL is a shading language used only in PS4, based on HLSL11. Shader uses for the PSVita Cg stands for "C for graphics" made by NVIDIA and used in PSVita and PS3 (they have their own variants of Cg), based on HLSL9. Shader uses Cg for the PS3 Cg stands for "C for graphics" made by NVIDIA and used in PSVita and PS3 (they have their own variants of Cg), based on HLSL9. Sound entry in a data file. Audio entry flags a sound entry can use. Whether the sound is embedded into the data file. This should ideally be used for sound effects, but not for music.
The GameMaker documentation also calls this "not streamed" (or "from memory") for when the flag is present, or "streamed" when it isn't.
Whether the sound is compressed. When a sound is compressed it will take smaller memory/disk space. However, this is at the cost of needing to decompress it when it needs to be played, which means slightly higher CPU usage. Whether the sound is decompressed on game load. When a sound is played, it must be loaded into memory first, which would usually be done when the sound is first used. If you preload it, the sound will be loaded into memory at the start of the game. Whether this sound uses the "new audio system". This is default for everything post GameMaker Studio. The legacy sound system was used in pre Game Maker 8. The name of the sound entry. This name is used when referencing this entry from code. The flags the sound entry uses. These effectively control different options of this sound. The file format of the audio entry. This includes the . from the file extension. Possible values are: .wav .mp3 .ogg The original file name of the audio entry. This is the full filename how it was loaded in the project. This will be used if the sound effect is streamed from disk to find the sound file. A pre-GameMaker Studio way of having certain effects on a sound effect. The exact way this works is unknown. But following values are possible: Chorus, Echo, Flanger, Reverb, Gargle, all possible to be combined with one another. The volume the audio entry is played at. The volume is a number between 0 and 1, which mean "completely silent" and "full volume" respectively. Whether the sound is decompressed on game load. The pitch change of the audio entry. The audio group this audio entry belongs to. These can only be used with the regular audio system. The reference to the audio file. This is a UTMT-specific attribute.
All sound entries always have to have a reference to an entry. Even if the sound entry is not embedded, it is still necessary. For that case, you can just link to any embedded sound.
The id of . The id of . The precomputed length of the sound's audio data. Introduced in GameMaker 2024.6. Invoked whenever the effective value of any dependency property has been updated. Sprite entry in the data file. The name of the sprite. The width of the sprite. The height of the sprite. The left margin of the sprite. The right margin of the sprite. The bottom margin of the sprite. The top margin of the sprite. Whether the sprite should be transparent. Whether the sprite should get smoothed. Whether the sprite should get preloaded. The bounding box mode of the sprite. TODO: double check if the possible values here are automatic, full image and manual The separation mask type this sprite has. The x-coordinate of the origin of the sprite. The y-coordinate of the origin of the sprite. A wrapper that also sets accordingly. This attribute is used only in UndertaleModTool and doesn't exist in GameMaker. A wrapper that also sets accordingly. This attribute is used only in UndertaleModTool and doesn't exist in GameMaker. The frames of the sprite. The collision masks of the sprite. Creates a new mask entry for this sprite. Data that this sprite is part of, for checking the GameMaker version. The new mask entry. Different formats a sprite can have. Normal format. SWF format. Spine format. Vector format (e.g., SVGs). Different Separation mask types a sprite can have. Width of this sprite mask. UTMT only. Height of this sprite mask. UTMT only. Returns the width and height of the collision mask for this sprite, which changes depending on GameMaker version. Calculates the width and height of a collision mask from the given margin/bounding box. This method is used to calculate collision mask dimensions in GameMaker 2024.6 and above. Calculates the width and height of a collision mask from a given sprite's full width and height. This method is used to calculate collision mask dimensions prior to GameMaker 2024.6. This simply returns the width and height supplied, but is intended for clarity in the code. The width of the Spine atlas in pixels. The height of the Spine atlas in pixels. The atlas as raw bytes, can be a GameMaker QOI texture or a PNG file. Null for versions >= 2023.1. The length of the corresponding sprite texture entry for versions >= 2023.1. Indicates whether contains a GameMaker QOI texture (the header is qoif reversed). Unknown purpose. Probably to accomodate for new texture formats. Presumably present in GM 2022.1+. Unknown purpose. Probably to accomodate for new texture formats. Presumably present in GM 2022.1+. A string entry a data file can have. The contents of the string. Initializes a new empty instance of type . Initializes a new instance of type with a specified content. The content for the string. Returns a string that represents the current object. Whether the string is from a GameMaker Studio 2 data file or not. A string that represents the current object. Unescapes text for the assembler. The text to unescape. A string which features the text \n, \r, " and \ being properly unescaped. A tag entry in a GameMaker data file. Tags are a GameMaker: Studio 2.3+ feature. A texture group info entry in a data file. This is a new chunk since Bytecode 17. It's probably related to performance improvements mentioned in the release notes for that runtime. Here is the specification: TGIN structure - likely stands for Texture Group Info Chunk introduced in 2.2.1 with new texture functions --- Int32 - probably chunk format version number, always 1 PointerList<T> structure. Each item represents a texture group: 32-bit string pointer - Name 32-bit pointer #1 32-bit pointer #2 32-bit pointer #3 32-bit pointer #4 32-bit pointer #5 #1 leads here: SimpleList<int> of texture page IDs the group has #2 leads here: SimpleList<int> of sprite IDs the group has #3 leads here: SimpleList<int> of Spine sprite IDs (normal sprite ID, just this has Spine sprites separated) the group has #4 leads here: SimpleList<int> of font IDs the group has #5 leads here: SimpleList<int> of tileset IDs the group has . The name of the texture group info entry. A list of texture pages the group has. A list of sprites the group has. A list of spine sprites the group has. A list of fonts the group has. A list of tilesets this group has. Directory of the texture on disk. 2022.9+ only. File extension of the texture on disk. 2022.9+ only. The load type of the texture. 2022.9+ only. The possible load types of a texture in 2022.9 and above. Old versions default to "InFile". The texture data is located inside this file. The textures of the group this belongs to are located externally May mean more specifically that textures for one texture group are all in one file. The textures of the group this belongs to are located externally. May mean more specifically that textures are separated into different files, within the group. Initializes a new instance of . A texture page item in a data file. The way a texture page item works is:
It renders in a box of size x at some position.
, , and are relative to the bounding box, anything outside of that is just transparent.
, , and are part of the texture page which are drawn over , , , .
The name of the texture page item. The x coordinate of the item on the texture page. The y coordinate of the item on the texture page. The width of the item on the texture page. The height of the item on the texture page. The x coordinate of the item in the bounding rectangle. The y coordinate of the item in the bounding rectangle. The width of the item in the bounding rectangle. The height of the item in the bounding rectangle. The width of the bounding rectangle. The height of the bounding rectangle. The texture page this item is referencing Replaces the current image of this texture page item to hold a new image. The new image that shall be applied to this texture page item. A timeline in a data file. A specific moment in a timeline. After how many steps this moment gets executed. The actions that get executed at this moment. Initializes a new empty instance of the class. Initializes a new instance of the with the specified step time and event action list. After how many steps the moment shall be executed. A list of events that shall be executed. The name of the timeline. The moments this timeline has. Comparable to keyframes. Interface for all UI layer node data. Structure containing a UI node. This abstraction is required to work with UI node polymorphism correctly. Inner UI node for the node structure. Root structure containing a root-level UI node. Represents a value used for UI flex nodes; a float corresponding with its unit. Units to be used for flex values. Floating point value. Unit for the floating point value. Initializes a flex value. Reads a flex value from the given reader. Serializes a flex value to the given writer. Interface for UI layout nodes that have flex properties. Alignment types that can be used for aligning content in a flexbox. Flex direction types that can be used in a flexbox. Wrap types that can be used in a flexbox. Justification types that can be used in a flexbox. Layout direction types that can be used in a flexbox. Alignment of child items within the container (along cross axis). Main direction that child items are laid out (affects direction of other properties). Wrapping type for the flexbox (when items exceed the bounds). Alignment of lines within the container (along cross axis), when items are wrapped to multiple lines. Gap between rows of items. Gap between columns of items. Left padding of the container. Right padding of the container. Top padding of the container. Bottom padding of the container. Alignment of child items within the container (along main axis, i.e. main flex direction). Layout direction of the container. Serializes flex properties to the given writer. Unserializes flex properties from the given reader. Interface for UI node instances that have flex properties. Whether the instance is visible. Anchor of the instance's (0, 0) position, based on container. Whether the width of the instance is stretched to fit its container. Whether the height of the instance is stretched to fit its container. Whether the instance is tiled horizontally. Whether the instance is tiled vertically. Whether aspect ratio should be maintained when stretching width/height. Serializes flex instance properties to the given writer. Unserializes flex instance properties from the given reader. Base class of all UI container nodes. Child nodes of the container. Represents a UI layer node. Coordinate spaces used for drawing UI layers. Name of the UI layer node. Coordinate space used for drawing the UI layer node. Whether the UI layer node is visible. Represents a UI flex panel node. Position types for flex panels. Name of the UI flex panel node. Width of the flex panel. Height of the flex panel. Minimum width of the flex panel. Minimum height of the flex panel. Maximum width of the flex panel. Maximum height of the flex panel. Left offset of the flex panel. Right offset of the flex panel. Top offset of the flex panel. Bottom offset of the flex panel. Whether the flex panel clips its contents. Position type of the flex panel. How the flex panel aligns itself. Left margin of the flex panel. Right margin of the flex panel. Top margin of the flex panel. Bottom margin of the flex panel. Flex grow property of the flex panel. Flex shrink property of the flex panel. Represents a UI game object node. Represents a UI sequence instance node. Represents a UI sprite instance node. Represents a UI text item instance node. Represents a UI effect layer node. Whether the effect layer is enabled. Effect type for the effect layer. List of effect properties for the effect layer. A variable entry in a GameMaker data file. The name of the Variable. The type of the variable. TODO: some id? OBSOLETE. This variable is now located at . Base interface for managing game file backups and restoration, when installing/uninstalling mods. Attempts to restore modified game files to their original state. Throws a if a recoverable error occurs (i.e., game files are not potentially left in a corrupted state). Any other exception could imply game file corruption. Backs up a file at the given absolute path, whether or not it actually exists currently. Absolute path of the file to be backed up. Throws an exception if the backup fails for any reason; this should disallow all further game modifications. After all files in a mod are backed up, the manifest will need to be saved via to release its lock. Backs up a directory's existence (no contents) at the given absolute path, whether it is/was being created or otherwise deleted. Absolute path of the directory to be backed up. Whether the directory is/was newly-created (and thus should be removed during restoration); otherwise, will be assumed as deleted. Saves the manifest that has been built using , or does nothing if no manifest has been built. No-op implementation of game file backups and restoration (nothing is backed up, and nothing is restored). No-op implementation of game file backups and restoration (nothing is backed up, and nothing is restored). Default implementation of game file backups and restoration. Default implementation of game file backups and restoration. Directory of the game files. Filename used for mod backup manifests. Version number of manifests that this library version is able to read/write. Generally should be backwards-compatible. All manifest versions that this library version is able to read. Default directory name used for storing mod backup files. If the directory name is taken, an additional number will be appended to the end of the name. Backup manifest currently being built as part of mod installation. FileStream used to hold a lock on the backup manifest. Set of relative paths to all files that are in the building backup manifest. Set of relative paths to all directories that are in the building backup manifest. Creates a manifest if one hasn't already been created Saves the manifest that has been built using , or does nothing if no manifest has been built. Simple conversion from a byte array to string representation. Used for serializing manifest information for backup files and directories. Manifest version number, for managing upgrades (and detecting incompatibility) correctly. Relative path from the game data to the directory containing backup files. List of backup files. List of backup directories. A single backup file entry, as stored in a backup manifest. Path of the file in regular game data. Path of the backed-up file, or if no backup exists. No backup can naturally occur when a file is newly-added as part of a mod (and should just be deleted during a restore). SHA-1 hash of the backed-up file, or if this hash should not be verified. A single backup directory entry, as stored in a backup manifest. Path of the directory in regular game data. Whether the directory was newly-created as part of mod installation (and should be deleted upon restoration, if possible). Otherwise, the directory is assumed to have been deleted and will be re-created upon restoration. Interface for extending an asset to be usable in a serializable project file format. User-friendly name to be used in project-related interfaces. Serializble asset type to be used in project-related interfaces. Whether this asset is eligible for being exported to a project. Generates a serializable project version of this asset, within the given project context. Context of the project. A serializable version of this asset. A project asset that has been converted into a serializable form, to be put on disk. Name to be used for this asset directly in game data. Static asset type for this asset. Static boolean for whether this asset type requires an individual directory per each asset. Optional integer override for asset importing order. This has higher precedence over all alphabetical sorting, and is ordered ascending. Serializes this project asset to a destination (main) filename, along with any other files that need to be saved. Performs any pre-import operations for importing this asset into game data, such as finding/creating a blank asset. Context of the project. Imports this serializable asset into game data, within the given project context. Context of the project. A raw/regular version of this serializable asset, as contained (or added) to game data. Imports any textures for the asset. Context of the project. Texture packer currently being used for packing. All supported serializable asset types. These names are directly used for JSON type discriminators; changing them should be avoided. Extensions for serializable asset types. Converts the serializable asset type to its friendly interface name representation. Converts the serializable asset type to its filesystem/directory name representation. Converts the serializable asset type to its filesystem/directory name representation. Converter to specifically not pretty-print a property. Represents a context around a specific (mod) project, as exists on disk. Name of the project. Project flags, denoting certain features that the project may use (including custom ones, which start with an underscore). Whether script importing should be allowed on this project context. This can be disabled as one layer of a security measure, but projects should already be trusted/audited before importing. Current directory associated with loading data for this project. Must always be set. Current directory associated with saving data for this project. Must always be set. Current data file path associated with this project, for loading only, or if none is assigned. Current data file path to save to, when saving the game data (not the project itself), or if none is assigned. Path to the main data file for the game. Will be (or is at least intended to be) saved to. Path to the main directory containing the game data. Should contain , and similar to it, is intended to be saved to. Whether this context has any unexported assets. Event for when any assets are added to or removed from this project context. This action should be called when main-thread operations need to occur. When the action is called, supplied action argument *must* be executed synchronously. That is, the action must return only after the argument callback has completed execution. Current data context associated with this project, or if none is assigned. Lookup of asset paths that existed when loading on disk, by data name and asset type. Texture worker used during exporting. Game file backup instance. Generic options to use for writing JSON. Tuple of an asset's data name and serializable asset type. Tuple of an asset's data name and serializable asset type. Initializes a project context based on its existing main file path, as well as load/save directories. Path of the directory for game data to be loaded from. Path of the directory for game data to be saved to. Main file path for the project. Initializes a project context based on its existing main file path, as well as load/save directories. Path of the directory for game data to be loaded from. Path of the directory for game data to be saved to. Main file path for the project. Initializes a project context based on its existing main file path, as well as load/save data file paths. Path of the data file for game data to be loaded from. Path of the data file for game data to be saved to. Main file path for the project. Initializes a project context for a new project based on its main file path, and a name to give to it. Current data context to associate with the project. Path of the data file that was loaded for the current data context. Path of the data file to be saved to. Main file path for the project. Name of the new project being created. For operations that should occur on the main thread, this will be called to invoke those operations, if provided. This will stick around for the lifetime of the project context. When a project-specific exception occurs Imports all of the data of the project. Current data context to associate with the project. For operations that should occur on the main thread, this will be called to invoke those operations, if provided. This will stick around for the lifetime of the project context. If this project context is being invoked as part of larger changes to game data, or an alternative backup implementation is desired (including no-op), an existing instance can be used to back up files. When a project-specific exception occurs Marks an asset for export. Asset to mark for export. If the asset was not marked for export previously, returns ; otherwise. Unmarks an asset for export. Asset to unmark for export. If the asset was marked for export previously, returns ; otherwise. Returns whether the given asset is marked for export currently. Asset to check whether marked for export. If the asset is marked for export, returns ; otherwise. Returns an enumerable over all currently unexported assets, in an arbitrary order. Attempts to retrieve project source code for the given code entry. Code entry to look for source code for. Output for source code, when found; if nothing is found. if source was successfully retrived; otherwise. Updates the source code associated with the given code entry. Code entry to update the associated source code for. New source code to use. Exports all assets that are marked for export. Whether to clear the current set of assets marked for export. When a project-specific exception occurs Recompiles all code entries in the project's data file for which the plaintext source code is known. Thrown upon compilation failure. Performs the main project asset import operations. Comparer for two serializable project assets, for deterministic imports. Tries to find a sprite with the given name, if not null or whitespace, for the given serializable project asset. Sprite that was found, or null. Tries to find a background with the given name, if not null or whitespace, for the given serializable project asset. Background that was found, or null. Tries to find a font with the given name, if not null or whitespace, for the given serializable project asset. Font that was found, or null. Tries to find a font index with the given name, if not null or whitespace, for the given serializable project asset. Font index that was found. If not found, an exception is thrown. Tries to find a game object with the given name, if not null or whitespace, for the given serializable project asset. Game object that was found, or null. Tries to find a game object index with the given name, if not null or whitespace, for the given serializable project asset. Game object index that was found. If not found, an exception is thrown. Tries to find a code entry with the given name, if not null or whitespace, for the given serializable project asset. Code entry that was found, or null. Tries to find a sequence with the given name, if not null or whitespace, for the given serializable project asset. Sequence that was found, or null. Tries to find a particle system with the given name, if not null or whitespace, for the given serializable project asset. Particle system that was found, or null. Tries to find a sound with the given name, if not null or whitespace, for the given serializable project asset. Sound that was found, or null. Tries to find an animation curve with the given name, if not null or whitespace, for the given serializable project asset. Animation curve that was found, or null. Finds or creates a string with the given string contents, or returns if is . Handles non-custom flags defined in the project main options. Verifies the game version matches, based on known Imports all sub-projects, as defined in the project options. Imports all external files, as found in locations (file/directory paths) defined in the project options. Applies all file operations (copy/delete), as defined in the project options. Applies all file patches, located as defined in the project options. Helper method to copy a directory to another directory, ignoring hidden folders and files. Attempts to find a valid file from the given path list, outputting the first valid path pair found, or if none are valid. This method will search relative to , and will also verify path destinations relative to . if a valid path pair was found; otherwise. Returns a version of given string as a valid identifier to be used in a filename. Requests the for an audiogroup, from the loaded or saving data file's directory. Only works during loading a project. Copies an audio file from the source path, to the destination filename (relative to 's directory). Only should be used during project loading. Loads the main assets data file from . Saves the main assets data file to . Creates a new backup using the default implementation, and restores game files to an unmodded state. Finishes the backup process, assuming that the backup was created by this project context, for this project context. Script options for the project context, when initialized. Full path to currently-executing script, or if no script is executing. Initializes scripting for this context, if not already done. Deinitializes scripting for this context, if necessary. Runs a list of scripts based on their relative paths to the project context's root. Executes all pre-import scripts, as defined in the project options. Executes all pre-asset import scripts, as defined in the project options. Executes all pre-import scripts, as defined in the project options. Represents the main options file for a project. Name for the project. List of flags enabled for the project. Flag names beginning with an underscore (_) are treated as custom flags, for any use. Non-custom flag names will throw an exception if not handled by the current library version. List of strings to verify in the loaded data file before completing project import. Path to the default data file path to have project assets imported to, or none to disable asset importing during installation. Whether loading/saving the project's data files should raise an error when any warnings occur. List of root-level directory names to exclude from the project. List of relative paths to sub-project JSON files. List of file patches to be applied. List of paths to directories and files that should be copied to the save directory when applying the project. List of file paths to be copied from one location to another, within the game data. List of file paths to be deleted within the game data. List of relative paths to scripts to be executed prior to all import operations. List of relative paths to scripts to be executed just prior to project asset import operations. List of relative paths to scripts to be executed after all import operations. Represents a patch file to be applied to a game data file. Represents a patch file to be applied to a game data file. Relative path to the patch file. List of possible paths to the data file to be patched. Represents a file operation to be performed upon project import. Represents a file operation to be performed upon project import. Possible source/destination paths for the file operation, from which only one will be used. Whether the file operation is required. That is, if no valid source paths are found, this will be checked to know whether an error should be raised. Represents a list of possible paths to be enumerated, with both sources and destinations (which may be the same). Represents a list of possible paths to be enumerated, with both sources and destinations (which may be the same). List of paths (including source and destination, which may be the same). Source and destination path pair. Both paths may be the same. Source and destination path pair. Both paths may be the same. Whether the path list is empty. JSON converter for path lists. JSON converter for path pairs within path lists. JSON converter for path lists. A serializable version of . Populates this serializable animation curve with data from an actual animation curve. Imports this asset as a sub-resource of another asset. A serializable version of . GMS2+ tileset properties. Struct for GMS2+ tileset properties. Struct for GMS2+ tileset properties. Populates this serializable background with data from an actual background. A serializable version of . Populates this serializable code with data from an actual code asset. Queues this code asset to be compiled. A serializable version of . Populates this serializable font with data from an actual font. A serializable version of . Data name of the sprite assigned to the object, or if none is assigned. See . Data name of the parent object assigned to the object, or if none is assigned. See . Data name of the mask sprite assigned to the object, or if none is assigned. See . Simplified representation of , with one action, tied to a single code entry. Event category. Event subtype, differing depending on . See . Data name of the code entry assigned to this event, or if none is assigned. See . Populates this serializable game object with data from an actual game object. Converts an event subtype (for a given category) to a string representation. Converts a string representation of an event subtype (for a given category) to its integer value. Imports the data from this object into the given data file. A serializable version of . Populates this serializable path with data from an actual path. A serializable version of . List of indices corresponding to , or -1 if a nonexistent object instance. Populates this serializable room with data from an actual room. Converts tile data from a 2d array to a 1d list, to be serialized as JSON. Converts tile data from a 1d list to a 2d array. A serializable version of . Populates this serializable script with data from an actual script. A serializable version of . Populates this serializable sequence with data from an actual sequence. Imports this asset as a sub-resource of another asset. A serializable version of . Populates this serializable script with data from an actual script. Serializes an individual plaintext shader file. Serializes an individual binary shader file. Imports an individual plaintext shader file. Imports an individual binary shader file. A serializable version of . Whether the sound file is streamed externally from the main data file (or any audio group files). Mutually exclusive with . Whether the sound if decompressed on load, if the sound data is OGG. Mutually exclusive with . Populates this serializable sound with data from an actual sound. A serializable version of . Number of textures for the sprite, to be put on disk. Number of collision masks for the sprite, to be put on disk. Extra properties, optionally defined. Sequence contained within the sprite, optionally defined. Nine-slice properties, optionally defined. Texture importing properties, optionally defined. Extra properties attached to sprites, but not always present in older versions of GameMaker. Extra properties attached to sprites, but not always present in older versions of GameMaker. Nine-slice properties attached to sprites, optionally. Nine-slice properties attached to sprites, optionally. Texture (group) information attached to sprites, optionally. Not mirrored directly in GameMaker's data format, but will affect importing. Texture (group) information attached to sprites, optionally. Not mirrored directly in GameMaker's data format, but will affect importing. Whether cropping should be allowed when placing textures on the atlas during importing. Populates this serializable sprite with data from an actual sprite. An exception type that is thrown when trivial errors happen during runtime of UndertaleModTool scripts.
This exception does not contain a stacktrace, and should more be handled like an error message that stops execution of the currently-running script.
if (Data is null) throw new ScriptException("Please load data.win first!");
Initializes a new instance of the ScriptException class with its message string set to the empty string (""). Initializes a new instance of the ScriptException class with its message string set to . A that describes the error. The content of is intended to be understood by humans. An exception type that is thrown when a script is cancelled by a user, e.g. due to input data not being supplied.
This exception does not contain a stacktrace, and should more be handled like an error message that stops execution of the currently-running script.
if (Data is null) throw new ScriptCancelledException("The import folder was not set.");
Initializes a new instance of the ScriptCancelledException class with its message string set to the empty string (""). Initializes a new instance of the ScriptCancelledException class with its message string set to . A that describes the error. The content of is intended to be understood by humans. Defines a generalized set of attributes and methods that a value type or class implements to be able to interact with UndertaleModTool-Scripts. The data file. Currently-open project context, if one is active, or . The file path where resides. The path of the current executed script. The object that's currently highlighted in the GUI. The object that's currently selected in the GUI. Indicates whether saving is currently enabled. Indicates whether the last script executed successfully or not. Error message of the last executed script. Will be "" () if no error occurred. Path of the main executable that's currently running. For example C://Users/me/UMT/UMT.exe or /bin/UMTCLI. A string, detailing the type of the last encountered error. Indicating whether the Program is currently closed. //TODO: Only GUI + ExportAllRoomsToPng.csx uses this, but nothing should ever need to access this value. "somehow Dispatcher.Invoke() in a loop creates executable code queue that doesn't clear on app closing." An action that can be called to execute code on the main thread, useful for syncing with a GUI. If this is not required, it may be implemented as a pass-through call to the provided action. When the action is called, supplied action argument *must* be executed synchronously. That is, the action must return only after the argument callback has completed execution. Ensures that a valid data file () is loaded. An exception should be thrown if it isn't. Creates a new Data file asynchronously. if successful, if not. Used in scripts in order to show a message to the user. The message to show. Used in scripts in order to show a warning message to the user. The warning message to show. Sets the message of the variable holding text from the console. Currently only used in GUI. The message to set it to. Used in Scripts in order to ask a yes/no question to the user which they can answer. The message to ask. if user affirmed the question, if not. Used in scripts in order to show an error to the user. The error message to show. A short-descriptive title. Whether to call with . Used in Scripts in order to open a URL in the users' browser. The URL to open. Run a C# UndertaleModLib compatible script file. File path to the script file to execute. A that indicates whether the execution of the script was successful. Lint whether a file is C# UndertaleModLib compatible. File path to the script file to lint. A that indicates whether the linting was successful. Initializes a Script Dialog with default values Get the decompiled text from a code entry (like gml_Script_moveTo). The name of the code entry from which to get the decompiled code from. The GlobalDecompileContext to use for decompilation. The settings to use for decompilation, or to use the default. Decompiled text as a . This will return a string, even if the decompilation failed! Usually commented out and featuring DECOMPILER FAILED! . Get the decompiled text from an object. The object from which to get the decompiled code from. The GlobalDecompileContext to use for decompilation. The settings to use for decompilation, or to use the default. Decompiled text as a . This will return a string, even if the decompilation failed! Usually commented out and featuring DECOMPILER FAILED! . Get the disassembly from a code entry (like gml_Script_moveTo). The name of the code entry from which to get the disassembly from. Disassembly as . This will return a string, even if the disassembly failed! Usually commented out and featuring DISASSEMBLY FAILED! . Get the disassembly from an object. The object from which to get the disassembly from. Disassembly as . This will return a string, even if the disassembly failed! Usually commented out and featuring DISASSEMBLY FAILED! . Check whether two files are identical. File path to first file. File path to second file. A that indicates whether the files are identical or not. Allows the user to input text with the option to cancel it. A short descriptive title. A label describing what the user should input. The default value of the input. The text of the cancel button. The text of the submit button. Whether to allow the input to have multiple lines. Whether the window is allowed to be closed. Should this be set to , then there also won't be a close button. The text that the user inputted. Allows the user to input text in a simple dialog. A short descriptive title. A label describing what the user should input. The default value of the input. Whether to allow the input to have multiple lines. Whether to block the parent window and only continue after the dialog is cleared. The text that the user inputted. Shows simple output to the user. A short descriptive title. A label describing the output. The message to convey to the user. Whether to allow the message to be multiline or not. Should this be false but have multiple lines, then only the first line will be shown. Shows search output with clickable text to the user. A short descriptive title. The query that was searched for. How many results have been found. An of type , with TKey being the name of the code entry an TValue being a list of tuples where the first item is the matching code line number and the second one is the code line itself. Whether to open the "Decompiled" view or the "Disassembly" view when clicking on an entry name. A list of code entries that encountered an error while searching. A task that represents the search output. Shows search output with clickable text to the user. A short descriptive title. The query that was searched for. How many results have been found. A with TKey being the name of the code entry and TValue being a list of tuples where the first item is the matching code line number and the second one is the code line itself. Whether to open the "Decompiled" view or the "Disassembly" view when clicking on an entry name. A list of code entries that encountered an error while searching. A task that represents the search output. Sets whether or not the current script should show a message indicating that it completed. True to enable the finished message; false otherwise. Updates the progress bar. Not to be called directly in scripts! Use instead! Sets the progress bar dialog to a certain value. What the progress bar is describing. What the current status is. For example Decompiling.... The value to set the progress bar to. The max value of the progress bar. Show the progress bar. Updates the value of the current running progress bar dialog. The new value to set the progress bar to. Updates the status of the current running progress bar dialog. The new status. For example Decompiling.... Adds a certain amount to the variable holding a progress value. The amount to add. Increments the variable holding a progress value by one. Adds a certain amount to the variable holding a progress value in. Used for parallel operations, as it is thread-safe. The amount to add. Increments the variable holding a progress value by one. Used for parallel operations, as it is thread-safe. Gets the value of the variable holding a progress value. The value as . Sets the value of the variable holding a progress variable to another value. The new value for the progress variable. Hides the progress bar. Enables the UI. Starts the task that updates a progress bar in parallel. Stops the task that updates a progress bar in parallel. A task that represents the stopped progress updater. Changes the currently selected in the GUI. The new object that should now be selected. Whether the object should be open in a new tab. Used to prompt the user for a directory. The directory selected by the user. Used to prompt the user for a file. The default extension that should be selected. The filters used for the file select. The file selected by the user. Used to prompt the user for a location to save a file. The default extension that should be used when saving the file. The filters used to specify the file types in the dialog. The file path specified by the user for saving. Serializes this into a specified . Where to serialize to. Deserializes this from a specified . Where to deserialize from. Deserializes the total child object count of this object from specified . Where to deserialize from. The object count. TODO! Where to serialize to. TODO! Where to serialize to. TODO! Where to deserialize from. TODO! Where to serialize to. TODO! Where to deserialize from. Name of the resource. Returns a value indicating whether a specified substring occurs within this object. The string to seek. Case insensitive. if occurs within this object, or if is the empty string (""); otherwise, false. The total child object count of the current object type. Used for the object count unserialization. The summary child objects size of the current object type. Used for the object count unserialization. Lookup from a chunk name to its loaded instance. Lookup from a chunk type to its loaded instance. Constructors for all chunk types. Code count as determined during object counting. An object representing a GameMaker Studio data file. This is basically the heart of the data file, which is usually named data.win, data.unx, data.ios or data.droid, depending for which OS the game was compiled for..
It includes all the data within it accessible by either the -Chunk attribute, but also via already organized attributes such as or . TODO: add more documentation about how a data file works at one point.
Indexer to access the resource list by its name. The resource name to get. if the data file does not contain a property with that name. Indexer to access the resource list by its items type. The resource type to get. if the type is not an . if the data file does not contain a property of that type. The FORM chunk of the data file. General info of the data file. General Options of the data file. Languages of the data file. The used extensions of the data file. The used sounds of the data file. The audio groups of the data file. The sprites of the data file. The backgrounds (or Tilesets) of the data file. The paths of the data file. The scripts of the data file. The global initialization scripts of the data file. The global end scripts of the data file. The used shaders of the data file. The fonts of the data file. The Timelines of the data file. The game objects of the data file. The rooms of the data file. The texture page items from the data file. The code entries of the data file. The used variables of the data file. TODO: Unknown value, need more research. TODO: Unknown value, need more research. TODO: Unknown value, need more research. Also obsolete. TODO: Unknown value, need more research. Also obsolete. TODO: Unknown value, need more research. Also obsolete. TODO: Unknown value, need more research. The functions of the data file. The code locals of the data file. The used strings of the data file. The embedded images of the data file. This is used to store built-in particle sprites, every time you use part_sprite functions. The embedded textures of the data file. The texture group infos of the data file. The embedded audio of the data file. The used tags of the data file. The animation curves of the data file. The sequences of the data file. The feature flags stored in the data file. The filter effects stored in the data file. The particle systems stored in the data file. The particle system emitters stored in the data file. Whether this is an unsupported bytecode version. Whether the Texture Page Items (TPGA) chunk is 4 byte aligned. Whether the data file has short circuiting enabled. Whether the data file has array copy-on-write enabled. The last room particle system instance ID of the data file (incrementing). The first actual usable ID is 8388608. Some info for the editor to store data on. Shows the current padding value. -1 indicates a pre 1.4.9999 padding, where the default is 16. A list of known GameMaker Studio constants and variables. Cache for 2.3-style functions defined in global scripts. Can be re-built by setting this to null. Registry for macro types, their resolvers, and other data specific to this game. An array of a properties with as their type. Initializes new instance. Get a resource from the data file by name. This does a linear search, and will thus be slow if used many times. It's recommended to build lookup maps if many searches are required. The name of the desired resource. Whether to ignore casing while searching. The . Returns the zero-based index of the first occurrence of the specified . This does a linear search, and will thus be slow if used many times. It's recommended to build lookup maps if many searches are required. The object to get the index of. Whether to throw if is not a valid object. The zero-based index position of the parameter if it is found, or -1 if it is not found. is and could not be found. Returns the zero-based index of the first occurrence of the specified . This does a linear search, and will thus be slow if used many times. It's recommended to build lookup maps if many searches are required. The name of the desired resource. Whether to ignore casing while searching. The zero-based index position of the if it is found, or -1 if it is not found. Reports whether the data file was built by GameMaker Studio 2. if yes, if not. Sets the GMS2+ version flag in GeneralInfo. The major version. The minor version. The release version. The build version. If included, alter the data branch between LTS and non-LTS. Sets the branch type in GeneralInfo to the appropriate LTS or non-LTS version based on If included, alter the data branch between LTS and non-LTS. Reports whether the version of the data file is the same or higher than a specified version. The major version. The minor version. The release version. The build version. Whether the version of the data file is the same or higher than a specified version. Reports whether the version of the data file is the same or higher than a specified version, and off the LTS branch that lacks some features. The major version. The minor version. The release version. The build version. Whether the version of the data file is the same or higher than a specified version. Always false for LTS. Returns the ID of the builtin (i.e., embedded in the main data file) audio group. Varies depending on version. ID of the builtin audio group; 0 or 1. Reports whether the data file was compiled with YYC. if yes, if not. TODO: Undocumented helper method. TODO Creates a new empty data file. The newly created data file. An info handle for an editor to store data on. Default settings to be used by the Underanalyzer decompiler, for a tool and in any scripts that desire matching the same settings. Function that returns the prefix to be used when resolving instance ID references in the compiler and decompiler. Extension methods for . An extension method, that returns the element in a of s that has a specified . The of s to search in. The name of the to find. Whether casing should be ignored for searching. A type of . The element that has the specified name. An extension method, that returns the index of an element in a of s that has a specified . The of s to search in. The name of the to find. Whether casing should be ignored for searching. A type of . The index of the element that has the specified name, or -1 if none is found. An extension method, that returns the element in a of s that has a specified . The of s to search in. The name of the to find. Whether casing should be ignored for searching. A type of . The element that has the specified name. An extension method, that returns the index of an element in a of s that has a specified . The of s to search in. The name of the to find. Whether casing should be ignored for searching. A type of . The index of the element that has the specified name, or -1 if none is found. Creates as a new , adds it to a of if it does not exist yet, and returns it. The of . The string to create a of. Whether to create a new if the one with the same content exists. as a . is null. Creates as a new , adds it to a of if it does not exist yet, and returns it. The of . The string to create a of. The index where the newly created is located in . as a . is null. TODO: This is not the cleanest implementation, but I was focusing on clean interface. Could probably use some refactoring or a complete rewrite. Function to delegate warning messages to. Warning message. Whether the warning is deemed important (that is, may risk data loss when re-saving). Function to delegate informational messages to. Informational message. The detected absolute path of the data file, if a FileStream is passed in, or null otherwise (by default). Can also be manually changed. The detected absolute path of the directory containing the data file, if a FileStream is passed in, or null otherwise (by default). Can also be manually changed. Reads a boolean as 32 bits (0 or 1), maintaining alignment. Writes a boolean using 32 bits (0 or 1), maintaining alignment. Basic observable list type, usable for data models to be presented in graphical interfaces. Creates a new observable list, which is empty and has default capacity. Creates a new observable list, which is empty and has the specified initial capacity. Creates a new observable list from the contents of the provided enumerable. Sets the capacity of the internal list of this collection. Sets the capacity of the internal list of this collection. Adds an item to the internal list of this collection (that is, without notifying any observers). Item to add. Simple list object, serialized as a 32-bit count followed immediately by all objects in the list. Creates a new simple list, which is empty and has default capacity. Creates a new simple list, which is empty and has the specified initial capacity. Creates a new simple list from the contents of the provided enumerable. Simple list object, specifically for strings, serialized as a count followed immediately by all strings in the list. Simple list object, serialized as a 16-bit count followed immediately by all objects in the list. Creates a new (short) simple list, which is empty and has default capacity. Creates a new (short) simple list, which is empty and has the specified initial capacity. Creates a new (short) simple list from the contents of the provided enumerable. List of objects that is preceded by an array of pointers, pointing to each object in order. Creates a new pointer list, which is empty and has default capacity. Creates a new pointer list, which is empty and has the specified initial capacity. Creates a new pointer list from the contents of the provided enumerable. Shorthand for containing . Asset types as used in GML code references. Converts an integer asset type to its equivalent, depending on GameMaker version. Converts a to its integer equivalent, depending on GameMaker version. Utility class containing static methods for use in applying BPS file patches. Specification used is in the public domain. Sets an arbitrary safety limit at bytes for base/source and output/target files. Header magic used for BPS patch files, represented in little endian. Safety limit for maximum filesize, including base/source and output/target files. Limited to 4GB, which is the practical limit for GameMaker data files. Applies a BPS file patch from to , with data output to . Will throw an exception if patching fails for any reason, in which case should be cleared/dealt with manually. Decodes a variable-length integer (up to 63 bits) from the current position of the stream. Calculates CRC32 for the stream, starting at its current seek position, for the given length. 32-bit floating point or integer storage, explicitly defined with a backing type as an integer. This helps prevent issues with negative zero being inconsistently handled. Constructs a float from the given 32-bit unsigned integer bit representation. Constructs a float from the given float value. Constructs a float from the given float value. Returns a float from the value. Returns a bit representation of the float as an unsigned 32-bit integer. Storage for int, long, and double, taking exactly the size of a long (64 bits). This is used to compact data sizes on . Constructs from the given 32-bit integer. Constructs from the given 64-bit integer. Constructs from the given 64-bit integer. Asserts that a specified condition is true. The condition to assert for. The message to use if the assertion fails. Gets thrown if the assertion fails. Includes miscellaneous git information about the project to compile. Only intended for Debug use! Gets and returns the git commit and branch name. The git commit and branch name. Immutable wrapper around GameMaker texture images. Supported formats of GameMaker textures. Raw BGRA color format, with 8 bits per channel (32 bits per pixel). PNG file format. GameMaker's custom variant of the QOI image file format. BZip2 compression applied on top of GameMaker's custom variant of the QOI image file format. DDS file format. Unknown or unsupported file format. Will be represented by raw bytes, including any padding. This format cannot be converted to any other format (nor displayed), but can be saved/loaded. Format of this image. Width of this image, in pixels. Height of this image, in pixels. Maximum supported image width or height. PNG file format magic. QOI file format magic. BZip2 + QOI file format magic. Magic value found near the end of a BZip2 stream (square root of pi). DDS file format magic. Backing data for the image, whether compressed or not. If this is a Bz2Qoi image in GameMaker 2022.5 and above, then this is the size of the BZip2 data when entirely uncompressed. Initializes an image with raw format, of the desired width and height. Creates a completely blank image (black, fully transparent). Basic private constructor for use by other creation methods; just initializes the given fields. Searches for the BZ2 footer magic, when around the end of a BZ2 stream, and returns the exact end position of the stream. Finds the end position of a BZ2 stream exactly, given the start and end bounds of the data. Creates a from the image contents stored at the current position of the provided . Binary reader to read the image data from. Location where the image stream must end at or before, from within the . There should only be 0x00 bytes (AKA padding), between the end of the image data and this position. Whether using GameMaker version 2022.5 or above. Relevant only for BZ2 + QOI format images. If no supported texture format is found Image data fails to parse Creates a of PNG format, wrapping around the provided byte array containing PNG data. Byte array of PNG data. Whether to check that the PNG magic exists or not. Invalid PNG data, or image is too large Creates a of BZ2 + QOI format, wrapping around the provided byte array containing BZ2-compressed data (no header). Compressed BZ2 data, excluding the header. Width of the image, as provided in BZ2 + QOI header. Height of the image, as provided in BZ2 + QOI header. Length of BZ2 data when fully uncompressed. Invalid BZ2 + QOI data, or image is too large Creates a of QOI format, wrapping around the provided byte array containing QOI data (GameMaker's custom version). Invalid QOI data, or image is too large Creates a of DDS format, wrapping around the provided byte array containing DDS data. Byte array of DDS data. Creates a of unknown format, wrapping around the provided byte array containing unknown format data. Byte array of unknown format data. Saves this image as a PNG file, writing the data to the provided . Returns the same or a new ; the result of converting this image to the specified . Format to convert to Reusable shared to be used when compressing with BZ2, as required. Returns the same or a new ; the result of converting this image to format. Returns the same or a new ; the result of converting this image to format. Returns the same or a new ; the result of converting this image to format. Compresses the provided QOI data using BZ2, and using the shared , if not null. A new BZ2 + QOI image with the compressed data. Returns the same or a new ; the result of converting this image to format. Shared to be reused for BZ2 compression, if required. Same as . This is supposed to return the image converted to format, but that's not implemented yet. Returns the raw BGRA32 pixel data of this image, which can be modified. Only works if the image format is ; otherwise, you must first convert to that format using . Image format is not . Writes this image, in its current format (as seen on disk), to the current position of the specified . The gm2022_5 parameter is only relevant for images of BZ2 + QOI format. instance to write to. True if using GameMaker 2022.5 format or above; false otherwise. Converts the image to its byte array/span representation (as seen on disk). True if using GameMaker 2022.5 format or above; false otherwise. The gm2022_5 parameter is only relevant for images of BZ2 + QOI format. Returns a new with the contents of this image, if not format. Creates a new raw format with the contents of the provided . This modifies the image format of the provided to avoid unnecessary copies. 32-bit implementation of MurmurHash, for deterministic (but non-cryptographic) hashing. Based on https://en.wikipedia.org/wiki/MurmurHash. Calculates a hash based on a span of characters. The characters will be re-encoded as a UTF-8 buffer before hashing. Calculates a hash based on a span of bytes. 32-bit Murmur hash scramble operation. Path utility functions. Returns if is contained within (starts with) , when the path is converted to be fully-qualified. This can be used for error-checking and simple security purposes. Throws an exception if is not contained within (starts with) . This can be used for error-checking and simple security purposes. Similar to , but verifies that the end result is within using . Similar to , but verifies that the end result is within using . Similar to , but verifies that the end result is within using . Similar to , but verifies that the end result is within using . If not verified, this returns . Similar to , but verifies that the end result is within using . If not verified, this returns . Similar to , but verifies that the end result is within using . If not verified, this returns . A class that converts to and from the GM-custom QOI format. Ported over from DogScepter's QOI converter at . Creates a raw format from a . The stream to create the PNG image from. The QOI image as a raw format image. If there is an invalid QOIF magic header or there was an error with stride width. Creates a raw format from a of s. The of s to create the raw image from. The QOI image as a raw format image. If there is an invalid QOIF magic header or there was an error with stride width. The total amount of data read from the . Creates a QOI image as a byte array from a . The to create the QOI image from. A QOI Image as a byte array. If there was an error with stride width. Creates a QOI image as a from a . The to create the QOI image from. A QOI image as a byte array. Standard scripting utility functions. Creates default scripting options for CSX scripts, with all standard imports/references. Prettifies/stringifies a scripting-caused exception object, dealing with script stack traces and aggregate exceptions. This is a helper class for . The main advantage that this one offers, is that it contains functions to keep appending starting from a position, so that one doesn't have to do that manually. This is an example usage of how this struct is intended to be used: Instead of needing to do var sb = new StringBuilder(); var index = 0; sb.Append("Some String"); index = 4; var stringToInsert = "insertion!"; sb.Insert(index, stringToInsert); index += stringToInsert.Length; var otherString = "another!"; sb.Insert(index, otherString); index += otherString; One can instead do: var sbh = new StringBuilderHelper(); var sb = new StringBuilder(); sb.Append("Some String"); sbh.SetPosition(4); sbh.Append("insertion!"); sbh.Append("another!"); The position from where functions will be executed from. Initializes a new instance. Initializes a new instance with a specific position. The position for this . Appends a copy of the specified string to a at and increases it afterwards. An instance on where a string should be appended to. Appends a copy of the specified string to a at and increases it afterwards. An instance on where a string should be appended to. Appends the specified char to a at and increases it afterwards. An instance on where a string should be appended to. An instance on where a string should be appended to. An instance on where a string should be appended to. An instance on where a string should be appended to. Helper class used to pack images into textures for a single texture group. Maximum allowed texture page size (in terms of width and height) to generate. The amount of extra border pixels each texture entry should be extended by. Whether the texture group being packed allows cropping to occur. Image format to be used by generated textures. Initializes a new texture group packer with the provided texture group settings. Adds an image to be packed by the texture group packer, and returns a texture page item for it. Packs and generates textures for all texture pages for the packer after all images have been added. Imports all generated texture pages and texture items to the supplied game data. Rectangle used for packing images on a texture. Rectangle used for packing images on a texture. Packs and generates a texture for a single texture page, given all remaining images to be packed. Flags used for generating borders for a texture page item. Enables border generation for the pack image. Whether the pack image should tile (wrap around) horizontally when generating its border. Whether the pack image should tile (wrap around) vertically when generating its border. Whether the border of the pack image should be extended by 2 pixels (in older versions) or 1 pixel (in post-GMS2 versions). Represents a single image to be packed as part of a pack/texture page. Represents a single image to be packed as part of a pack/texture page. Source (cropped) image data. Texture item to be populated with data from this image, during final packing. Width of the cropped image data. Height of the cropped image data. X offset into the image at which the crop was performed. That is, this is non-negative. Y offset into the image at which the crop was performed. That is, this is non-negative. Full uncropped image width. Full uncropped image height. Unique incrementing ID to be used for deterministic sorting. Flags defining how the border should be generated for the image on a page. Gets 7 most-significant bits from the color channels of the given pixel. Dedicates 2 bits for MSB of the red channel, 2 bits for MSB of the green channel, 2 bits for MSB of the blue channel, and 1 bit for the MSB of the alpha channel. Computes a 64-bit integer hash of the pack image, based on width, height, border flags, and some image contents. This is used as a heuristic for de-duplicating images during texture packing. Checks whether the pack image is a duplicate of another pack image. This should only be used after has been called on both instances, and the results were equal. Represents a duplicate of a , with its own unique texture item. Represents a duplicate of a , with its own unique texture item. Texture item to be populated with data from this image, during final packing. This is the first/single (non-duplicate) texture item, from which its data can be used to partially populate . X offset into the image at which the crop was performed. That is, this is non-negative. Y offset into the image at which the crop was performed. That is, this is non-negative. Full uncropped image width. Full uncropped image height. Helper class used to manage and cache textures. Retrieves an image representing the supplied texture page. The returned image will be cached for this instance. Texture to get an image from. with the contents of the given texture's image. Exports the given texture page item to disk, as a PNG, to the supplied path. (With or without padding.) Texture page item to export. File path to export to. Image name to be used when throwing exceptions, or null to use the filename from the path. True if padding should be exported; false otherwise. Creates an image representing the sole texture page item supplied, with or without padding. Texture page item to get the image of. Image name to be used when throwing exceptions. True if padding should be used in the returned image; false otherwise. An image with the contents of the given texture page item's portion of its texture page. Reads an image from the given file path (of arbitrary format, as supported by ). Image color format will always be converted to BGRA, with no compression. File path to read the image from. An image, in uncompressed BGRA format, containing the contents of the image file at the given path. Performs a resize of the given image, if required, using the specified interpolation (bilinear by default). Always returns a new image. Image to be resized (without being modified). Desired width to resize to. Desired height to resize to. Pixel interpolation method to use, or specify none to use bilinear interpolation. A copy of the provided image, which is resized to the given dimensions when required. Reads collision mask data from the given file path, and required width/height. Image file to read the mask data from (usually a black-and-white PNG). The width that the collision mask must be (e.g., sprite width or bbox width, depending on version). The height that the collision mask must be (e.g., sprite height or bbox height, depending on version). A byte array, encoding the collision mask as a 1-bit-per-pixel image. If the loaded image dimensions do not match the required width/height Generates and returns a black-and-white image representing a given sprite's collision mask, and with the given width/height. Mask entry to generate the image from. Width of the image to generate (and to interpret the collision mask with). Height of the image to generate (and to interpret the collision mask with). A new black-and-white image representing the specified collision mask. Exports a collision mask entry from a given sprite's collision mask, as a PNG file, at the specified path, and with the given width/height. Mask entry to export the image from. File path to export to. Width of the image to export (and to interpret the collision mask with). Height of the image to export (and to interpret the collision mask with). Saves the provided image as a PNG file, at the specified path. Image to save. File path to save the image to. Returns the width and height of the image stored at the given path, or -1 width/height if the file fails to parse as an image. File path to get the image size from. Width and height of the image stored at the file path, or -1 for both values if invalid. Custom -derived type for the callInstrRegex method. Cached, thread-safe singleton instance. Initializes the instance. Provides a factory for creating instances to be used by methods on . Creates an instance of a used by methods on . Provides the runner that contains the custom logic implementing the specified regular expression. Scan the starting from base.runtextstart for the next match. The text being scanned by the regular expression. Search starting from base.runtextpos for the next location a match could possibly start. The text being scanned by the regular expression. true if a possible match was found; false if no more matches are possible. Determine whether at base.runtextpos is a match for the regular expression. The text being scanned by the regular expression. true if the regular expression matches at the current position; otherwise, false. Custom -derived type for the codeEntryRegex method. Cached, thread-safe singleton instance. Initializes the instance. Provides a factory for creating instances to be used by methods on . Creates an instance of a used by methods on . Provides the runner that contains the custom logic implementing the specified regular expression. Scan the starting from base.runtextstart for the next match. The text being scanned by the regular expression. Search starting from base.runtextpos for the next location a match could possibly start. The text being scanned by the regular expression. true if a possible match was found; false if no more matches are possible. Determine whether at base.runtextpos is a match for the regular expression. The text being scanned by the regular expression. true if the regular expression matches at the current position; otherwise, false. Helper methods used by generated -derived implementations. Default timeout value set in , or if none was set. Whether is non-infinite.