LibTSMComponent

Inherits: Class

Methods

AddDependency

function LibTSMComponent:AddDependency(name)
  -> self

Adds a component as a dependency of the current component.

Parameters:

Name	Type	Description
name	string	The name of the component

Returns:

Type	Description
self

DefineClassType

function LibTSMComponent:DefineClassType(name, parentClass, ...)
  -> <T:Class>

Creates a new class type and makes it available to other components.

Parameters:

Name	Type	Description
name	<T>	The name of the class
parentClass	P	The parent class
...	ClassProperties	Properties to define the class with

Returns:

Type	Description
<T:Class>

DefineInternalClassType

function LibTSMComponent:DefineInternalClassType(name, parentClass, ...)
  -> <T:Class>

Creates a new class type which is only available internally within the component.

Parameters:

Name	Type	Description
name	<T>	The name of the class
parentClass	P	The parent class
...	ClassProperties	Properties to define the class with

Returns:

Type	Description
<T:Class>

From

function LibTSMComponent:From(name)
  -> LibTSMComponentReference

Retrieves a component which the current component depends on.

Parameters:

Name	Type	Description
name	string	The name of the component

Returns:

Type	Description
LibTSMComponentReference

Include

function LibTSMComponent:Include(path)
  -> <T>

Returns an existing module.

Parameters:

Name	Type	Description
path	<T>	The path of the module

Returns:

Type	Description
<T>

IncludeClassType

function LibTSMComponent:IncludeClassType(name)
  -> <T>

Returns a class type.

Parameters:

Name	Type	Description
name	<T>	The name of the class

Returns:

Type	Description
<T>

Init

function LibTSMComponent:Init(path)
  -> <T:LibTSMModule>

Creates a new module and makes it available to other components.

Parameters:

Name	Type	Description
path	<T>	The path of the module

Returns:

Type	Description
<T:LibTSMModule>

InitInternal

function LibTSMComponent:InitInternal(path)
  -> <T:LibTSMModule>

Creates a new module which is only available internally within the component.

Parameters:

Name	Type	Description
path	<T>	The path of the module

Returns:

Type	Description
<T:LibTSMModule>

Functions

GetTime

function LibTSMComponent.GetTime()
  -> number

Gets the current time value (or 0 if no function is registered).

Returns:

Type	Description
number

GetVersionStr

function LibTSMComponent.GetVersionStr()
  -> string

Gets the version string.

Returns:

Type	Description
string

IsBCClassic

function LibTSMComponent.IsBCClassic()
  -> boolean

Returns whether or not we're running within the Burning Crusade Classic version of the game.

Returns:

Type	Description
boolean

IsDevVersion

function LibTSMComponent.IsDevVersion()
  -> boolean

Gets whether or not this is a dev version.

Returns:

Type	Description
boolean

IsMistsClassic

function LibTSMComponent.IsMistsClassic()
  -> boolean

Returns whether or not we're running within the Mists Classic version of the game.

Returns:

Type	Description
boolean

IsRetail

function LibTSMComponent.IsRetail()
  -> boolean

Returns whether or not we're running within the retail version of the game.

Returns:

Type	Description
boolean

IsTestVersion

function LibTSMComponent.IsTestVersion()
  -> boolean

Gets whether or not this is a test version.

Returns:

Type	Description
boolean

IsVanillaClassic

function LibTSMComponent.IsVanillaClassic()
  -> boolean

Returns whether or not we're running within the Vanilla Classic version of the game.

Returns:

Type	Description
boolean