Schema
Allows for control of the boot process of the schema such as piggybacking from other schemas
Functions
Inherits(base)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Usable only within a class file definition, this function will have the registering class inherit from the specified class.
Parameters
-
base
The base class to inherit from.
impulse.Schema.Boot()
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Starts the Schema boot sequence
impulse.Schema.LoadBenches(directory)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Loads a directory of benches, automatically creates tables and registers them.
Parameters
-
directory
string
load directory.
impulse.Schema.LoadEntites(path)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Loads entities from a selected path.
Parameters
-
path
string
Path to the entities.
impulse.Schema.LoadHooks(file, variable, uid)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Loads hooks by creating a global table, used for plugins, schema, etc.
Parameters
-
file
string
A path to a SINGLE file.
-
variable
string
How the hooks are defined, PLUGIN, SCHEMA, etc.
-
uid
string
A way to identify the hooks of this, typically the parent folder name.
impulse.Schema.LoadItems(directory)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Loads a directory of items, automatically creates tables and registers them.
Parameters
-
directory
string
load directory.
impulse.Schema.LoadMixtures(directory)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Loads a directory of mixtures, automatically creates tables and registers them.
Parameters
-
directory
string
load directory.
impulse.Schema.LoadPlugin(directory, name)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Loads a directory of plugins.
Parameters
-
directory
string
load directory.
-
name
string
The plugin name.
impulse.Schema.LoadVendors(directory)
This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.
Loads a directory of vendors, automatically creates tables and registers them.
Parameters
-
directory
string
load directory.
impulse.Schema.PiggyBoot(name, object)
View source »Boots a specified object from a foreign schema using the piggbacking system
Parameters
-
name
string
Schema file name
-
object
string
The folder in the schema to load
impulse.Schema.PiggyBootEntities(name)
View source »Boots all entities from a foreign schema using the piggbacking system
Parameters
-
name
string
Schema file name
impulse.Schema.PiggyBootPlugin(name, plugin)
View source »Boots a specified plugin from a foreign schema using the piggbacking system
Parameters
-
name
string
Schema file name
-
plugin
string
The plugin folder name