diff --git a/Manual/contents/GameMaker_Language/GML_Overview/Instance Keywords/other.htm b/Manual/contents/GameMaker_Language/GML_Overview/Instance Keywords/other.htm index fc8953f3e..edd41c570 100644 --- a/Manual/contents/GameMaker_Language/GML_Overview/Instance Keywords/other.htm +++ b/Manual/contents/GameMaker_Language/GML_Overview/Instance Keywords/other.htm @@ -49,6 +49,13 @@

When 'other' changes

  • When calling an unbound constructor function, other will be the instance or struct that called that function. If the constructor is bound as a method, then other will be the instance or struct to which the constructor method is bound.
  • When stored as a reference through a struct literal, covered below under "'other' as a reference".
    • +

    Legacy other Behaviour

    +

    In previous versions of GameMaker other only changed in the following cases: 

    + +

    This behaviour can be enabled by the Legacy Other Behaviour game option.

    Struct Declaration

    Scope doesn't change inside a struct declaration, so other refers to the same scope as self (the current scope), meaning the struct or instance that's initialising the struct:

    var _struct =
    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/Instance_Variables/alarm.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/Instance_Variables/alarm.htm index 9e61c8546..13a5ef4df 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/Instance_Variables/alarm.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/Instance_Variables/alarm.htm @@ -30,7 +30,7 @@

    Les retours :

    Exemple :

    if canshoot
    {
    -     if (keyboard_check_pressed(vk_space))
    +     if (keyboard_check_pressed(vk_space))
        {
            canshoot = false;
            alarm[0] = room_speed;
    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/instance_create_layer.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/instance_create_layer.htm index d5471e616..20bf188bc 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/instance_create_layer.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/instance_create_layer.htm @@ -1,4 +1,4 @@ - + @@ -94,13 +94,14 @@

    Exemple 2 :

    Retour : Instances
    Suivant : instance_create_depth
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    Copyright YoYo Games Ltd. 2022 Tous droits réservés
    + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm index b8c102f9c..ce6adf3a3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm @@ -1,894 +1,869 @@ - + - - - room_get_info - - - - - - - - - - -

    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:

    -

    Room Info

    -
    -

    This is the main struct returned by the function. All variables listed below are present at the root of this returned struct:

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Room Info Struct
    Variable NameData TypeDescription
    widthRealThe width of the room
    heightRealThe height of the room
    creationCodeScript FunctionThe index of the script function that contains this room's creation code
    physicsWorldBooleanWhether the room has a physics world
    physicsGravityXRealThe physics world's gravity component along the x axis
    physicsGravityYRealThe physics world's gravity component along the y axis
    physicsPixToMetersRealThe physics world's pixel-to-metre scale
    persistentBooleanWhether the room is persistent
    enableViewsBooleanWhether views are enabled for the room
    clearDisplayBufferBooleanWhether to clear the display buffer before drawing the room
    clearViewportBackgroundBooleanWhether to clear viewports' backgrounds before drawing to them
    colourColourThe clear colour used when clearDisplayBuffer is set to true
    instancesArray of Room Instance Info StructAn array listing all instances placed in the room with basic information on them
    layersArray of Room Layer Info StructAn array listing all room layers, in order of increasing depth
    viewsArray of Room View Info StructAn array listing all views, ordered by view index
    -
    -

    Instance Info

    -
    -

    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.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Instance Info Struct
    Variable NameData TypeDescription
    idObject InstanceThe instance ID
    object_indexStringThe name of the object this is an instance of (use asset_get_index to get the actual object)
    xRealThe x coordinate of the instance's position
    yRealThe y coordinate of the instance's position
    xscaleRealThe x scale of the instance
    yscaleRealThe y scale of the instance
    angleRealThe rotation angle of the instance
    image_indexRealThe image index used by the instance
    image_speedRealThe image speed of the instance
    colourColourThe blend colour used to draw the instance
    creation_codeScript FunctionThe index of the script function that contains the instance's creation code
    pre_creation_codeScript FunctionThe index of the script function that contains the instance's pre-creation code
    -
    -

    Layer Info

    -
    -

    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.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Layer Info Struct
    Variable NameData TypeDescription
    idRealThe layer handle
    nameStringThe name of the layer
    visibleBooleanWhether the layer is visible
    depthRealThe depth of the layer
    xoffsetRealThe x offset of the layer
    yoffsetRealThe y offset of the layer
    hspeedRealThe horizontal speed of the layer
    vspeedRealThe vertical speed of the layer
    effectEnabledBooleanWhether the layer filter/effect is currently enabled
    effectToBeEnabledBooleanWhether the layer filter/effect should be enabled/disabled in the next frame (the next value of effectEnabled)
    effectFX StructA struct containing the effect's parameters (-1 if no layer effect is set)
    shaderIDShader AssetThe shader to be applied to the layer (layer_shader)
    elementsArray of Room Layer Element Info StructAn array listing all elements on the layer. Each element type struct contains information specific to it.
    -
    -

    View Info

    -
    -

    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.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    View Info Struct
    Variable NameData TypeDescription
    visibleBooleanWhether the view is visible
    cameraIDCamera IDThe camera assigned to this view
    xviewRealThe x coordinate of the view camera's position
    yviewRealThe y coordinate of the view camera's position
    wviewRealThe width of the view's camera
    hviewRealThe height of the view's camera
    hspeedRealThe horizontal movement speed of the view
    vspeedRealThe vertical movement speed of the view
    xportRealThe x position on screen where the view is drawn
    yportRealThe y position on screen where the view is drawn
    wportRealThe width of the viewport
    hportRealThe height of the viewport
    objectObject AssetThe object of which the first instance in the room should be followed by the camera
    hborderRealThe horizontal border around the instance of the object to follow
    vborderRealThe vertical border around the instance of the object to follow
    -
    -

    Layer Element Info

    -
    -

    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.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Layer Element Info Struct
    Variable NameData TypeDescription
    All Element Types
    idRealThe unique ID of the element
    typeLayer Element Type ConstantThe type of element
    Background Element Type
    sprite_indexSprite AssetThe sprite used by the background
    image_indexRealThe sprite's subimage
    xscaleRealThe scale along the x axis
    yscaleRealThe scale along the y axis
    htiledBooleanWhether to tile the background image horizontally
    vtiledBooleanWhether to tile the background image vertically
    stretchBooleanWhether to stretch the background so it fills the entire room
    visibleBooleanWhether the background should be visible
    blendColourColourThe blend colour to draw the background with
    blendAlphaRealThe alpha value between 0 and 1 to use
    image_speedRealThe image speed of the background
    speed_typeSprite Speed ConstantThe units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
    nameStringThe name of the background
    Instance Element Type
    inst_idObject InstanceThe ID of the instance
    Sprite Element Type
    sprite_indexSprite AssetThe sprite index of this sprite element
    image_indexRealThe subimage of the sprite
    xRealThe x coordinate of the sprite's position
    yRealThe y coordinate of the sprite's position
    image_xscaleRealThe scale of the image along the x axis
    image_yscaleRealThe scale of the image along the y axis
    image_angleRealThe image angle
    image_alphaRealThe alpha value between 0 and 1
    image_blendColourThe blend colour
    image_speedRealThe animation speed of the image, expressed in speed_type units
    speed_typeSprite Speed ConstantThe units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
    nameStringThe name of the sprite element as given in The Room Editor (default is graphic_*)
    Tile Map Element Type
    xRealThe x position (or offset) of the tile map in the room
    yRealThe y position (or offset) of the tile map in the room
    tileset_indexTile Set AssetThe tile set that this tile map uses
    data_maskRealThe bitmask value for the tile map
    tilesArray of RealThis 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.
    widthRealThe width in cells of the tile map
    heightRealThe height in cells of the tile map
    nameStringThe tile map's name
    Particle System Element Type
    psParticle System AssetThe particle system
    xRealThe x coordinate of the particle system's position
    yRealThe y coordinate of the particle system's position
    angleRealThe angle by which the particle system is rotated
    xscaleRealThe scale along the x axis of the particle system
    yscaleRealThe scale along the y axis of the particle system
    blendColourThe blend colour to use to draw the particle system
    alphaRealThe alpha value between 0 and 1 to use
    nameStringThe name of the particle system element as defined in The Room Editor (default is particle_*)
    Tile Element Type
    visibleBooleanWhether the tile is visible
    sprite_indexSprite AssetThe sprite this tile is on
    xRealThe x coordinate of the tile position
    yRealThe y coordinate of the tile position
    widthRealThe width of the tile
    heightRealThe height of the tile
    image_xscaleRealThe scale factor along the x axis of the tile
    image_yscaleRealThe scale factor along the y axis of the tile
    image_angleRealThe angle of the tile
    image_blendColourThe blend colour to use to draw the tile
    image_alphaRealThe alpha to use
    xoRealThe x offset
    yoRealThe y offset
    Sequence Element Type
    xRealThe x coordinate of the sequence position
    yRealThe y coordinate of the sequence position
    image_xscaleRealThe scale along the x axis of the entire sequence
    image_yscaleRealThe scale along the y axis of the entire sequence
    image_angleRealThe angle by which the sequence is rotated
    image_alphaRealThe alpha value between 0 and 1 to use
    image_blendColourThe blend colour to use to draw the sequence
    image_speedRealThe animation speed of the sequence, expressed in speed_type units
    speedTypeSprite Speed ConstantThe units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
    seq_idSequence AssetThe sequence asset
    nameStringThe name of the sequence element as defined in The Room Editor (default is graphic_*)
    head_positionRealThe playhead position of the sequence
    -
    -

    -

    Syntax:

    -

    room_get_info(room, [views], [instances], [layers], [layer_elements], [tilemap_data]);

    - + + + room_get_info + + + + + + + + + + +

    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:

    +

    Room Info

    +
    +

    This is the main struct returned by the function. All variables listed below are present at the root of this returned struct:

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Room Info Struct
    Variable NameData TypeDescription
    widthRealThe width of the room
    heightRealThe height of the room
    creationCodeScript FunctionThe index of the script function that contains this room's creation code
    physicsWorldBooleanWhether the room has a physics world
    physicsGravityXRealThe physics world's gravity component along the x axis
    physicsGravityYRealThe physics world's gravity component along the y axis
    physicsPixToMetersRealThe physics world's pixel-to-metre scale
    persistentBooleanWhether the room is persistent
    enableViewsBooleanWhether views are enabled for the room
    clearDisplayBufferBooleanWhether to clear the display buffer before drawing the room
    clearViewportBackgroundBooleanWhether to clear viewports' backgrounds before drawing to them
    colourColourThe clear colour used when clearDisplayBuffer is set to true
    instancesArray of Room Instance Info StructAn array listing all instances placed in the room with basic information on them
    layersArray of Room Layer Info StructAn array listing all room layers, in order of increasing depth
    viewsArray of Room View Info StructAn array listing all views, ordered by view index
    + +

    Instance Info

    +
    +

    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.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Instance Info Struct
    Variable NameData TypeDescription
    idObject InstanceThe instance ID
    object_indexStringThe name of the object this is an instance of (use asset_get_index to get the actual object)
    xRealThe x coordinate of the instance's position
    yRealThe y coordinate of the instance's position
    xscaleRealThe x scale of the instance
    yscaleRealThe y scale of the instance
    angleRealThe rotation angle of the instance
    image_indexRealThe image index used by the instance
    image_speedRealThe image speed of the instance
    colourColourThe blend colour used to draw the instance
    creation_codeScript FunctionThe index of the script function that contains the instance's creation code
    pre_creation_codeScript FunctionThe 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
    +
    +

    Layer Info

    +
    +

    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.

    + + - - - + + + - - + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Layer Info Struct
    ArgumentTypeVariable NameData Type Description
    roomRoom AssetThe room to get the info fromidRealThe layer handle
    nameStringThe name of the layer
    visibleBooleanWhether the layer is visible
    depthRealThe depth of the layer
    xoffsetRealThe x offset of the layer
    yoffsetRealThe y offset of the layer
    hspeedRealThe horizontal speed of the layer
    vspeedRealThe vertical speed of the layer
    effectEnabledBooleanWhether the layer filter/effect is currently enabled
    effectToBeEnabledBooleanWhether the layer filter/effect should be enabled/disabled in the next frame (the next value of effectEnabled)
    effectFX StructA struct containing the effect's parameters (-1 if no layer effect is set)
    shaderIDShader AssetThe shader to be applied to the layer (layer_shader)
    elementsArray of Room Layer Element Info StructAn array listing all elements on the layer. Each element type struct contains information specific to it.
    +
    +

    View Info

    +
    +

    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.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    View Info Struct
    Variable NameData TypeDescription
    visibleBooleanWhether the view is visible
    cameraIDCamera IDThe camera assigned to this view
    xviewRealThe x coordinate of the view camera's position
    yviewRealThe y coordinate of the view camera's position
    wviewRealThe width of the view's camera
    hviewRealThe height of the view's camera
    hspeedRealThe horizontal movement speed of the view
    vspeedRealThe vertical movement speed of the view
    xportRealThe x position on screen where the view is drawn
    yportRealThe y position on screen where the view is drawn
    wportRealThe width of the viewport
    hportRealThe height of the viewport
    objectObject AssetThe object of which the first instance in the room should be followed by the camera
    hborderRealThe horizontal border around the instance of the object to follow
    vborderRealThe vertical border around the instance of the object to follow
    +
    +

    Layer Element Info

    +
    +

    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.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Layer Element Info Struct
    Variable NameData TypeDescription
    All Element Types
    idRealThe unique ID of the element
    typeLayer Element Type ConstantThe type of element
    Background Element Type
    sprite_indexSprite AssetThe sprite used by the background
    image_indexRealThe sprite's subimage
    xscaleRealThe scale along the x axis
    yscaleRealThe scale along the y axis
    htiledBooleanWhether to tile the background image horizontally
    vtiledBooleanWhether to tile the background image vertically
    stretchBooleanWhether to stretch the background so it fills the entire room
    visibleBooleanWhether the background should be visible
    blendColourColourThe blend colour to draw the background with
    blendAlphaRealThe alpha value between 0 and 1 to use
    image_speedRealThe image speed of the background
    speed_typeSprite Speed ConstantThe units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
    nameStringThe name of the background
    Instance Element Type
    inst_idObject InstanceThe ID of the instance
    Sprite Element Type
    sprite_indexSprite AssetThe sprite index of this sprite element
    image_indexRealThe subimage of the sprite
    xRealThe x coordinate of the sprite's position
    yRealThe y coordinate of the sprite's position
    image_xscaleRealThe scale of the image along the x axis
    image_yscaleRealThe scale of the image along the y axis
    image_angleRealThe image angle
    image_alphaRealThe alpha value between 0 and 1
    image_blendColourThe blend colour
    image_speedRealThe animation speed of the image, expressed in speed_type units
    speed_typeSprite Speed ConstantThe units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
    nameStringThe name of the sprite element as given in The Room Editor (default is graphic_*)
    Tile Map Element Type
    xRealThe x position (or offset) of the tile map in the room
    yRealThe y position (or offset) of the tile map in the room
    tileset_indexTile Set AssetThe tile set that this tile map uses
    data_maskRealThe bitmask value for the tile map
    tilesArray of RealThis 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.
    widthRealThe width in cells of the tile map
    heightRealThe height in cells of the tile map
    nameStringThe tile map's name
    Particle System Element Type
    psParticle System AssetThe particle system
    xRealThe x coordinate of the particle system's position
    yRealThe y coordinate of the particle system's position
    angleRealThe angle by which the particle system is rotated
    xscaleRealThe scale along the x axis of the particle system
    yscaleRealThe scale along the y axis of the particle system
    blendColourThe blend colour to use to draw the particle system
    alphaRealThe alpha value between 0 and 1 to use
    nameStringThe name of the particle system element as defined in The Room Editor (default is particle_*)
    Tile Element Type
    visibleBooleanWhether the tile is visible
    sprite_indexSprite AssetThe sprite this tile is on
    xRealThe x coordinate of the tile position
    yRealThe y coordinate of the tile position
    widthRealThe width of the tile
    heightRealThe height of the tile
    image_xscaleRealThe scale factor along the x axis of the tile
    image_yscaleRealThe scale factor along the y axis of the tile
    image_angleRealThe angle of the tile
    image_blendColourThe blend colour to use to draw the tile
    image_alphaRealThe alpha to use
    xoRealThe x offset
    yoRealThe y offset
    Sequence Element Type
    xRealThe x coordinate of the sequence position
    yRealThe y coordinate of the sequence position
    image_xscaleRealThe scale along the x axis of the entire sequence
    image_yscaleRealThe scale along the y axis of the entire sequence
    image_angleRealThe angle by which the sequence is rotated
    image_alphaRealThe alpha value between 0 and 1 to use
    image_blendColourThe blend colour to use to draw the sequence
    viewsBoolean Whether to include view information in the struct (defaults to true)image_speedRealThe animation speed of the sequence, expressed in speed_type units
    instancesBoolean Whether to include instance information in the struct (defaults to true)speedTypeSprite Speed ConstantThe units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
    layersBoolean Whether to include layer information in the struct (defaults to true)seq_idSequence AssetThe sequence asset
    layer_elementsBoolean Whether to include layer element information in the struct (defaults to true, requires layers to be set to true)nameStringThe name of the sequence element as defined in The Room Editor (default is graphic_*)
    tilemap_dataBoolean Whether to include tile map data in the struct (defaults to true, requires layers and layer_elements to be set to true)head_positionRealThe playhead position of the sequence
    -

    -

    Returns:

    -

    Room Info Struct

    -

    -

    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.

    -

    -

    -
    -
    -
    -
    Back: Rooms
    -
    Next: room_goto
    -
    +
    +

     

    +

    Syntax:

    +

    room_get_info(room, [views], [instances], [layers], [layer_elements], [tilemap_data]);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    roomRoom AssetThe room to get the info from
    viewsBoolean Whether to include view information in the struct (defaults to true)
    instancesBoolean Whether to include instance information in the struct (defaults to true)
    layersBoolean Whether to include layer information in the struct (defaults to true)
    layer_elementsBoolean Whether to include layer element information in the struct (defaults to true, requires layers to be set to true)
    tilemap_dataBoolean Whether to include tile map data in the struct (defaults to true, requires layers and layer_elements to be set to true)
    +

     

    +

    Returns:

    +

    Room Info Struct

    +

     

    +

    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.

    +

     

    +

     

    +
    +
    +
    +
    Back: Rooms
    +
    Next: room_goto
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_bottom.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_bottom.htm index 0e85956a4..540dc6907 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_bottom.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_bottom.htm @@ -4,7 +4,7 @@ sprite_get_bbox_bottom - + @@ -26,7 +26,7 @@

    Syntaxe :

    ArgumentsType Description - + ind The index of the sprite to check. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_left.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_left.htm index 2c345fa07..bfc76b4ea 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_left.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_left.htm @@ -4,7 +4,7 @@ sprite_get_bbox_left - + @@ -26,7 +26,7 @@

    Syntaxe :

    ArgumentsType Description - + ind The index of the sprite to check. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_mode.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_mode.htm index 839e73c39..77a9b36a2 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_mode.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_mode.htm @@ -4,7 +4,7 @@ sprite_get_bbox_mode - + @@ -25,7 +25,7 @@

    Syntaxe :

    ArgumentsType Description - + ind The index of the sprite to check. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_right.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_right.htm index 051b0f983..98323a4e3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_right.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_right.htm @@ -4,7 +4,7 @@ sprite_get_bbox_right - + @@ -26,7 +26,7 @@

    Syntaxe :

    ArgumentsType Description - + ind The index of the sprite to check. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_top.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_top.htm index ea162a4d6..e2846a7b0 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_top.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_bbox_top.htm @@ -4,7 +4,7 @@ sprite_get_bbox_top - + @@ -27,7 +27,7 @@

    Syntaxe :

    ArgumentsType Description - + ind The index of the sprite to check. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_proj_mat.htm b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_proj_mat.htm index fe4167bf8..58836837c 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_proj_mat.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_proj_mat.htm @@ -4,7 +4,7 @@ camera_get_proj_mat - + @@ -25,7 +25,7 @@

    Syntaxe :

    ArgumentsType Description - + camera_id The unique camera ID value returned when you created the camera diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_view_mat.htm b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_view_mat.htm index c56158ba7..ff59e9b49 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_view_mat.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_get_view_mat.htm @@ -4,7 +4,7 @@ camera_get_view_mat - + @@ -25,7 +25,7 @@

    Syntaxe :

    ArgumentsType Description - + camera_id The unique camera ID value returned when you created the camera diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_fullscreen.htm b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_fullscreen.htm index e74fd555b..6120bdbd5 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_fullscreen.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_fullscreen.htm @@ -4,7 +4,7 @@ window_set_fullscreen - + @@ -24,7 +24,7 @@

    Syntaxe :

    ArgumentsType Description - + full Whether to set the screen to fullscreen (true) or not (false). diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm index 42ced143d..325702111 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm @@ -1,593 +1,569 @@ - + - - - particle_get_info - - - - - - - - - - -

    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.

    -

    Particle System Info

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Particle System Info Struct
    Variable NameData TypeDescription
    nameStringThe name of the particle system asset.
    xoriginRealThe X origin of the particle system.
    yoriginRealThe Y origin of the particle system.
    global_spaceBooleanWhether this particle system has global space particles enabled (see part_system_global_space).
    oldtonewBooleanWhether old particles should be drawn behind new ones (true) or not (false).
    emittersArray of Particle Emitter Info StructAn array of emitter info structs, ordered the same as in The Particle System Editor.
    -
    -

    Particle Emitter Info

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Particle Emitter Info Struct
    Variable NameData TypeDescription
    indParticle Emitter IDThe ID of the particle emitter.
    nameStringThe name of the particle emitter.
    modeParticle Emitter Mode ConstantThe mode in which to emit particles. Either ps_mode_stream or ps_mode_burst.
    enabledBooleanWhether the particle emitter is enabled.
    numberRealThe 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.
    relativeBooleanWhether 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).
    xminRealThe X coordinate of the left side of the emitter's region.
    xmaxRealThe X coordinate of the right side of the emitter's region.
    yminRealThe Y coordinate of the top of the emitter's region.
    ymaxRealThe Y coordinate of the bottom of the emitter's region.
    distributionParticle Emitter Distribution ConstantThe distribution style of the particles. One of the ps_distr_* constants.
    shapeParticle Emitter Shape ConstantThe shape of the emitter's region. One of the ps_shape_* constants.
    parttypeParticle Type Info StructThe particle type info struct containing information this emitter's particle type.
    delay_minRealThe minimum delay between particle bursts in stream mode, expressed in delay_unit.
    delay_maxRealThe maximum delay between particle bursts in stream mode, expressed in delay_unit.
    delay_unitTime Source Unit Constant The unit in which delay_min and delay_max are expressed
    interval_minRealThe minimum time between particle bursts in stream mode, expressed in interval_unit.
    interval_maxReal The maximum time between particle bursts in stream mode, expressed in interval_unit.
    interval_unitTime Source Unit ConstantThe unit in which interval_min and interval_max are expressed.
    -
    -

    Particle Type Info

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Particle Type Info Struct
    Variable NameData TypeDescription
    General
    indParticle Type IDThe index of the particle type. This can be used e.g. with the function part_particles_create.
    Shape / Sprite
    spriteSprite AssetThe sprite that the particle type uses or -1.
    frameRealThe sprite subimage in case a sprite is used.
    animateBooleanIf true then the sprite is animated, starting from the frame subimage.
    stretchBooleanIf true then the animation is stretched over the particle's lifetime.
    randomBooleanIf true then a random subimage is used instead of frame.
    shapeParticle Shape ConstantThe particle shape. One of the pt_shape_* constants. Used only if sprite is -1.
    Size
    size_xminRealThe 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_yminRealThe 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_xmaxRealThe 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_ymaxRealThe 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_xincrRealThe value to increase/decrease the particle size on the X axis by each frame.
    size_yincrRealThe value to increase/decrease the particle size on the Y axis by each frame.
    size_xwiggleRealValue randomly added or subtracted from the particle's X size each frame.
    size_ywiggleRealValue randomly added or subtracted from the particle's Y size each frame.
    Scale
    xscaleRealThe X scale of the particle image (sprite or shape).
    yscaleRealThe Y scale of the particle image (sprite or shape).
    Life
    life_minRealThe minimum life of particles of this type (in number of frames).
    life_maxRealThe maximum life of particles of this type (in number of frames).
    Secondary Particles
    death_typeParticle Type IDThe type of particle spawned on death or -1.
    death_numberRealThe number of particles spawned on death.
    step_typeParticle Type IDThe type of particle spawned each step or -1.
    step_numberRealThe number of particles spawned each step.
    Speed
    speed_minRealThe 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_maxRealThe 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_incrRealThe value to increase/decrease the particle speed by each frame.
    speed_wiggleRealA value randomly added or subtracted from the particle speed each frame.
    Direction
    dir_minRealThe 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_maxRealThe 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_incrRealThe value to increase/decrease the particle direction by each frame.
    dir_wiggleRealA value randomly added or subtracted from the particle direction each frame.
    Gravity
    grav_amountRealThe amount of gravity applied to the particle each frame (in pixels per frame).
    grav_dirRealThe gravity direction.
    Orientation
    ang_minRealThe 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_maxRealThe 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_incrRealThe value to increase/decrease the particle angle by each frame.
    ang_wiggleRealA value randomly added or subtracted from the particle angle each frame.
    ang_relativeBooleanIf true then the particle angle is relative to its direction.
    Color & Alpha
    color1ColourThe color of the particle when created.
    color2ColourThe color of the particle when halfway through its lifespan.
    color3ColourThe color of the particle at the end of its lifespan.
    alpha1RealThe alpha of the particle when created.
    alpha2RealThe alpha of the particle when halfway through its lifespan.
    alpha3RealThe alpha of the particle at the end of its lifespan.
    additiveBooleanIf 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:

    - - + + + particle_get_info + + + + + + + + + + +

    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.

    +

    Particle System Info

    +
    +
    Particle Emitter Mode Constant
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Particle System Info Struct
    Variable NameData TypeDescription
    nameStringThe name of the particle system asset.
    xoriginRealThe X origin of the particle system.
    yoriginRealThe Y origin of the particle system.
    global_spaceBooleanWhether this particle system has global space particles enabled (see part_system_global_space).
    oldtonewBooleanWhether old particles should be drawn behind new ones (true) or not (false).
    emittersArray of Particle Emitter Info StructAn array of emitter info structs, ordered the same as in The Particle System Editor.
    +
    +

    Particle Emitter Info

    +
    + + - - + + + - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + +
    Particle Emitter Info Struct
    ConstantVariable NameData Type Description
    ps_mode_streamThe particle emitter streams the given number of particles continuously (see part_emitter_stream)indParticle EmitterThe particle emitter.
    nameStringThe name of the particle emitter.
    modeParticle Emitter Mode ConstantThe mode in which to emit particles. Either ps_mode_stream or ps_mode_burst.
    enabledBooleanWhether the particle emitter is enabled.
    numberRealThe 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.
    relativeBooleanWhether 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).
    xminRealThe X coordinate of the left side of the emitter's region.
    xmaxRealThe X coordinate of the right side of the emitter's region.
    yminRealThe Y coordinate of the top of the emitter's region.
    ymaxRealThe Y coordinate of the bottom of the emitter's region.
    distributionParticle Emitter Distribution ConstantThe distribution style of the particles. One of the ps_distr_* constants.
    shapeParticle Emitter Shape ConstantThe shape of the emitter's region. One of the ps_shape_* constants.
    parttypeParticle Type Info StructThe particle type info struct containing information this emitter's particle type.
    delay_minRealThe minimum delay between particle bursts in stream mode, expressed in delay_unit.
    delay_maxRealThe maximum delay between particle bursts in stream mode, expressed in delay_unit.
    delay_unitTime Source Unit ConstantThe unit in which delay_min and delay_max are expressed
    ps_mode_burstThe particle emitter emits a single burst of the given number of particles (see part_emitter_burst)interval_minRealThe minimum time between particle bursts in stream mode, expressed in interval_unit.
    interval_maxRealThe maximum time between particle bursts in stream mode, expressed in interval_unit.
    interval_unitTime Source Unit ConstantThe unit in which interval_min and interval_max are expressed.
    -

    -

    Syntax:

    -

    particle_get_info(partsys);

    - + +

    Particle Type Info

    +
    +
    + - - - + + + - - + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Particle Type Info Struct
    ArgumentTypeVariable NameData Type Description
    partsysParticle System AssetThe particle system asset to get the info from.General
    indParticle TypeThe particle type. This can be used e.g. with the function part_particles_create.
    Shape / Sprite
    spriteSprite AssetThe sprite that the particle type uses or -1.
    frameRealThe sprite subimage in case a sprite is used.
    animateBooleanIf true then the sprite is animated, starting from the frame subimage.
    stretchBooleanIf true then the animation is stretched over the particle's lifetime.
    randomBooleanIf true then a random subimage is used instead of frame.
    shapeParticle Shape ConstantThe particle shape. One of the pt_shape_* constants. Used only if sprite is -1.
    Size
    size_xminRealThe 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_yminRealThe 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_xmaxRealThe 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_ymaxRealThe 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_xincrRealThe value to increase/decrease the particle size on the X axis by each frame.
    size_yincrRealThe value to increase/decrease the particle size on the Y axis by each frame.
    size_xwiggleRealValue randomly added or subtracted from the particle's X size each frame.
    size_ywiggleRealValue randomly added or subtracted from the particle's Y size each frame.
    Scale
    xscaleRealThe X scale of the particle image (sprite or shape).
    yscaleRealThe Y scale of the particle image (sprite or shape).
    Life
    life_minRealThe minimum life of particles of this type (in number of frames).
    life_maxRealThe maximum life of particles of this type (in number of frames).
    Secondary Particles
    death_typeParticle TypeThe type of particle spawned on death or -1.
    death_numberRealThe number of particles spawned on death.
    step_typeParticle TypeThe type of particle spawned each step or -1.
    step_numberRealThe number of particles spawned each step.
    Speed
    speed_minRealThe 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_maxRealThe 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_incrRealThe value to increase/decrease the particle speed by each frame.
    speed_wiggleRealA value randomly added or subtracted from the particle speed each frame.
    Direction
    dir_minRealThe 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_maxRealThe 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_incrRealThe value to increase/decrease the particle direction by each frame.
    dir_wiggleRealA value randomly added or subtracted from the particle direction each frame.
    Gravity
    grav_amountRealThe amount of gravity applied to the particle each frame (in pixels per frame).
    grav_dirRealThe gravity direction.
    Orientation
    ang_minRealThe 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_maxRealThe 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_incrRealThe value to increase/decrease the particle angle by each frame.
    ang_wiggleRealA value randomly added or subtracted from the particle angle each frame.
    ang_relativeBooleanIf true then the particle angle is relative to its direction.
    Color & Alpha
    color1ColourThe color of the particle when created.
    color2ColourThe color of the particle when halfway through its lifespan.
    color3ColourThe color of the particle at the end of its lifespan.
    alpha1RealThe alpha of the particle when created.
    alpha2RealThe alpha of the particle when halfway through its lifespan.
    alpha3RealThe alpha of the particle at the end of its lifespan.
    additiveBooleanIf true then the particle is drawn with additive blending (i.e. using the Blend Mode Constant bm_add).
    -

    -

    Returns:

    -

    Particle System Info Struct

    -

    -

    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.

    -

    -

    -
    -
    -
    -
    Back: Particles
    - -
    +
    +

     

    +

    Finally there is also a constant for the particle emitter mode:

    + + + + + + + + + + + + + + + + + + + + +
    Particle Emitter Mode Constant
    ConstantDescription
    ps_mode_streamThe particle emitter streams the given number of particles continuously (see part_emitter_stream)
    ps_mode_burstThe particle emitter emits a single burst of the given number of particles (see part_emitter_burst)
    +

     

    +

    Syntax:

    +

    particle_get_info(partsys);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    partsysParticle System AssetThe particle system asset to get the info from.
    +

     

    +

    Returns:

    +

    Particle System Info Struct

    +

     

    +

    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.

    +

     

    +

     

    +
    +
    +
    +
    Back: Particles
    +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_ortho.htm b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_ortho.htm index 2499b925c..05829e184 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_ortho.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_ortho.htm @@ -26,7 +26,7 @@

    Syntaxe :

    ArgumentsType Description - + w The width of the projection. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective.htm b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective.htm index d20dd0ac7..c892c2445 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective.htm @@ -28,7 +28,7 @@

    Syntaxe :

    ArgumentsType Description - + w The width of the projection at the near Z position. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective_fov.htm b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective_fov.htm index 734509f10..d26aa8b24 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective_fov.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_build_projection_perspective_fov.htm @@ -25,7 +25,7 @@

    Syntaxe :

    ArgumentsType Description - + fov The angle of the field of view. diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_inverse.htm b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_inverse.htm new file mode 100644 index 000000000..cc8acfb05 --- /dev/null +++ b/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Matrix_Functions/matrix_inverse.htm @@ -0,0 +1,76 @@ + + + + + + matrix_inverse + + + + + + + + + + +

    matrix_inverse

    +

    This function returns a new matrix that is the inverse of the matrix you pass it.

    +

    The inverse of a matrix is the matrix that, when multiplied with the original matrix, is equal to an identity matrix.

    +

    From a more practical perspective, the inverse of a matrix undoes the transformation of the original matrix. For example, the matrix matrix_build(100, 100, 0, 90, 0, 0, 1, 1, 1) first rotates about x by 90 degrees and then moves right 100 and down 100. Its inverse matrix matrix_inverse(matrix_build(100, 100, 0, 90, 0, 0, 1, 1, 1)) first moves left 100 and up 100 and then rotates about x by -90 degrees, performing the exact same steps in reverse order. The product of these matrices (i.e. matrix_multiply(inverse, transform)) will be an identity matrix.

    +

     

    +

    Syntax:

    +

    matrix_inverse(matrix);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    matrixMatrixThe matrix to get the inverse of
    +

     

    +

    Returns:

    +

    Matrix

    +

     

    +

    Example:

    +

    transform = matrix_build(x, y, 0, 90, 0, direction, 1, 1, 1);
    + transform_inverse = matrix_inverse(transform);
    +
    + transform_product = matrix_multiply(transform, transform_inverse);
    +
    + show_debug_message(transform);
    + show_debug_message(transform_inverse);
    + show_debug_message(transform_product); +

    +

    The above code shows how to build a transform matrix, get its inverse using matrix_inverse and multiply the two matrices back together. The three matrices, i.e. the original matrix, its inverse and their product are then output in a debug message. Note that the product of the matrices is equal to an identity matrix (i.e. matrix_build_identity).

    +

     

    +

     

    +
    +
    +
    + + +
    +
    +
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    +
    + + + + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Networking/network_send_broadcast.htm b/Manual/contents/GameMaker_Language/GML_Reference/Networking/network_send_broadcast.htm index 671c0bb5e..4cf5430a5 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Networking/network_send_broadcast.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Networking/network_send_broadcast.htm @@ -56,7 +56,7 @@

    Les retours :

    Exemple :

    buffer_seek(broadcast_buffer, buffer_seek_start, 0);
    - buffer_write(broadcast_buffer, buffer_string, global.ServerName);
    + buffer_write(broadcast_buffer, buffer_string, global.server_name);
    network_send_broadcast(server, 6511, broadcast_buffer, buffer_tell(broadcast_buffer));

    Le code ci-dessus écrit la chaîne de nom du serveur actuel (stockée dans "global.ServerName"), puis l'écrit dans un fichier binaire buffer avec l'id "broadcast_buffer". Ces données sont ensuite diffusées localement vers une plage d'IP (l'IP du périphérique est actuellement impliquée comme plage de base de diffusion) sur le port 6511.

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Strings/string_delete.htm b/Manual/contents/GameMaker_Language/GML_Reference/Strings/string_delete.htm index e23128d17..95ea5bedb 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Strings/string_delete.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Strings/string_delete.htm @@ -4,7 +4,7 @@ string_delete - + diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Variable_Functions/Array_Functions.htm b/Manual/contents/GameMaker_Language/GML_Reference/Variable_Functions/Array_Functions.htm index 0fa7fe8db..b1e22e9cf 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Variable_Functions/Array_Functions.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Variable_Functions/Array_Functions.htm @@ -104,6 +104,7 @@

    Offset And Length

  • The offset is the 0-based index where the function starts operating on the array.
    • The offset can be a negative number, in which case it will start from the end of the array. For example, an offset of -1 refers to the last element of the array, -2 refers to the second-last element, and so on.
      • +
    • The offset that you pass is clamped between 0 and the last element. For example, an offset of 6 used with an array of 4 elements will refer to the last element 3, an offset of -infinity used with that same array will refer to the first element 0.
  • The length is the number of elements that are checked in the array, starting at the offset. @@ -123,7 +124,7 @@

    Offset And Length

    • -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    +
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    \ No newline at end of file diff --git a/Manual/contents/IDE_Tools/Project_Tool.htm b/Manual/contents/IDE_Tools/Project_Tool.htm index f6e4f3e4b..e5c0e8d9f 100644 --- a/Manual/contents/IDE_Tools/Project_Tool.htm +++ b/Manual/contents/IDE_Tools/Project_Tool.htm @@ -14,14 +14,14 @@

    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

    Project Tool

    The tool window contains the following fields: