layer_get_hspeed


Description

You can use this function to retrieve 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 function returns a real number for the horizontal speed, where a positive value is to the right and a negative value to the left. Default is 0 (unless set in the room editor).


Syntax:

layer_get_hspeed(layer_id)


Arguments:

Argument Description
layer_id The unique ID value of the layer to get the horizontal speed from


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_get_vspeed
© Copyright YoYo Games Ltd. 2018 All Rights Reserved