Class MainBlock

A Block for the main RomlDoc compiled files.

Info:

  • License: MIT
  • Author: Richard Voelker

Properties

MainBlock.BLOCK_VARS Constant for adding children to the variable Block.
MainBlock.BLOCK_UPDATE_FUNCTIONS Constant for adding children to the update function Block.
MainBlock.BLOCK_CREATION Constant for adding children to the object creation Block.
MainBlock.BLOCK_FUNCTION_CALLS Constant for adding children to the update function call Block.

Methods

MainBlock.new (self, name) Create the MainRomlBlock.
MainBlock.AddChild (self, block, child) Add a child to the create function of the subclass inside the specified block.
MainBlock.AddCustomObjectBuilderRequire (self) Adds the require for the ??? class to the top of the RomlDoc if it is not already there.
MainBlock.Render (self) Render the MainRomlBlock and all children Blocks/Lines.


Properties

MainBlock.BLOCK_VARS
Constant for adding children to the variable Block.
MainBlock.BLOCK_UPDATE_FUNCTIONS
Constant for adding children to the update function Block.
MainBlock.BLOCK_CREATION
Constant for adding children to the object creation Block.
MainBlock.BLOCK_FUNCTION_CALLS
Constant for adding children to the update function call Block.

Methods

MainBlock.new (self, name)
Create the MainRomlBlock.

Parameters:

  • self MainRomlBlock
  • name string

    The name of the subclass for the

    <a href="../classes/RomlDoc.html#">RomlDoc</a>
    
MainBlock.AddChild (self, block, child)
Add a child to the create function of the subclass inside the specified block.

Parameters:

  • self MainRomlBlock
  • block string

    One of BLOCK_VARS,

    <a href="../classes/MainBlock.html#MainBlock.BLOCK_UPDATE_FUNCTIONS">BLOCK\_UPDATE\_FUNCTIONS</a>, <a href="../classes/MainBlock.html#MainBlock.BLOCK_CREATION">BLOCK\_CREATION</a>,
    or <a href="../classes/MainBlock.html#MainBlock.BLOCK_FUNCTION_CALLS">BLOCK\_FUNCTION\_CALLS</a>.
    
  • child Block/Line The child to add.
MainBlock.AddCustomObjectBuilderRequire (self)
Adds the require for the ??? class to the top of the RomlDoc if it is not already there.

Parameters:

  • self MainRomlBlock
MainBlock.Render (self)
Render the MainRomlBlock and all children Blocks/Lines.

Parameters:

  • self MainRomlBlock
generated by LDoc 1.4.3 Last updated 2016-07-26 17:10:04