Create - InputEnableLayer

From Creation Kit
Jump to: navigation, search

Member of: InputEnableLayer Script

Creates a new input enable layer for a script to use to enable/disable player controls. Note that these are a limited resource, so you should not hold onto them longer then you need to have the player's controls disabled.

Syntax

InputEnableLayer Function Create() native global

Parameters

None.

Return Value

A new input enable layer. If the game is out of layers, it will return None.

Examples

; Create a new layer
InputEnableLayer myLayer = InputEnableLayer.Create()

Notes

  • The layer is tagged with the form, script, function, and line number of this call for debugging purposes.
  • When you are done with the layer and no longer need to disable the player's controls, dispose of it by either setting all variables and properties holding it to None, or by calling Delete() on it.
  • To see all active layers in the game, use the DumpInputEnableLayers console command.

See Also