GameMaker

https://github.com/yoyogames/gamemaker-manual
Admin
The official source for the GameMaker manual, used for building the comprehensive documentation for...
Tokens:2,218,449
Snippets:16,645
Trust Score:8.2
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Start movie recording example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/GXC/Challenges/gxc_start_movie_recording.htm

Starts a video recording at 320x240 resolution, 4 frames per second, without audio.

```gml
gxc_start_movie_recording(320, 240, 4, false);
```

--------------------------------

### vertex_begin example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Primitives/vertex_begin.htm

This example defines a new vertex format with position, colour, and texture coordinates, creates a vertex buffer, and starts the primitive definition process. It is used to set up the buffer and format for subsequent vertex data.

```GML
vertex_format_begin();
vertex_format_add_position();
vertex_format_add_colour();
vertex_format_add_texcoord();
v_format = vertex_format_end();
v_buff = vertex_create_buffer();
vertex_begin(v_buff, v_format);
```

--------------------------------

### layer_script_begin

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_begin.htm

This snippet documents the layer_script_begin function, including its syntax, parameters, and an extended example showing how to assign a shader setup function to a layer.

```APIDOC
## layer_script_begin(layer_id, script)

### Description
Assigns a function to a layer that will be called before the layer is rendered. The function is executed at the start of each draw event, so you may need to check the current event type and number within the function.

### Syntax
`layer_script_begin(layer_id, script)`

### Parameters
- **layer_id** (String or Layer) - Required - The layer to target, either the layer name as a string or the layer ID obtained from `layer_get_id`.
- **script** (Function) - Required - The function to assign to the layer, or -1 to not assign any.

### Returns
N/A

### Extended Example
```gml
/// @function layer_shader_start();
function layer_shader_start()
{
    if (event_type == ev_draw)
    {
        if (event_number == ev_draw_normal)
        {
            colour_to_find = shader_get_uniform(sShaderDemo5, "f_Colour1");
            colour_to_set = shader_get_uniform(sShaderDemo5, "f_Colour2");
            shader_set(s_ColourChanger);
            shader_set_uniform_f(colour_to_find, 1, 1, 1);
            shader_set_uniform_f(colour_to_set, 1, 0, 0);
        }
    }
}

/// @function layer_shader_end();
function layer_shader_end()
{
    if (event_type == ev_draw)
    {
        if (event_number == ev_draw_normal)
        {
            shader_reset();
        }
    }
}

var lay_id = layer_get_id("Instances");
layer_script_begin(lay_id, layer_shader_start);
layer_script_end(lay_id, layer_shader_end);
```
```

--------------------------------

### Check audio availability and pause/resume music

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Audio/audio_system_is_available.htm

Use this example to pause or resume a music track based on whether the audio system is available. If available, it resumes or starts the music; otherwise, it pauses it. The example uses global.Music as the sound reference.

```gml
if audio_system_is_available()  
{  
    if audio_is_paused(global.Music)  
    {  
        audio_resume_sound(global.Music)  
    }  
    else  
    {  
        if !audio_is_playing(global.Music)  
        {  
            global.Music = audio_play_sound(snd_Music, 0, true);  
        }  
    }  
}  
else  
{  
    if audio_is_playing(global.Music)  
    {  
        audio_pause_sound(global.Music);  
    }  
}
```

--------------------------------

### Example: Get particle data and draw sprites

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Physics/Soft_Body_Particles/physics_particle_get_data.htm

This example retrieves the number of particles, creates a buffer, and uses physics_particle_get_data to fill it with position and color data. It then reads the buffer to draw sprites at each particle's position with the correct alpha.

