layer_hspeed


Description

You can use this function to set the horizontal speed (in pixels per game frame) of the layer within the currently scoped room. You supply the layer ID (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the speed value to set, where a positive value is to the right and a negative value to the left.


Syntax:

layer_hspeed(layer_id, hspd)


Arguments:

Argument Description
layer_id The unique ID value of the layer to set the horizontal speed of
hspd The horizontal speed (in pixels per game frame) to set


Returns:

N/A


Example:

var lay_id = layer_get_id("Sprites");
if layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0
    {
    layer_hspeed(lay_id, 0);
    layer_vspeed(lay_id, 0);
    }

The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.


Back: General Layer Functions
next: layer_vspeed
© Copyright YoYo Games Ltd. 2018 All Rights Reserved