struct MAGES::InteractionLayerMask¶

Overview¶

A struct that represents a layer mask for interaction. More…

struct InteractionLayerMask
{
    // properties

    int Everything;
    int Nothing;
    int Value;

    // methods

    static implicit operator int (InteractionLayerMask mask);
    static implicit operator InteractionLayerMask (int intVal);

    static string LayerToName(
        int layer,
        InteractionSystemModule interactionSystem = null
    );

    static int NameToLayer(
        string layerName,
        InteractionSystemModule interactionSystem = null
    );

    static int GetMask(params string[] layerNames);
};

Detailed Documentation¶

A struct that represents a layer mask for interaction.

Properties¶

int Everything

Gets a layer mask that includes all layers.

int Nothing

Gets a layer mask that includes no layers.

int Value

Gets or sets the layer mask value.

Methods¶

static string LayerToName(
    int layer,
    InteractionSystemModule interactionSystem = null
)

Given an interaction layer returns the interaction layer name as defined in InteractionSystemOptions.

Parameters:

layer	The interaction layer.
interactionSystem	The interaction system to get the layer info from. If `null` will try to find the one on the current scene.

Returns:

The interaction layer name.

static int NameToLayer(
    string layerName,
    InteractionSystemModule interactionSystem = null
)

Given an interaction layer name, returns the interaction layer as defined in InteractionSystemOptions.

Parameters:

layerName	The name of the interaction layer.
interactionSystem	The interaction system to get the layer info from. If `null` will try to find the one on the current scene.

Returns:

The interaction layer with the given name.

static int GetMask(params string[] layerNames)

Constructs a mask that includes all layers in layerNames.

Parameters:

layerNames	The layer names to include in the mask.
ArgumentNullException	If layerNames is `null`.

Returns:

The layer mask that includes all the given layers.