```gml
var count = physics_particle_count();
var flags = phy_particle_data_flag_position | phy_particle_data_flag_colour;
if (count > 0)
{
    var buffer = buffer_create(count * 12, buffer_grow, 4);
    physics_particle_get_data(buffer, flags);
    for (var n = 0; n < count; n++)
    {
        var xx = buffer_read(buffer, buffer_f32);
        var yy = buffer_read(buffer, buffer_f32);
        var argb = buffer_read(buffer, buffer_u32);
        var alpha = (argb >> 24) & 255;
        draw_sprite_ext(sprBlob, 0, xx, yy, 1, 1, 0, c_green, alpha);
    }
    buffer_delete(buffer);
}
```

--------------------------------

### Create and set up a camera with view and projection matrices

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/camera_create.htm

Creates a new camera and assigns it to view_camera[0], then builds and sets the view and projection matrices using matrix_build_lookat and matrix_build_projection_ortho. The camera must have at least a position and view size set, otherwise it will be invalid and produce odd results when applied to a viewport.

```gml
view_camera[0] = camera_create();
var _viewmat = matrix_build_lookat(640, 240, -10, 640, 240, 0, 0, 1, 0);
var _projmat = matrix_build_projection_ortho(640, 480, 1.0, 32000.0);
camera_set_view_mat(view_camera[0], _viewmat);
camera_set_proj_mat(view_camera[0], _projmat);
```

--------------------------------

### Example: Get file name with filename_name

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_System/filename_name.htm

This example uses filename_name with file_find_first to get the name of the first .doc file in a directory. The result is stored in the variable 'name'.

```gml
name = filename_name(file_find_first("C:/Games/*.doc", 0));
```

--------------------------------

### Wait for audio system initialisation on HTML5 (Create and Step events)

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Audio/audio_system_is_initialised.htm

Use this two-part example to defer audio setup until the HTML5 audio system is initialised. The Create event initialises flags and variables; the Step event polls audio_system_is_initialised() and, once true, creates a custom audio bus and emitter. This prevents errors from referencing undefined audio objects on HTML5.

```GML
// Initially, the audio system is not initialised  
audio_initialised = false;  
  
em_emitter = -1;  
bus_special_effects = -1;
```

```GML
// Check until the system is initialised  
if !audio_initialised && audio_system_is_initialised()  
{  
    audio_initialised = true;  
    
    // First-time initialization  
    bus_special_effects = audio_bus_create();  
    bus_special_effects[0] = audio_effect_create(AudioEffectType.Reverb1);  
    em_emitter = audio_emitter_create();  
    audio_emitter_bus(em_emitter, bus_special_effects);  
}  
  
if (audio_initialised)  
{  
    // The audio system can be used here  
    // ...  
}
```

--------------------------------

### Converting from BPM Example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Audio/Audio_Loop_Points/Audio_Loop_Points.htm

Calculates the time for a specified number of bars based on BPM and sets the loop start position accordingly. This example sets the loop start to the beginning of the fifth bar.

```gml
var _bpm_to_sec = time_bpm_to_seconds(126);
var _beats_per_bar = 4;
var _bars = 4;
audio_sound_loop_start(snd_bgm, (_bars * _beats_per_bar) * _bpm_to_sec);
```

--------------------------------

### Run a game on Windows with Igor

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/Settings/Building_via_Command_Line.htm

Step-by-step example for running a game on Windows: navigate to the Igor directory, verify Igor is accessible, then run the game by supplying the project file, runtime directory, licence file, platform, and build type. Enclose each directory in double quotes to handle spaces.

```command line
cd <igor dir>
```

```command line
igor
```

```command line
igor /project="<yourProjectDir>\projectname.yyp" /rp="<runtime dir>" /lf="<plist dir>\licence.plist" Windows Run
```

--------------------------------

### buffer_seek Example: Seek to Start and Write Three 16-bit Integers

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Buffers/buffer_seek.htm

This example seeks to the start of the buffer stored in the variable 'buff', then writes three signed 16-bit integer values (0, x, y) to it. Using buffer_seek_start with an offset of 0 resets the seek position to the beginning, ensuring data is written from the start.

