OOF2: The Manual

OOF.Graphics_n.Layer.Freeze
Prev  6.2.26. OOF.Graphics_n.Layer Commands  Next

Name

OOF.Graphics_n.Layer.Freeze — Prevent the selected layer from being redrawn.

Synopsis

OOF.Graphics_n.Layer.Freeze(n)

Details

  • Parent Menu: OOF.Graphics_n.Layer
  • Callback: function GhostGfxWindow.freezeLayer in module ooflib.common.IO.ghostgfxwindow
  • Options: disabled=1

  • Parameters:

    n
    Layer index. Type: Integer.

Description

Freezing a Layer prevents it from being redrawn when a graphics window is updated, even if the object that the Layer displays has changed. It will prevent a Layer from being animated or being updated when the window's time changes. The one exception is that if a frozen Layer has never been displayed, it will be drawn once.

In the GUI, freezing and unfreezing is accomplished by the checkbox in the the Freeze column of the Layer List. It can also be invoked from the Layer menu in the graphics window's menu bar, in which case it acts on the currently selected layer.

In text mode and in scripts, the Layer is specified by its position n in the window's layer list. The unlisted layers must be counted when computing n. This command isn't very friendly in scripts, because it can be hard to determine the parameter n.

Frozen Layers can be thawed with OOF.Graphics_n.Layer.Unfreeze.

Prev  Up  Next
OOF.Graphics_n.Layer.Edit  Home  OOF.Graphics_n.Layer.Hide