layer_background_get_vtiled


Description

This function can be used to find out if the background element is tiled vertically or not. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element is currently tiled, or false if it is not.


Syntax:

layer_background_get_vtiled(background_element_id);


Arguments:

Argument Description
background_element_id The unique ID value of the background element to get the information from


Returns:

Boolean


Example:

var lay_id = layer_get_id("Background_sky");
var back_id = layer_background_get_id(lay_id);
if !layer_background_get_vtiled(back_id)
   {
   layer_background_vtiled(back_id, true);
   }

The above code will get the layer ID for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check if the element is tiling across the vertical axis, and if it is not then it is set to do so.


Back: Background Layer Functions
next: layer_background_get_stretch
© Copyright YoYo Games Ltd. 2018 All Rights Reserved