```GML
buffer_seek(buff, buffer_seek_start, 0);
buffer_write(buff, buffer_s16, 0);
buffer_write(buff, buffer_s16, x);
buffer_write(buff, buffer_s16, y);
```

--------------------------------

### path_start example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Paths/path_start.htm

Starts the instance following the path stored in the variable 'path' at a speed of 4 pixels per step, relative to the instance's position, and reverses direction when the end is reached.

```gml
path_start(path, 4, path_action_reverse, false);
```

--------------------------------

### Intro & Outro Loop Example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Audio/Audio_Loop_Points/Audio_Loop_Points.htm

Sets up a loop for an audio file with an intro, looping mid-section, and outro. Plays the sound looped, then disables looping to transition to the outro. After the sound stops, the instance becomes invalid and must be replayed.

```gml
audio_sound_loop_start(snd_music, 10);
audio_sound_loop_end(snd_music, 20);
ins_sound = audio_play_sound(snd_music, 100, true);  // Play the sound looped
```

```gml
audio_sound_loop(ins_sound, false);
```

--------------------------------

### typeof example: get data type of global variable

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Variable_Functions/typeof.htm

Gets the data type of the global variable global.ExtensionInput and stores it in a local variable, then outputs a message to the console using show_debug_message.

```gml
var _str = typeof(global.ExtensionInput);  
show_debug_message("global.ExtensionInput is a " + _str);
```

--------------------------------

### tileset_get_texture example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Tilsets/tileset_get_texture.htm

Gets the texture of a tile set and draws a textured triangle strip primitive.

```gml
var tex;
tex = tileset_get_texture(spr_Wall, 0);
draw_primitive_begin_texture(pr_trianglestrip, tex);
draw_vertex_texture(0, 0, 0, 0);
draw_vertex_texture(480, 0, 1, 0);
draw_vertex_texture(480, 640, 1, 1);
draw_vertex_texture(0, 640, 0, 1);
draw_primitive_end();
```

--------------------------------

### Get character code at index 7

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Strings/string_ord_at.htm

Used to get the character code of the seventh character in a string. The index starts at 1, with 'H' as the first character. The result is stored in the variable 'char_code'.

```gml
str = "Hello World";
char_code = string_ord_at(str, 7);
```

--------------------------------

### wallpaper_set_config Example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Live_Wallpapers/wallpaper_set_config.htm

Complete example of wallpaper_set_config with two sections: one for animation (range and booleans) and one for colours (colour and range). The array is initialised in a local variable and passed to the function.

```gml
var _config =  
[  
    {  
        type: "section",  
        name: "animation",  
        label: "Animation",  
        children:  
        [  
            {  
                type: "range",  
                name: "speed",  
                label: "Rotation speed",  
                value: 50,  
                min: 0,  
                max: 200,  
                step: 25  
            },  
            {  
                type: "boolean",  
                name: "clockwiseRotation",  
                label: "Clockwise rotation",  
                value: false  
            },  
            {  
                type: "boolean",  
                name: "pause",  
                label: "Pause animation",  
                value: true  
            }  
        ]  
    },  
    {  
        type: "section",  
        name: "colours",  
        label: "Colours",  
        children:  
        [  
           {  
                type: "colour",  
                name: "blendColor",  
                label: "Blend colour",  
                value: #FA1E4E  
            },  
            {  
                type: "range",  
                name: "blendAlpha",  
                label: "Blend alpha",  
                value: 100  
            }  
        ]  
    }  
];  
  
wallpaper_set_config(_config);
```

--------------------------------

### Get buffer start and end addresses

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Buffers/buffer_get_address.htm

Gets the memory address of the buffer stored in buff_model and then calculates the end address by adding the buffer size. Both values are stored in local variables for further use.

```gml
var _address = buffer_get_address(buff_model);
var _end_address = _address + buffer_get_size(buff_model);
```

--------------------------------

### Example: window_get_visible_rects usage

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_get_visible_rects.htm

