Assert Help File


Table of Contents

Assert.ToString
Assert.RunString
Assert.ToNumber
Assert.IsNumber
Assert.IsBoolean
Assert.IsString
Assert.IsTable
Assert.IsFunction
Assert.DoesExsist
Assert.CopyTable
Assert.PopulateTable
Assert.CycleTable
Assert.Count
Assert.KillProcessTree
Assert.IsProcessRunning
Assert.GetOSDate
Assert.GetLongTime
Assert.IncludeScriptFolder
Assert.RecurseScriptFolders

Assert.ToString


(string) Assert.ToString ( 

(value) Value )

Description

Convert a value into a stringg.

Parameters

Value

(value) What should be turned into a string.


Return

This action returns a (string) value.



Assert.RunString


(value) Assert.RunString ( 

(string) String )

Description

Run string as a function.

Parameters

String

(string) String to run.


Return

This action returns a (value) value.



Assert.ToNumber


(number) Assert.ToNumber ( 

(value) Value )

Description

Turn a value into a number.

Parameters

Value

(value) Value to turn into a number.


Return

This action returns a (number) value.



Assert.IsNumber


(boolean) Assert.IsNumber ( 

(value) Value )

Description

Returns a boolean finding out if a value is a number or not.

Parameters

Value

(value) Value to check.


Return

This action returns a (boolean) value.



Assert.IsBoolean


(boolean) Assert.IsBoolean ( 

(value) Value )

Description

Returns a boolean finding out if a value is a boolean or not.

Parameters

Value

(value) Value to check.


Return

This action returns a (boolean) value.



Assert.IsString


(boolean) Assert.IsString ( 

(value) Value )

Description

Returns a boolean finding out if a value is a string or not.

Parameters

Value

(value) Value to check.


Return

This action returns a (boolean) value.



Assert.IsTable


(boolean) Assert.IsTable ( 

(value) Value )

Description

Returns a boolean finding out if a value is a table or not.

Parameters

Value

(value) Value to check.


Return

This action returns a (boolean) value.



Assert.IsFunction


(boolean) Assert.IsFunction ( 

(value) Value )

Description

Returns a boolean finding out if a value is a function or not.

Parameters

Value

(value) Value to check.


Return

This action returns a (boolean) value.



Assert.DoesExsist


(boolean) Assert.DoesExsist ( 

(value) Value )

Description

Returns a boolean finding out if a value exsists or not.

Parameters

Value

(value) Value to check.


Return

This action returns a (boolean) value.



Assert.CopyTable


(table) Assert.CopyTable ( 

(table) Table )

Description

Returns a duplicated table.

Parameters

Table

(table) Table to copy.


Return

This action returns a (table) value.



Assert.PopulateTable


(table) Assert.PopulateTable ( 

(table) Table,

(number) Values,

(string) Populate String )

Description

Populates a table with data.

Parameters

Table

(table) Table to populate.

Values

(number) Indexes to populate.

Populate String

(string) String to populate with.


Return

This action returns a (table) value.



Assert.CycleTable


(nil) Assert.CycleTable ( 

(table) Table,

(function) Callback )

Description

Cycles through a table with a callback function.

Parameters

Table

(table) Table to cycle.

Callback

(function) The function that is called when the cycle makes progress. (Should take two arguments)


Return

This action returns a (nil) value.



Assert.Count


(nil) Assert.Count ( 

(number) From,

(number) To,

(function) Callback )

Description

Counts from a number to another number.

Parameters

From

(number) The number it should start counting at.

To

(number) The number it should count up to.

Callback

(function) The function that is called when the count makes progress. (Should take one to two arguments)


Return

This action returns a (nil) value.



Assert.KillProcessTree


(nil) Assert.KillProcessTree ( 

(string) Process Name )

Description

Kills processes spawned from an application.

Parameters

Process Name

(string) Process name to kill.


Return

This action returns a (nil) value.



Assert.IsProcessRunning


(boolean) Assert.IsProcessRunning ( 

(string) Process Name )

Description

Returns true if a process is running.

Parameters

Process Name

(string) Process name to check status.


Return

This action returns a (boolean) value.



Assert.GetOSDate


(string) Assert.GetOSDate ()

Description

Gets the date from the operating system.

Parameters

None


Return

This action returns a (string) value.



Assert.GetLongTime


(number) Assert.GetLongTime ()

Description

Get a long value of time.

Parameters

None


Return

This action returns a (number) value.



Assert.IncludeScriptFolder


(nil) Assert.IncludeScriptFolder ( 

(string) Folder )

Description

Runs scripts in a folder. (Does not recurse)

Parameters

Folder

(string) Folder with scripts inside.


Return

This action returns a (nil) value.



Assert.RecurseScriptFolders


(nil) Assert.RecurseScriptFolders ( 

(string) Folder )

Description

Runs scripts in a folder. (Includes all files in subfolders)

Parameters

Folder

(string) Folder with scripts inside.


Return

This action returns a (nil) value.



Made with Action Plugin Compiler