Fireball Engine API

Fireball is the game engine for the future.

Locals Class

Defined in: lib/locals.js:13
Module: utils
Parent Module: firedoc

The Theme Locals

Index

Show:

Properties

Methods

Properties

context BuilderContext

Defined in lib/locals.js:20

Builder Context

options Option

Defined in lib/locals.js:25

The options

ast AST

Defined in lib/locals.js:30

The AST object

project Object

Defined in lib/locals.js:35

Get the project to export

i18n Object

Defined in lib/locals.js:48

Get i18n object

modules Object

Defined in lib/locals.js:66

Get modules object to export

classes Object

Defined in lib/locals.js:90

Get classes object to export

files Object

Defined in lib/locals.js:115

Get files object to export

_mergeCounter Number private

Defined in lib/locals.js:345

Counter for stepping into merges

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

addFoundAt
(
  • a
)
String

Defined in lib/locals.js:127

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

getMethodName
(
  • name
  • params
)

Defined in lib/locals.js:145

build the method name by its name and parameters

parameters:

  • name String
    The function/method name
  • params Array
    The function/method parameters list
    • name String
      The name of the parameter

_parseCode
(
  • html
)
HTML private

Defined in lib/locals.js:159

Parses 

 tags and adds the prettyprint className to them

parameters:

  • html HTML
    The HTML to parse

returns:

type: HTML

The parsed HTML

markdown
(
  • data
)
HTML private

Defined in lib/locals.js:174

Wrapper around the Markdown parser so it can be normalized or even side stepped

parameters:

  • data String
    The Markdown string to parse

returns:

type: HTML

The rendered HTML

appendClassToModule
(
  • clazz
)

Defined in lib/locals.js:202

append the clazz to its module

parameters:

  • clazz Object
    The class object
    • module String
      The module name of this clazz object

getClassInheritanceTree () Object

Defined in lib/locals.js:218

get class inheritance tree

returns:

type: Object

return the inheritance tree object

buildMember
(
  • memeber
  • forceBeMethod
  • parent
)
Object

Defined in lib/locals.js:258

build the member

parameters:

  • memeber Object
    The member object
  • forceBeMethod Boolean
    force make the build process be for method
  • parent Object
    The parent context

returns:

type: Object

returned member object

buildMembers () Boolean

Defined in lib/locals.js:318

build the members

returns:

type: Boolean

always be true

mergeExtends
(
  • info
  • members
  • first
)

Defined in lib/locals.js:353

Merge superclass data into a child class

parameters:

  • info Object
    The item to extend
  • members Array
    The list of items to merge in
  • first Boolean
    Set for the first call

getExpandIterator
(
  • parent
)
private

Defined in lib/locals.js:405

generate expand function

parameters:

  • parent Object
    The object to be set

extendMembers
(
  • meta
)

Defined in lib/locals.js:429

extends members array

parameters:

  • meta Object
    The meta object

expandMembersFromModules
(
  • meta
)

Defined in lib/locals.js:449

extends modules

parameters:

  • meta Object
    The meta object

expandMembersFromModules
(
  • meta
)

Defined in lib/locals.js:471

extends members from classes

parameters:

  • meta Object
    The meta object

create
(
  • context
)

Defined in lib/locals.js:493

Create a locals object from context

parameters:

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