The example retrieves the current window position and size, then calls window_get_visible_rects to get display overlap data and calculates the number of displays by dividing the array length by 8.

```GML
var _wx = window_get_x();
var _wy = window_get_y();
var _ww = window_get_width();
var _wh = window_get_height();
display_data = window_get_visible_rects(_wx, _wy, _wx + _ww, _wy + _wh);
display_num = array_length(display_data) / 8;
```

--------------------------------

### mp_linear_path example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Movement_And_Collisions/Motion_Planning/mp_linear_path.htm

Checks for a linear path from the current instance to obj_player and starts the path if one is found.

```gml
if (mp_linear_path(path, obj_player.x, obj_player.y, 2, 0))
{
    path_start(path, 2, 0, 0);
}
```

--------------------------------

### part_type_size_x example: Create, Step, and Clean Up events

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/Particle_Types/part_type_size_x.htm

Sets up a particle system and type, configures X-axis size with part_type_size_x, creates particles at the mouse in the Step event, and cleans up in the Clean Up event.

```gml
ps = part_system_create();
pt = part_type_create();
part_type_shape(pt, pt_shape_pixel);
part_type_size_x(pt, 1, 2, 0.2, 0.1);
```

```gml
part_particles_create(ps, mouse_x, mouse_y, pt, 3);
```

```gml
part_system_destroy(ps);
part_type_destroy(pt);
```

--------------------------------

### PREFABS RESTORE command help and options

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/Settings/Building_via_Command_Line.htm

Displays the full description and options for the PREFABS RESTORE command. Use 'HELP' or 'HELP <COMMAND>' (e.g., 'HELP PREFABS') for up-to-date information. The options include SOURCE, PACKAGETOOLNPM, PACKAGETOOLNODE, PACKAGETOOLREGISTRY, PACKAGETOOLREGISTRYUSER, PACKAGETOOLREGISTRYPASS, PACKAGETOOLPACKAGEPATH, and PACKAGETOOLVERBOSE.

```text
PREFABS RESTORE - Find all Prefabs that the project requires and add them to the given cache if they are missing.
If PREFABSFOLDER is not set, this will install the prefabs locally to the project.
This will require PACKAGETOOL being set if you wish to download missing prefabs, otherwise a list is returned.
-------------------------------------------------------
PREFABS RESTORE
        SOURCE = <Path to Source YYP. Can be omitted to use the project in memory> (Optional)
        PACKAGETOOLNPM = <Override default path to PackageTool NPM> (Optional)
        PACKAGETOOLNODE = <Override default path to PackageTool Node> (Optional)
        PACKAGETOOLREGISTRY = <Set a specific Registry for PackageTool to use> (Optional, default = http://gmpm.gamemaker.io)
        PACKAGETOOLREGISTRYUSER = <Username for PackageTool registry> (Optional)
        PACKAGETOOLREGISTRYPASS = <Password for PackageTool registry> (Optional)
        PACKAGETOOLPACKAGEPATH = <Path to PackageTool Packages. Will use a temp directory by default.> (Optional)
        PACKAGETOOLVERBOSE = <Forward PackageTool Output> (Optional, default = FALSE)
Relevant Global Arguments
------------------------------------------------------
Global Arguments
        PACKAGETOOL = <Path to PackageTool to automatically download and install prefabs> (Optional)
        GMPM_DLL = <Path to GMPM.dll to pass to PackageTool> (Optional)
        PREFABSFOLDER = <Path to prefab library packages folder> (Optional
```

--------------------------------

### GM2040 - event_inherited() with no parent event

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/The_Asset_Editors/Code_Editor_Properties/Feather_Messages.htm

Example for GM2040: a child object calls event_inherited() in its Room Start event, but the parent object has no Room Start event. The call can be removed or commented out until the parent defines the event.

```GML
/// obj_parent
// No Room Start event

/// obj_child.Room_Start
event_inherited();
```

--------------------------------

