room_get_info
+This function gets information on a room from storage and returns it as a struct. You can choose to exclude information through the given optional arguments.
+The function cannot be used to get the current state of an active room (the current room or an already visited persistent room). In this case it returns the original state of the room.
+The room must have been previously created using The Asset Browser or added in-game using room_add.
+The format of the returned struct is as follows:
+room_info_struct =
+ {
+ instances:
+ [
+ {/* Instance Info Struct */},
+ {/* Instance Info Struct */},
+ ],
+ layers:
+ [
+ {
+ elements:
+ [
+ {/* Layer Element Info Struct */},
+ {
+ /* Example */
+ type: layerelementtype_tilemap,
+ tiles: [/* Tile Map Data */]
+ }
+ ]
+ },
+ ],
+ views:
+ [
+ {/* View Info Struct */},
+ ]
+ }
The tables below list all the possible structs that can be contained in the returned struct:
+ +This is the main struct returned by the function. All variables listed below are present at the root of this returned struct:
+| Variable Name | +Data Type | +Description | +
|---|---|---|
| width | +Real | +The width of the room | +
| height | +Real | +The height of the room | +
| creationCode | +Script Function | +The index of the script function that contains this room's creation code | +
| physicsWorld | +Boolean | +Whether the room has a physics world | +
| physicsGravityX | +Real | +The physics world's gravity component along the x axis | +
| physicsGravityY | +Real | +The physics world's gravity component along the y axis | +
| physicsPixToMeters | +Real | +The physics world's pixel-to-metre scale | +
| persistent | +Boolean | +Whether the room is persistent | +
| enableViews | +Boolean | +Whether views are enabled for the room | +
| clearDisplayBuffer | +Boolean | +Whether to clear the display buffer before drawing the room | +
| clearViewportBackground | +Boolean | +Whether to clear viewports' backgrounds before drawing to them | +
| colour | +Colour | +The clear colour used when clearDisplayBuffer is set to true | +
| instances | +Array of Room Instance Info Struct | +An array listing all instances placed in the room with basic information on them | +
| layers | +Array of Room Layer Info Struct | +An array listing all room layers, in order of increasing depth | +
| views | +Array of Room View Info Struct | +An array listing all views, ordered by view index | +
This type of struct represents one instance in the room.
+These structs are found in the instances array, which is part of the main struct returned by the function.
+| Variable Name | +Data Type | +Description | +
|---|---|---|
| id | +Object Instance | +The instance ID | +
| object_index | +String | +The name of the object this is an instance of (use asset_get_index to get the actual object) | +
| x | +Real | +The x coordinate of the instance's position | +
| y | +Real | +The y coordinate of the instance's position | +
| xscale | +Real | +The x scale of the instance | +
| yscale | +Real | +The y scale of the instance | +
| angle | +Real | +The rotation angle of the instance | +
| image_index | +Real | +The image index used by the instance | +
| image_speed | +Real | +The image speed of the instance | +
| colour | +Colour | +The blend colour used to draw the instance | +
| creation_code | +Script Function | +The index of the script function that contains the instance's creation code | +
| pre_creation_code | +Script Function | +The index of the script function that holds the pre-creation code for this specific instance, i.e. the overrides for its Object Variables as set in the Room Editor. See: Pre-creation Code | +
This type of struct represents one layer in the room.
+These structs are found in the layers array, which is part of the main struct returned by the function.
+| Argument | -Type | +Variable Name | +Data Type | Description | |
|---|---|---|---|---|---|
| room | -Room Asset | -The room to get the info from | +id | +Real | +The layer handle | +
| name | +String | +The name of the layer | +|||
| visible | +Boolean | +Whether the layer is visible | +|||
| depth | +Real | +The depth of the layer | +|||
| xoffset | +Real | +The x offset of the layer | +|||
| yoffset | +Real | +The y offset of the layer | +|||
| hspeed | +Real | +The horizontal speed of the layer | +|||
| vspeed | +Real | +The vertical speed of the layer | +|||
| effectEnabled | +Boolean | +Whether the layer filter/effect is currently enabled | +|||
| effectToBeEnabled | +Boolean | +Whether the layer filter/effect should be enabled/disabled in the next frame (the next value of effectEnabled) | +|||
| effect | +FX Struct | +A struct containing the effect's parameters (-1 if no layer effect is set) | +|||
| shaderID | +Shader Asset | +The shader to be applied to the layer (layer_shader) | +|||
| elements | +Array of Room Layer Element Info Struct | +An array listing all elements on the layer. Each element type struct contains information specific to it. | +
This type of struct represents one view in the room.
+These structs are found in the views array, which is part of the main struct returned by the function.
+| Variable Name | +Data Type | +Description | +
|---|---|---|
| visible | +Boolean | +Whether the view is visible | +
| cameraID | +Camera ID | +The camera assigned to this view | +
| xview | +Real | +The x coordinate of the view camera's position | +
| yview | +Real | +The y coordinate of the view camera's position | +
| wview | +Real | +The width of the view's camera | +
| hview | +Real | +The height of the view's camera | +
| hspeed | +Real | +The horizontal movement speed of the view | +
| vspeed | +Real | +The vertical movement speed of the view | +
| xport | +Real | +The x position on screen where the view is drawn | +
| yport | +Real | +The y position on screen where the view is drawn | +
| wport | +Real | +The width of the viewport | +
| hport | +Real | +The height of the viewport | +
| object | +Object Asset | +The object of which the first instance in the room should be followed by the camera | +
| hborder | +Real | +The horizontal border around the instance of the object to follow | +
| vborder | +Real | +The vertical border around the instance of the object to follow | +
This type of struct represents one element in a layer.
+These structs are found in the elements array, which is part of a layer struct.
+| Variable Name | +Data Type | +Description | +|||
|---|---|---|---|---|---|
| All Element Types | +|||||
| id | +Real | +The unique ID of the element | +|||
| type | +Layer Element Type Constant | +The type of element | +|||
| Background Element Type | +|||||
| sprite_index | +Sprite Asset | +The sprite used by the background | +|||
| image_index | +Real | +The sprite's subimage | +|||
| xscale | +Real | +The scale along the x axis | +|||
| yscale | +Real | +The scale along the y axis | +|||
| htiled | +Boolean | +Whether to tile the background image horizontally | +|||
| vtiled | +Boolean | +Whether to tile the background image vertically | +|||
| stretch | +Boolean | +Whether to stretch the background so it fills the entire room | +|||
| visible | +Boolean | +Whether the background should be visible | +|||
| blendColour | +Colour | +The blend colour to draw the background with | +|||
| blendAlpha | +Real | +The alpha value between 0 and 1 to use | +|||
| image_speed | +Real | +The image speed of the background | +|||
| speed_type | +Sprite Speed Constant | +The units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe | +|||
| name | +String | +The name of the background | +|||
| Instance Element Type | +|||||
| inst_id | +Object Instance | +The ID of the instance | +|||
| Sprite Element Type | +|||||
| sprite_index | +Sprite Asset | +The sprite index of this sprite element | +|||
| image_index | +Real | +The subimage of the sprite | +|||
| x | +Real | +The x coordinate of the sprite's position | +|||
| y | +Real | +The y coordinate of the sprite's position | +|||
| image_xscale | +Real | +The scale of the image along the x axis | +|||
| image_yscale | +Real | +The scale of the image along the y axis | +|||
| image_angle | +Real | +The image angle | +|||
| image_alpha | +Real | +The alpha value between 0 and 1 | +|||
| image_blend | +Colour | +The blend colour | +|||
| image_speed | +Real | +The animation speed of the image, expressed in speed_type units | +|||
| speed_type | +Sprite Speed Constant | +The units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe | +|||
| name | +String | +The name of the sprite element as given in The Room Editor (default is graphic_*) | +|||
| Tile Map Element Type | +|||||
| x | +Real | +The x position (or offset) of the tile map in the room | +|||
| y | +Real | +The y position (or offset) of the tile map in the room | +|||
| tileset_index | +Tile Set Asset | +The tile set that this tile map uses | +|||
| data_mask | +Real | +The bitmask value for the tile map | +|||
| tiles | +Array of Real | +This variable is only present when the tilemap_data parameter is set to true. It is a one-dimensional array that contains all the tile map data, listed row by row. | +|||
| width | +Real | +The width in cells of the tile map | +|||
| height | +Real | +The height in cells of the tile map | +|||
| name | +String | +The tile map's name | +|||
| Particle System Element Type | +|||||
| ps | +Particle System Asset | +The particle system | +|||
| x | +Real | +The x coordinate of the particle system's position | +|||
| y | +Real | +The y coordinate of the particle system's position | +|||
| angle | +Real | +The angle by which the particle system is rotated | +|||
| xscale | +Real | +The scale along the x axis of the particle system | +|||
| yscale | +Real | +The scale along the y axis of the particle system | +|||
| blend | +Colour | +The blend colour to use to draw the particle system | +|||
| alpha | +Real | +The alpha value between 0 and 1 to use | +|||
| name | +String | +The name of the particle system element as defined in The Room Editor (default is particle_*) | +|||
| Tile Element Type | +|||||
| visible | +Boolean | +Whether the tile is visible | +|||
| sprite_index | +Sprite Asset | +The sprite this tile is on | +|||
| x | +Real | +The x coordinate of the tile position | +|||
| y | +Real | +The y coordinate of the tile position | +|||
| width | +Real | +The width of the tile | +|||
| height | +Real | +The height of the tile | +|||
| image_xscale | +Real | +The scale factor along the x axis of the tile | +|||
| image_yscale | +Real | +The scale factor along the y axis of the tile | +|||
| image_angle | +Real | +The angle of the tile | +|||
| image_blend | +Colour | +The blend colour to use to draw the tile | +|||
| image_alpha | +Real | +The alpha to use | +|||
| xo | +Real | +The x offset | +|||
| yo | +Real | +The y offset | +|||
| Sequence Element Type | +|||||
| x | +Real | +The x coordinate of the sequence position | +|||
| y | +Real | +The y coordinate of the sequence position | +|||
| image_xscale | +Real | +The scale along the x axis of the entire sequence | +|||
| image_yscale | +Real | +The scale along the y axis of the entire sequence | +|||
| image_angle | +Real | +The angle by which the sequence is rotated | +|||
| image_alpha | +Real | +The alpha value between 0 and 1 to use | +|||
| image_blend | +Colour | +The blend colour to use to draw the sequence | |||
| views | -Boolean | -Whether to include view information in the struct (defaults to true) | +image_speed | +Real | +The animation speed of the sequence, expressed in speed_type units |
| instances | -Boolean | -Whether to include instance information in the struct (defaults to true) | +speedType | +Sprite Speed Constant | +The units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe |
| layers | -Boolean | -Whether to include layer information in the struct (defaults to true) | +seq_id | +Sequence Asset | +The sequence asset |
| layer_elements | -Boolean | -Whether to include layer element information in the struct (defaults to true, requires layers to be set to true) | +name | +String | +The name of the sequence element as defined in The Room Editor (default is graphic_*) |
| tilemap_data | -Boolean | -Whether to include tile map data in the struct (defaults to true, requires layers and layer_elements to be set to true) | +head_position | +Real | +The playhead position of the sequence |
-
Returns:
- --
Example:
-var _info = room_get_info(Room1);
-
- var _info_json = json_stringify(_info, true);
-
- show_debug_message(_info_json);
The above code gets the information of the room Room1, converts the returned struct to a JSON string using json_stringify, then outputs it in a debug message. All view, instance, layer, layer element and tile map information is included in the output.
--
-
+
Syntax:
+room_get_info(room, [views], [instances], [layers], [layer_elements], [tilemap_data]);
+| Argument | +Type | +Description | +
|---|---|---|
| room | +Room Asset | +The room to get the info from | +
| views | +Boolean | +Whether to include view information in the struct (defaults to true) | +
| instances | +Boolean | +Whether to include instance information in the struct (defaults to true) | +
| layers | +Boolean | +Whether to include layer information in the struct (defaults to true) | +
| layer_elements | +Boolean | +Whether to include layer element information in the struct (defaults to true, requires layers to be set to true) | +
| tilemap_data | +Boolean | +Whether to include tile map data in the struct (defaults to true, requires layers and layer_elements to be set to true) | +
+
Returns:
+ ++
Example:
+var _info = room_get_info(Room1);
+ var _info_json = json_stringify(_info, true);
+ show_debug_message(_info_json);
The above code gets the information of the room Room1, converts the returned struct to a JSON string using json_stringify, then outputs it in a debug message. All view, instance, layer, layer element and tile map information is included in the output.
++
+
particle_get_info
-This function returns a struct with information about a Particle System Asset created using The Particle System Editor.
-The returned struct is a Particle System Info Struct, which contains an Array of Particle Emitter Info Structs. Each of these emitter structs stores info on the particle type that the emitter uses in its parttype variable, which contains a Particle Type Info Struct.
-If no valid Particle System Asset is passed to the function, GameMaker will throw an error.
-In a simplified way, the contents of the struct returned by this function look something like the following:
-part_sys_info_struct =
-
- {
-
- emitters:
-
- [
-
- {
-
- parttype:
-
- {
-
- // Particle type properties...
-
- }
-
- // All other particle emitter properties...
-
- }
-
- // More emitters...
-
- ]
-
- // All other particle system properties...
-
- };
The tables below list all variables that are available in each of these three structs.
- -| Variable Name | -Data Type | -Description | -
|---|---|---|
| name | -String | -The name of the particle system asset. | -
| xorigin | -Real | -The X origin of the particle system. | -
| yorigin | -Real | -The Y origin of the particle system. | -
| global_space | -Boolean | -Whether this particle system has global space particles enabled (see part_system_global_space). | -
| oldtonew | -Boolean | -Whether old particles should be drawn behind new ones (true) or not (false). | -
| emitters | -Array of Particle Emitter Info Struct | -An array of emitter info structs, ordered the same as in The Particle System Editor. | -
| Variable Name | -Data Type | -Description | -
|---|---|---|
| ind | -Particle Emitter ID | -The ID of the particle emitter. | -
| name | -String | -The name of the particle emitter. | -
| mode | -Particle Emitter Mode Constant | -The mode in which to emit particles. Either ps_mode_stream or ps_mode_burst. | -
| enabled | -Boolean | -Whether the particle emitter is enabled. | -
| number | -Real | -The number of particles to create every frame if mode is ps_mode_stream or to create only once if mode is ps_mode_burst. Density (percent coverage) when in relative mode. | -
| relative | -Boolean | -Whether the emitter is in relative mode, in which the number of particles created by the emitter is relative to the area of its region (see part_emitter_relative). | -
| xmin | -Real | -The X coordinate of the left side of the emitter's region. | -
| xmax | -Real | -The X coordinate of the right side of the emitter's region. | -
| ymin | -Real | -The Y coordinate of the top of the emitter's region. | -
| ymax | -Real | -The Y coordinate of the bottom of the emitter's region. | -
| distribution | -Particle Emitter Distribution Constant | -The distribution style of the particles. One of the ps_distr_* constants. | -
| shape | -Particle Emitter Shape Constant | -The shape of the emitter's region. One of the ps_shape_* constants. | -
| parttype | -Particle Type Info Struct | -The particle type info struct containing information this emitter's particle type. | -
| delay_min | -Real | -The minimum delay between particle bursts in stream mode, expressed in delay_unit. | -
| delay_max | -Real | -The maximum delay between particle bursts in stream mode, expressed in delay_unit. | -
| delay_unit | -Time Source Unit Constant | -The unit in which delay_min and delay_max are expressed | -
| interval_min | -Real | -The minimum time between particle bursts in stream mode, expressed in interval_unit. | -
| interval_max | -Real | -The maximum time between particle bursts in stream mode, expressed in interval_unit. | -
| interval_unit | -Time Source Unit Constant | -The unit in which interval_min and interval_max are expressed. | -
| Variable Name | -Data Type | -Description | -
|---|---|---|
| General | -||
| ind | -Particle Type ID | -The index of the particle type. This can be used e.g. with the function part_particles_create. | -
| Shape / Sprite | -||
| sprite | -Sprite Asset | -The sprite that the particle type uses or -1. | -
| frame | -Real | -The sprite subimage in case a sprite is used. | -
| animate | -Boolean | -If true then the sprite is animated, starting from the frame subimage. | -
| stretch | -Boolean | -If true then the animation is stretched over the particle's lifetime. | -
| random | -Boolean | -If true then a random subimage is used instead of frame. | -
| shape | -Particle Shape Constant | -The particle shape. One of the pt_shape_* constants. Used only if sprite is -1. | -
| Size | -||
| size_xmin | -Real | -The minimum size a particle of this type can have on the X axis when it is created (the size is determined randomly for each particle and can vary from size_xmin to size_xmax). | -
| size_ymin | -Real | -The minimum size a particle of this type can have on the Y axis when it is created (the size is determined randomly for each particle and can vary from size_ymin to size_ymax). | -
| size_xmax | -Real | -The maximum size a particle of this type can have on the X axis when it is created (the size is determined randomly for each particle and can vary from size_xmin to size_xmax). | -
| size_ymax | -Real | -The maximum size a particle of this type can have on the Y axis when it is created (the size is determined randomly for each particle and can vary from size_ymin to size_ymax). | -
| size_xincr | -Real | -The value to increase/decrease the particle size on the X axis by each frame. | -
| size_yincr | -Real | -The value to increase/decrease the particle size on the Y axis by each frame. | -
| size_xwiggle | -Real | -Value randomly added or subtracted from the particle's X size each frame. | -
| size_ywiggle | -Real | -Value randomly added or subtracted from the particle's Y size each frame. | -
| Scale | -||
| xscale | -Real | -The X scale of the particle image (sprite or shape). | -
| yscale | -Real | -The Y scale of the particle image (sprite or shape). | -
| Life | -||
| life_min | -Real | -The minimum life of particles of this type (in number of frames). | -
| life_max | -Real | -The maximum life of particles of this type (in number of frames). | -
| Secondary Particles | -||
| death_type | -Particle Type ID | -The type of particle spawned on death or -1. | -
| death_number | -Real | -The number of particles spawned on death. | -
| step_type | -Particle Type ID | -The type of particle spawned each step or -1. | -
| step_number | -Real | -The number of particles spawned each step. | -
| Speed | -||
| speed_min | -Real | -The minimum speed (in pixels per frame) of the particle when it's created (this starting speed is determined randomly for each particle and ranges from speed_min to speed_max). | -
| speed_max | -Real | -The maximum speed (in pixels per frame) of the particle when it's created (this starting speed is determined randomly for each particle and ranges from speed_min to speed_max). | -
| speed_incr | -Real | -The value to increase/decrease the particle speed by each frame. | -
| speed_wiggle | -Real | -A value randomly added or subtracted from the particle speed each frame. | -
| Direction | -||
| dir_min | -Real | -The minimum direction (in degrees) for a particle when it's created (this starting direction is determined randomly for each particle and ranges from dir_min to dir_max). | -
| dir_max | -Real | -The maximum direction (in degrees) for a particle when it's created (this starting direction is determined randomly for each particle and ranges from dir_min to dir_max). | -
| dir_incr | -Real | -The value to increase/decrease the particle direction by each frame. | -
| dir_wiggle | -Real | -A value randomly added or subtracted from the particle direction each frame. | -
| Gravity | -||
| grav_amount | -Real | -The amount of gravity applied to the particle each frame (in pixels per frame). | -
| grav_dir | -Real | -The gravity direction. | -
| Orientation | -||
| ang_min | -Real | -The minimum starting angle (in degrees) of the particle sprite when created (this starting angle is determined randomly for each particle and ranges from ang_min to ang_max). | -
| ang_max | -Real | -The maximum starting angle (in degrees) of the particle sprite when created (this starting angle is determined randomly for each particle and ranges from ang_min to ang_max). | -
| ang_incr | -Real | -The value to increase/decrease the particle angle by each frame. | -
| ang_wiggle | -Real | -A value randomly added or subtracted from the particle angle each frame. | -
| ang_relative | -Boolean | -If true then the particle angle is relative to its direction. | -
| Color & Alpha | -||
| color1 | -Colour | -The color of the particle when created. | -
| color2 | -Colour | -The color of the particle when halfway through its lifespan. | -
| color3 | -Colour | -The color of the particle at the end of its lifespan. | -
| alpha1 | -Real | -The alpha of the particle when created. | -
| alpha2 | -Real | -The alpha of the particle when halfway through its lifespan. | -
| alpha3 | -Real | -The alpha of the particle at the end of its lifespan. | -
| additive | -Boolean | -If true then the particle is drawn with additive blending (i.e. using the Blend Mode Constant bm_add). | -
-
Finally there is also a constant for the particle emitter mode:
-| Variable Name | +Data Type | +Description | +
|---|---|---|
| name | +String | +The name of the particle system asset. | +
| xorigin | +Real | +The X origin of the particle system. | +
| yorigin | +Real | +The Y origin of the particle system. | +
| global_space | +Boolean | +Whether this particle system has global space particles enabled (see part_system_global_space). | +
| oldtonew | +Boolean | +Whether old particles should be drawn behind new ones (true) or not (false). | +
| emitters | +Array of Particle Emitter Info Struct | +An array of emitter info structs, ordered the same as in The Particle System Editor. | +
| Constant | +Variable Name | +Data Type | Description | |
|---|---|---|---|---|
| ps_mode_stream | -The particle emitter streams the given number of particles continuously (see part_emitter_stream) | +ind | +Particle Emitter | +The particle emitter. | +
| name | +String | +The name of the particle emitter. | +||
| mode | +Particle Emitter Mode Constant | +The mode in which to emit particles. Either ps_mode_stream or ps_mode_burst. | +||
| enabled | +Boolean | +Whether the particle emitter is enabled. | +||
| number | +Real | +The number of particles to create every frame if mode is ps_mode_stream or to create only once if mode is ps_mode_burst. Density (percent coverage) when in relative mode. | +||
| relative | +Boolean | +Whether the emitter is in relative mode, in which the number of particles created by the emitter is relative to the area of its region (see part_emitter_relative). | +||
| xmin | +Real | +The X coordinate of the left side of the emitter's region. | +||
| xmax | +Real | +The X coordinate of the right side of the emitter's region. | +||
| ymin | +Real | +The Y coordinate of the top of the emitter's region. | +||
| ymax | +Real | +The Y coordinate of the bottom of the emitter's region. | +||
| distribution | +Particle Emitter Distribution Constant | +The distribution style of the particles. One of the ps_distr_* constants. | +||
| shape | +Particle Emitter Shape Constant | +The shape of the emitter's region. One of the ps_shape_* constants. | +||
| parttype | +Particle Type Info Struct | +The particle type info struct containing information this emitter's particle type. | +||
| delay_min | +Real | +The minimum delay between particle bursts in stream mode, expressed in delay_unit. | +||
| delay_max | +Real | +The maximum delay between particle bursts in stream mode, expressed in delay_unit. | +||
| delay_unit | +Time Source Unit Constant | +The unit in which delay_min and delay_max are expressed | ||
| ps_mode_burst | -The particle emitter emits a single burst of the given number of particles (see part_emitter_burst) | +interval_min | +Real | +The minimum time between particle bursts in stream mode, expressed in interval_unit. | +
| interval_max | +Real | +The maximum time between particle bursts in stream mode, expressed in interval_unit. | +||
| interval_unit | +Time Source Unit Constant | +The unit in which interval_min and interval_max are expressed. |
-
Syntax:
-particle_get_info(partsys);
-| Argument | -Type | +Variable Name | +Data Type | Description | |
|---|---|---|---|---|---|
| partsys | -Particle System Asset | -The particle system asset to get the info from. | +General | +||
| ind | +Particle Type | +The particle type. This can be used e.g. with the function part_particles_create. | +|||
| Shape / Sprite | +|||||
| sprite | +Sprite Asset | +The sprite that the particle type uses or -1. | +|||
| frame | +Real | +The sprite subimage in case a sprite is used. | +|||
| animate | +Boolean | +If true then the sprite is animated, starting from the frame subimage. | +|||
| stretch | +Boolean | +If true then the animation is stretched over the particle's lifetime. | +|||
| random | +Boolean | +If true then a random subimage is used instead of frame. | +|||
| shape | +Particle Shape Constant | +The particle shape. One of the pt_shape_* constants. Used only if sprite is -1. | +|||
| Size | +|||||
| size_xmin | +Real | +The minimum size a particle of this type can have on the X axis when it is created (the size is determined randomly for each particle and can vary from size_xmin to size_xmax). | +|||
| size_ymin | +Real | +The minimum size a particle of this type can have on the Y axis when it is created (the size is determined randomly for each particle and can vary from size_ymin to size_ymax). | +|||
| size_xmax | +Real | +The maximum size a particle of this type can have on the X axis when it is created (the size is determined randomly for each particle and can vary from size_xmin to size_xmax). | +|||
| size_ymax | +Real | +The maximum size a particle of this type can have on the Y axis when it is created (the size is determined randomly for each particle and can vary from size_ymin to size_ymax). | +|||
| size_xincr | +Real | +The value to increase/decrease the particle size on the X axis by each frame. | +|||
| size_yincr | +Real | +The value to increase/decrease the particle size on the Y axis by each frame. | +|||
| size_xwiggle | +Real | +Value randomly added or subtracted from the particle's X size each frame. | +|||
| size_ywiggle | +Real | +Value randomly added or subtracted from the particle's Y size each frame. | +|||
| Scale | +|||||
| xscale | +Real | +The X scale of the particle image (sprite or shape). | +|||
| yscale | +Real | +The Y scale of the particle image (sprite or shape). | +|||
| Life | +|||||
| life_min | +Real | +The minimum life of particles of this type (in number of frames). | +|||
| life_max | +Real | +The maximum life of particles of this type (in number of frames). | +|||
| Secondary Particles | +|||||
| death_type | +Particle Type | +The type of particle spawned on death or -1. | +|||
| death_number | +Real | +The number of particles spawned on death. | +|||
| step_type | +Particle Type | +The type of particle spawned each step or -1. | +|||
| step_number | +Real | +The number of particles spawned each step. | +|||
| Speed | +|||||
| speed_min | +Real | +The minimum speed (in pixels per frame) of the particle when it's created (this starting speed is determined randomly for each particle and ranges from speed_min to speed_max). | +|||
| speed_max | +Real | +The maximum speed (in pixels per frame) of the particle when it's created (this starting speed is determined randomly for each particle and ranges from speed_min to speed_max). | +|||
| speed_incr | +Real | +The value to increase/decrease the particle speed by each frame. | +|||
| speed_wiggle | +Real | +A value randomly added or subtracted from the particle speed each frame. | +|||
| Direction | +|||||
| dir_min | +Real | +The minimum direction (in degrees) for a particle when it's created (this starting direction is determined randomly for each particle and ranges from dir_min to dir_max). | +|||
| dir_max | +Real | +The maximum direction (in degrees) for a particle when it's created (this starting direction is determined randomly for each particle and ranges from dir_min to dir_max). | +|||
| dir_incr | +Real | +The value to increase/decrease the particle direction by each frame. | +|||
| dir_wiggle | +Real | +A value randomly added or subtracted from the particle direction each frame. | +|||
| Gravity | +|||||
| grav_amount | +Real | +The amount of gravity applied to the particle each frame (in pixels per frame). | +|||
| grav_dir | +Real | +The gravity direction. | +|||
| Orientation | +|||||
| ang_min | +Real | +The minimum starting angle (in degrees) of the particle sprite when created (this starting angle is determined randomly for each particle and ranges from ang_min to ang_max). | +|||
| ang_max | +Real | +The maximum starting angle (in degrees) of the particle sprite when created (this starting angle is determined randomly for each particle and ranges from ang_min to ang_max). | +|||
| ang_incr | +Real | +The value to increase/decrease the particle angle by each frame. | +|||
| ang_wiggle | +Real | +A value randomly added or subtracted from the particle angle each frame. | +|||
| ang_relative | +Boolean | +If true then the particle angle is relative to its direction. | +|||
| Color & Alpha | +|||||
| color1 | +Colour | +The color of the particle when created. | +|||
| color2 | +Colour | +The color of the particle when halfway through its lifespan. | +|||
| color3 | +Colour | +The color of the particle at the end of its lifespan. | +|||
| alpha1 | +Real | +The alpha of the particle when created. | +|||
| alpha2 | +Real | +The alpha of the particle when halfway through its lifespan. | +|||
| alpha3 | +Real | +The alpha of the particle at the end of its lifespan. | +|||
| additive | +Boolean | +If true then the particle is drawn with additive blending (i.e. using the Blend Mode Constant bm_add). | |||
-
Returns:
- --
Example 1: Particle Type Info
-var _particle_info = particle_get_info(ps_Clouds);
-
- var _asset_name = _particle_info.name;
-
-
- var _arr_emitters = _particle_info.emitters;
-
- if (array_length(_arr_emitters) > 0)
-
- {
-
- var _type_info = _arr_emitters[0].parttype;
-
-
- if (_type_info.additive)
-
- {
-
- show_debug_message("The first emitter in {0} creates shiny particles!", _asset_name);
-
- }
-
- }
The above code first gets information from an existing Particle System Asset ps_Clouds using particle_get_info and assigns the returned struct to a temporary variable _particle_info. It then looks up the emitters in the particle system through the Particle System Info Struct's emitters variable. If the particle system contains any emitters (i.e. the array's length is greater than 0), the first emitter's parttype variable is assigned to a temporary variable _type_info and checked for additive blending (bm_add). Finally a debug message is shown if additive blending is used for the particle type.
--
Example 2: Listing Emitter Names
-var _particle_info = particle_get_info(ps_Environment);
-
- var _asset_name = _particle_info.name;
-
-
- var _emitter_names = array_map(_particle_info.emitters, function(_element, _index) { return _element.name; });
-
- _emitter_names = string_join_ext(", ", _emitter_names);
-
-
- show_debug_message("{0} contains the following particle emitters: {1}", _asset_name, _emitter_names);
The above code first calls particle_get_info to retrieve information about an existing Particle System Asset ps_Environment. The asset's name is stored in a temporary variable _asset_name. After that, an array of emitter names is generated from the Particle System Info Struct's emitters variable and converted to a string listing all names, separated by a comma, using string_join_ext. Finally a debug message displays the information in a readable form.
--
- -
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
+© Copyright YoYo Games Ltd. 2024 All Rights Reserved
Project Tool
The Project Tool is a built-in tool to convert projects between different versions of GameMaker.
-It is used by the IDE internally to convert projects from older project formats to the current format and the other way round.
-It is accessible from the IDE through The Tools Menu > Project Tool option.
+It is used by the IDE internally to convert projects from older project formats to the current format and the other way round and can be accessed through The Tools Menu > Project Tool option.
See the Project Format page for details on the current project format.
+Tool Window
The tool window contains the following fields:
-
-
- Source - This field contains the path to the source project or package file to convert. Paste a valid file path here or click the
button to bring up a file selector.
- - Destination - This field contains the path to the destination project to create. Paste a valid path here or click the button to bring up a file selector. This field can be empty when the source project is a .yyp file, in which case Project Tool does an in-place conversion (i.e. it converts the project in the source directory). It must be filled out, however, when the source project is a package file. Project Tool shows the following message if you attempt to convert a package with an empty destination path:
+ - Source - This field contains the path to the source project or package file to convert. Paste a valid file path here or click the button to bring up a file selector.
+
- Destination - This field contains the path to the destination project to create. Paste a valid path here or click the button to bring up a file selector. This field can be empty when the source project is a .yyp file, in which case Project Tool does an in-place conversion (i.e. it converts the project in the source directory). It must be filled out, however, when the source project is a package file. Project Tool shows the following message if you attempt to convert a package with an empty destination path:
- Project Format - This drop-down list contains the available project formats that you can convert to. The following formats are available:
- LTS22 - This is the project format used by the 2022.0 LTS release. @@ -35,10 +35,17 @@
Project Tool
- Clean Conversion Folders - When this checkbox is ticked, Project Tool cleans up the conversion folders after conversion. This is enabled by default.
Project Tool Output
+Project Tool Output
All Project Tool output is shown in the Project Tool Window that you can open manually through the Project Tool Output option of The Windows Menu. It can also automatically be shown when Project Tool runs by enabling Show Project Tool Output in the General Preferences.
+
Project Tool Versions
+Every IDE release comes bundled with a version of Project Tool. While it should normally not be needed, the version used can be changed to a different one by providing a different path under Path to Project Tool. The IDE will use the following version of Project Tool, in order of preference:
++
-
+
- The version of Project Tool in the location set in Preferences -> General Settings -> Paths -> Path to Project Tool +
- Any version of Project Tool installed via the Package Manager (in the location set in Preferences -> Package Manager -> Packages Install Directory) +
- The Project Tool bundled with this IDE version +
\ No newline at end of file diff --git a/Manual/contents/The_Asset_Editors/Extension_Creation/iOS_Extensions.htm b/Manual/contents/The_Asset_Editors/Extension_Creation/iOS_Extensions.htm index e52aa4cb5..6193855a0 100644 --- a/Manual/contents/The_Asset_Editors/Extension_Creation/iOS_Extensions.htm +++ b/Manual/contents/The_Asset_Editors/Extension_Creation/iOS_Extensions.htm @@ -29,6 +29,8 @@ YYIosCFBundleURLSchemesArray
YYIosLSApplicationQueriesSchemesArray
YYIosPrivacyManifest
+ YYIosLaunchActionCommandLineArguments
+ YYIosBridgeHeader
YYTvosPlist
YYTvosEntitlements
diff --git a/Manual/contents/assets/Images/Scripting_Reference/GML/Reference/Maths/matrix_array_indices_column_major.png b/Manual/contents/assets/Images/Scripting_Reference/GML/Reference/Maths/matrix_array_indices_column_major.png new file mode 100644 index 000000000..4d6f3b24d Binary files /dev/null and b/Manual/contents/assets/Images/Scripting_Reference/GML/Reference/Maths/matrix_array_indices_column_major.png differ diff --git a/Manual/contents/assets/Images/Setup_And_Version/Preferences/Plugins_Project_Tool_Prefs.png b/Manual/contents/assets/Images/Setup_And_Version/Preferences/Plugins_Project_Tool_Prefs.png new file mode 100644 index 000000000..8acfb8056 Binary files /dev/null and b/Manual/contents/assets/Images/Setup_And_Version/Preferences/Plugins_Project_Tool_Prefs.png differ diff --git a/Manual/contents/assets/snippets/Example_BBox_Calculation.hts b/Manual/contents/assets/snippets/Example_BBox_Calculation.hts new file mode 100644 index 000000000..c2c408cf7 --- /dev/null +++ b/Manual/contents/assets/snippets/Example_BBox_Calculation.hts @@ -0,0 +1,17 @@ + + + + + + + +
var _ww, _hh;
+ _ww = sprite_get_bbox_right(sprite_index) - sprite_get_bbox_left(sprite_index);
+ _hh = sprite_get_bbox_bottom(sprite_index) - sprite_get_bbox_top(sprite_index);
The above code calculates the width and height of the collision mask based on the relative bounding box side positions.
+ + \ No newline at end of file diff --git a/Manual/contents/assets/snippets/Note_Fullscreen.hts b/Manual/contents/assets/snippets/Note_Fullscreen.hts new file mode 100644 index 000000000..65ebd9f76 --- /dev/null +++ b/Manual/contents/assets/snippets/Note_Fullscreen.hts @@ -0,0 +1,14 @@ + + + + + + + +If this is checked, the game is set to start in fullscreen mode otherwise it will start windowed. Note that enabling this does not guarantee that the game will start in fullscreen, as the OS may block fullscreen switching for a variety of reasons. This is off by default.
+ + \ No newline at end of file diff --git a/Manual/contents/assets/snippets/Note_Matrix_Column_Major.hts b/Manual/contents/assets/snippets/Note_Matrix_Column_Major.hts new file mode 100644 index 000000000..2d6888a4c --- /dev/null +++ b/Manual/contents/assets/snippets/Note_Matrix_Column_Major.hts @@ -0,0 +1,15 @@ + + + + + + + +The array that stores the matrix contains 16 values in total, with the elements stored in column-major order, i.e. the initial 4 elements are column 1, the next 4 elements are column 2 and so on, as part of a 4x4 matrix. The following image shows the array indices mapped to their corresponding matrix element in this ordering:
+
Optional Struct
+The last argument, var_struct, is optional and takes a struct containing additional variables for the new instance.
+Variables from this struct are applied to the new instance before its Create event runs, but after its Variable Definitions.
+This means that the values from that struct are readable in the Create event of the new instance. See Example 2 at the bottom.
+Values applied to the new instance through this struct can be of any type, including Method Variables. Built-in variables can be changed as well.
+Variables from the struct are "shallow-copied" to the new instance, meaning any arrays, structs, and other resources are copied by reference and not duplicated.
+ + \ No newline at end of file diff --git a/Manual/contents/assets/snippets/network_socket_types.hts b/Manual/contents/assets/snippets/network_socket_types.hts index 995e25526..2b823baf1 100644 --- a/Manual/contents/assets/snippets/network_socket_types.hts +++ b/Manual/contents/assets/snippets/network_socket_types.hts @@ -3,7 +3,7 @@ - +NOTE 1 It is also possible to secure your simple WebSocket (network_socket_ws) by using the wss:// protocol in your URLs.
-NOTE 2 * Secure WebSockets will not work on UWP and Xbox One when using the legacy XDK platform, however they will work on those targets when using GDK.
+It is also possible to secure your simple WebSocket (network_socket_ws) by using the wss:// protocol in your URLs.
+* Secure WebSockets will not work on UWP and Xbox One when using the legacy XDK platform, however they will work on those targets when using GDK.
+Websockets are not supported on Windows 7.
\ No newline at end of file diff --git a/Manual/toc/Default.toc b/Manual/toc/Default.toc index 79c597858..2e2634a21 100644 --- a/Manual/toc/Default.toc +++ b/Manual/toc/Default.toc @@ -2430,14 +2430,15 @@