Class RomlDoc

The base class for RoML object creation.

All compiled RoML files will be compiled into a Lua class with this class as its base.

Info:

  • License: MIT
  • Author: Richard Voelker

Methods

RomlDoc.new (self, parent[, vars[, ross]]) Create a new RomlDoc.
RomlDoc.GetVar (self, varName) Get a variable from this document so it may be changed.
RomlDoc.Find (self, selector) Find a specific RomlObject in this document based on the selector.
RomlDoc.AddChild (self, romlObject) Add a child RomlObject to this RomlDoc.
RomlDoc.RemoveChild (self, romlObject) Remove a child RomlObject from this RomlDoc.
RomlDoc.SetStyleSheet (self, ross)


Methods

RomlDoc.new (self, parent[, vars[, ross]])
Create a new RomlDoc.

Parameters:

  • self RomlDoc
  • parent Instance

    The ROBLOX object to add the RomlDoc

    to.
    
  • vars table The starting values for the variables. (optional)
  • ross RossDoc The starting RoSS. (optional)
RomlDoc.GetVar (self, varName)
Get a variable from this document so it may be changed.

Parameters:

Returns:

    GenericRomlVar/TableRomlVar/Instance The variable.
RomlDoc.Find (self, selector)
Find a specific RomlObject in this document based on the selector.

Parameters:

Returns:

    array An array of matching RomlObjects.
RomlDoc.AddChild (self, romlObject)
Add a child RomlObject to this RomlDoc.

Parameters:

RomlDoc.RemoveChild (self, romlObject)
Remove a child RomlObject from this RomlDoc.

Parameters:

RomlDoc.SetStyleSheet (self, ross)

Parameters:

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