### xstart

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Instances/Instance_Variables/xstart.htm

Documentation for the instance variable xstart, which stores the initial x position of an instance when created in the room.

```APIDOC
## xstart

### Description
This variable stores the initial x position of the instance when it is first created in the room. This is not a read-only variable and can be set as well as read.

### Syntax
`xstart`

### Returns
(single precision floating point value)

### Example
```gml
if (place_meeting(x, y, obj_spike))
{
    score -= 100;
    x = xstart;
    y = ystart;
}
```
The above code will check for a collision with an instance of "obj_spike" and if there is one, it deducts 100 from the score and moves the instance back to its starting position.
```

--------------------------------

### Get align self value

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Flex_Panels/Function_Reference/Styling_Functions/flexpanel_node_style_get_align_self.htm

This example retrieves the align self value of a node and stores it in a local variable.

```gml
var _align_self = flexpanel_node_style_get_align_self(_node);
```

--------------------------------

### Create and play an audio queue with 10 buffers

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/The_Asset_Editors/Object_Properties/Async_Events/Audio_Playback.htm

Creates an audio queue using audio_create_play_queue, adds 10 buffered sounds with audio_queue_sound, and plays it with audio_play_sound. This setup triggers the Audio Playback event as each buffer finishes.

```GML
audio_queue = audio_create_play_queue(buffer_s16, 11052, audio_mono);
for (var i = 0; i < 10; i++)
   {
   audio_queue_sound(audio_queue, audio_buffer[i], 0, buffer_get_size(audio_buffer[i]));
   }
audio_play_sound(audio_queue, 0, true);
```

--------------------------------

### Get texture width from sprite

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Textures/texture_get_width.htm

This example obtains the texture width from a sprite asset using texture_get_width with sprite_get_texture.

```gml
tex_w = texture_get_width(sprite_get_texture(spr_Model_tex, 0));
```

--------------------------------

### Example 2: Base speed in pixels per second

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Maths_And_Numbers/Date_And_Time/delta_time.htm

Calculates a delta time ratio by dividing delta_time by 1,000,000 to get seconds per step, then multiplies the base speed (spd) in pixels per second by this ratio to set the instance speed.

```gml
var _dt = delta_time / 1000000;
speed = spd * _dt;
```

--------------------------------

### ds_grid_add_grid_region example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_add_grid_region.htm

Adds the region of cells from (0,0) to (1,5) of the grid to the cells starting at position (2,0) on the same grid.

```gml
ds_grid_add_grid_region(grid, grid, 0, 0, 1, 5, 2, 0);
```

--------------------------------

### font_get_name example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Fonts/font_get_name.htm

Gets the name of a font resource as it appears in the Asset Browser and stores it as a string in the variable 'fnt_Name'.

```gml
fnt_Name = font_get_name(font0);
```

--------------------------------

### path_start

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Paths/path_start.htm

Documentation for the path_start function, which starts a path for the calling instance.

```APIDOC
## path_start(path, speed, endaction, absolute)

### Description
Starts the given path for the calling instance. The instance will follow the path at the specified speed, with the given end action, and either in absolute or relative mode.

### Syntax
`path_start(path, speed, endaction, absolute)`

### Parameters
- **path** (Path Asset) - The path index to start.
- **speed** (Real) - The speed at which to follow the path in pixels per step. Negative values mean going backwards.
- **endaction** (Path End Action Constant) - What to do when the end of the path is reached.
- **absolute** (Boolean) - Whether the calling instance should follow the absolute path as defined in the Path Editor (true) or a relative path to its current position (false).

### Returns
N/A

### Example
```gml
path_start(path, 4, path_action_reverse, false);
```
This will make the calling instance follow the path indexed in the variable "path" at a speed of 4 pixels per step. It will follow the path relative to its own position, and when it reaches the end it will reverse direction and go back the way it came.
```

--------------------------------

### Example: Constructing and applying a mapping string

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Game_Input/GamePad_Input/gamepad_test_mapping.htm

