OOF2: The Manual

OOF.Graphics_n.Layer.Raise.By
Prev  6.2. Menus  Next

Name

OOF.Graphics_n.Layer.Raise.By — Raise the selected graphics layer over a given number of other layers.

Synopsis

OOF.Graphics_n.Layer.Raise.By(n, howfar)

Details

  • Parent Menu: OOF.Graphics_n.Layer.Raise
  • Callback: function GfxWindow.raiseBy in module ooflib.common.IO.ghostgfxwindow

  • Parameters:

    n
    Layer index. Type: Integer.
    howfar
    How far to raise the layer. Type: Integer.

Description

Graphics Layers are conceptually organized in a stack, with Layers on the bottom drawn first, and layers on the top drawn last. Higher Layers therefore obscure the lower ones. Raising a Layer in the stack makes it more visible. This command raises the given layer by howfar levels in the stack, lowering all the intervening layers by one level.

In GUI mode, this command operates 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 and invisible (empty) layers must be counted when computing n and howfar. This command isn't very friendly in scripts, because it can be hard to determine n and howfar.

If howfar is 1, then this command is identical to OOF.Graphics_n.Layer.Raise.One_Level.

See Also

Prev  Up  Next
OOF.Graphics_n.Layer.Lower.To_Bottom  Home  OOF.Graphics_n.Layer.Raise.One_Level