Fireball Engine API

Fireball is the game engine for the future.

BuilderContext Class

Defined in: lib/builder.js:33
Module: firedoc

The Builder Context

Index

Show:

Properties

Methods

Properties

ast AST

Defined in lib/builder.js:39

The AST object

options Option

Defined in lib/builder.js:44

The command options

helpers Object

Defined in lib/builder.js:49

The view helpers function

cacheView Boolean

Defined in lib/builder.js:54

cache the views

template Object

Defined in lib/builder.js:59

The template

files Number

Defined in lib/builder.js:64

records the files

metadata Object

Defined in lib/builder.js:69

The project meta

viewExtname String

Defined in lib/builder.js:92

The ext name of current view

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Methods

addHelper
(
  • name
  • helper
)

Defined in lib/builder.js:99

Add helper

parameters:

  • name String
    The helper name
  • helper Function
    The helper logic

addHelpers
(
  • helpers
)

Defined in lib/builder.js:111

Add helpers

parameters:

  • helpers Object

_inlineCode
(
  • html
)
HTML private

Defined in lib/builder.js:123

Ported from Selleck, this handles `'s in fields that are not parsed by the Markdown parser.

parameters:

  • html HTML
    The HTML to parse

returns:

type: HTML

The parsed HTML

_parseCrossLink
(
  • item
  • [raw=false]
  • [content]
)
private

Defined in lib/builder.js:141

Parse the item to be cross linked and return an HREF linked to the item

parameters:

  • item String
    The item to crossLink
  • raw Boolean , : false
    Do not wrap it in HTML
  • content String
    crossLink helper content

populateClasses
(
  • opts
)
Object

Defined in lib/builder.js:249

Populate the meta data for classes

parameters:

  • opts Object
    The original options

returns:

type: Object

The modified options

populateModules
(
  • opts
)
Object

Defined in lib/builder.js:273

Populate the meta data for modules

parameters:

  • opts Object
    The original options

returns:

type: Object

The modified options

populateFiles
(
  • opts
)
Object

Defined in lib/builder.js:298

Populate the meta data for files

parameters:

  • opts Object
    The original options

returns:

type: Object

The modified options

addFoundAt
(
  • a
)
String

Defined in lib/builder.js:318

Parses file and line number from an item object and build's an HREF

parameters:

  • a Object
    The item to parse

returns:

type: String

The parsed HREF

augmentData
(
  • o
)
Object

Defined in lib/builder.js:335

Augments the DocParser meta data to provide default values for certain keys as well as parses all descriptions with the Markdown Parser

parameters:

  • o Object
    The object to recurse and augment

returns:

type: Object

The augmented object

mixExternal
(
  • cb
)
Promise

Defined in lib/builder.js:395

Fetches the remote data and fires the callback when it's all complete

parameters:

  • cb Function
    The callback to execute when complete

returns:

type: Promise

makeDirs ()

Defined in lib/builder.js:468

Makes the default directories needed

init
(
  • ast
  • options
)
BuilderContext

Defined in lib/builder.js:484

Init BuilderContext context and return

parameters:

  • ast AST
  • options Option

returns:

type: BuilderContext

correctTheme ()

Defined in lib/builder.js:502

correct the theme

compile
(
  • callback
)

Defined in lib/builder.js:521

Compule the AST

parameters:

  • callback Function
    The callback

render ()

Defined in lib/builder.js:572

Render

NATIVES_LINKER
(
  • name
)
String private

Defined in lib/builder.js:727

Function to link an external type uses NATIVES object

parameters:

  • name String
    The name of the type to link

returns:

type: String

The combined URL

filterFileName
(
  • f
)
String

Defined in lib/builder.js:742

Normalizes a file path to a writable filename:

var path = 'lib/file.js'; returns 'lib_file.js';

parameters:

  • f String
    The filename to normalize

returns:

type: String

The filtered file path

compile
(
  • ast
  • options
  • onfinish
)

Defined in lib/builder.js:756

compile

parameters:

  • ast AST
    The AST object
  • options Option
    The options
  • onfinish Function
    fired when compile has completed

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index