Loops through instances to build a mapping string from variables and applies it to the gamepad slot. The mapping string is constructed by concatenating the GUID, description, and bindings from instance variables.

```gml
var mapping = gamepad_get_guid(global.padIndex) + "," + gamepad_get_description(global.padIndex);
var len = array_length(global.PadInstances);
for (i = 0; i < len; i += 2)
{
    var left = global.PadInstances[i];
    var right = global.PadInstances[i+1];
    mapping += "," + left.sdlLabel + ":" + right.binding;
}
gamepad_test_mapping(global.padIndex, mapping);
```

--------------------------------

### tag_get_asset_ids example

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/tag_get_asset_ids.htm

Finds all path assets tagged 'enemy', picks one at random, and starts that path on the instance.

```gml
var _paths = tag_get_asset_ids("enemy", asset_path);
var _num = irandom(array_length(_paths) - 1);
path_start(_paths[_num], 1, path_action_reverse, false);
```

--------------------------------

### view_wport[0 ... 7]

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/Cameras_And_Viewports/view_wport.htm

Gets or sets the width of the specified viewport. The viewport width determines the game window or background canvas width at game start, and changing it after start requires window_set_size to take effect.

```APIDOC
## view_wport[0 ... 7]

### Description
Gets or sets the width of the specified viewport. The viewport width determines the width of the game window or background canvas at the start of the game. Changing this value after the game has started will have no visible effect on the game window size unless called along with window_set_size. If the viewport size differs from the camera size, the camera view will be scaled to fit.

### Syntax
view_wport[0 ... 7]

### Parameters
- **index** (Real) - The viewport index (0 to 7) to get or set the width for.

### Returns
Real - The width of the viewport in pixels.

### Example
camera_set_view_size(view_camera[0], view_wport[0], view_hport[0]);

This sets the width and height of the camera view to match the width and height of the viewport.
```

--------------------------------

### Example tests.json file

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/Settings/Building_via_Command_Line.htm

Example of a tests.json file with three test objects, each specifying a name, path, and command, with additional optional keys like platform, target, timeout, waittime, and device.

```json
[
 {
  "name" : "Game Idea Windows",
  "path" : "C:/scratch/GameIdea.yyz",
  "platform" : "Windows",
  "command" : "Run",
  "timeout" : "500",
  "waittime" : "30"
 },
 {
  "name" : "Platformer Game Windows",
  "path" : "C:/Users/<MY USERNAME>/Documents/GameMakerStudio2/Platformer Game/PlatformerGame.yyp",
  "target" : "Windows|Local,HTML5|selenium:firefox,PS4|Default",
  "command" : "Run"
 },
 {
  "name" : "Puzzle Game Windows",
  "path" : "C:/Users/<MY USERNAME>/Documents/GameMakerStudio2/Puzzle Game/PuzzleGame.yyp",
  "platform" : "HTML5",
  "command" : "Run",
  "device" : "selenium:chrome"
 }
]
```

--------------------------------

### Start recording and create custom buffer

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/The_Asset_Editors/Object_Properties/Async_Events/Audio_Recording.htm

Starts recording from input source 0 and creates a custom buffer to store the recorded audio. The channel index is stored for later comparison in the event.

```gml
channel_index = audio_start_recording(0);  
audio_buffer = buffer_create(len, buffer_fast, 1);
```

--------------------------------

### Example batch file command

Source: https://github.com/yoyogames/gamemaker-manual/blob/develop/Manual/contents/Settings/Command_Line_Parameters.htm

An example of the final batch file command with actual paths, showing how to launch a specific game version.

```batch
START C:\ProgramData\GameMakerStudio2\Cache\runtimes\runtime-9.9.1.199\windows\Runner.exe -game D:\Users\Mark\AppData\Local\Temp\GameMaker\AlphaDog_Reboot\AlphaDog_Reboot.win
```
Tokens:
Raw