layer_create


Description

This function is used to create a new layer within the current room. You supply the depth that the new layer is to occupy and the function returns the unique Layer ID value that can then be used to access the layer in further functions. You can also supply an optional "name" argument, which will enable you to give the layer a specific name (as a string), and instead of using the layer ID to access the layer, you can use this name string instead, although it should be noted that using name strings will have a greater impact on performance than using just the ID value.

When giving a depth value, this will be higher the "further away" from the camera the layer is and lower the "closer" to the camera the layer is, so if you have three layers with depths -100, 0, 100, the layers will draw in the order 100, 0, -100, so that the "top" layer (ie, the closest to the camera view and so drawn over everything else) will be the layer with the -100 depth.

The following image shows a schematic of how depth works for layers: Layer Depth

It is worth noting that while you can assign more than one layer to a single depth, there is no way that you can guarantee that layers on the same depth will be drawn in any given order and as such it is best to assign only one layer to any given depth. Also note that the minimum and maximum layer depths are -16000 to 16000, and anything outside of those depths will not be rendered. If you require a depth outside of that range then you will need to use the function layer_force_draw_depth.


Syntax:

layer_create(depth, [name])


Arguments:

Argument Description
depth The depth that the layer has to be created at.
name The name to give the layer (a string - optional)


Returns:

Layer ID (Real)


Example:

global.Bullet_Layer = layer_create(-100);

The above code will create a new layer with a depth value of -100 and assign its ID value to a global variable.


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