layer_get_script_begin


Description

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 this function will return the script index of the script assigned to run at the beginning of rendering for that layer, or it will return -1 if no script is assigned.


Syntax:

layer_get_script_begin(layer_id);


Arguments:

Argument Description
layer_id The unique ID value of the layer to target (or the layer name as a string)


Returns:

Script Index (Real) or -1 if no script is assigned


Example:

if layer_get_script_begin(layer) == -1
   {
   layer_script_begin(layer, scr_SetShaderValues);
   }

The above code will check to see if the layer that the instance running the code has a script assigned to it and if it doesn't one is assigned.


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