layer_sprite_get_y


Description

This function can be used to get the y position of the sprite element in the room. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return the y position value.


Syntax:

layer_sprite_get_y(sprite_element_id);


Arguments:

Argument Description
sprite_element_id The unique ID value of the sprite element to get the information from


Returns:

Real


Example:

var lay_id = layer_get_id("sprite_sky");
var spr_id = layer_sprite_get_id(lay_id, "Clouds");
if layer_sprite_get_y(spr_id) < 0
   {
   layer_sprite_y(spr_id, room_height);
   }

The above code will get the layer ID for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element y position and if it is less than 0, then the layer element is moved to a different y position.


Back: Sprite Layer Functions
next: layer_sprite_get_id
© Copyright YoYo Games Ltd. 2018 All Rights Reserved