SceneList Class Reference

Functions for manipulating and retrieving information about the scene list. More...

Public Member Functions
string	Get (string category, string entry)
	Gets the scene path for the specified category and entry.
integer	GetEntryID (string categoryName, string entryName)
	Gets the entry ID for the specified category and entry name.
integer	GetCategoryID (string categoryName)
	Gets the category ID for the specified category name.
string	GetEntryName (string category, integer entryID)
	Gets the entry name for the specified category and entry.
string	GetCategoryName (integer categoryID)
	Gets the category name for the specified category ID.
string	GetEntryProperty (string category, string entry, string property)
	Gets a property for an entry.
string	GetCategoryProperty (string category, string property)
	Gets a property for a category.
boolean	HasEntryProperty (string category, string entry, string property)
	Checks if a given property exists in the entry.
boolean	HasCategoryProperty (string category, string property)
	Checks if a given property exists in the category.
integer	GetCategoryCount ()
	Gets the amount of categories in the scene list.
integer	GetSceneCount ()
	Gets the amount of scenes.
integer	GetSceneCount (string categoryName)
	Gets the amount of scenes in a category.

Detailed Description

Functions for manipulating and retrieving information about the scene list.

Member Function Documentation

Get()

string SceneList.Get	(	string	category,
		string	entry )

Gets the scene path for the specified category and entry.

Parameters

category	The category.
entry	The entry.

Returns

Returns a string value.

GetCategoryCount()

integer SceneList.GetCategoryCount

(

)

Gets the amount of categories in the scene list.

Returns

Returns an integer value.

GetCategoryID()

integer SceneList.GetCategoryID

(

string

categoryName

)

Gets the category ID for the specified category name.

Parameters

categoryName

The category name.

Returns

Returns the category ID, or -1 if not found.

GetCategoryName()

string SceneList.GetCategoryName

(

integer

categoryID

)

Gets the category name for the specified category ID.

Parameters

categoryID

The category ID.

Returns

Returns the category name, or -1 if not valid.

GetCategoryProperty()

string SceneList.GetCategoryProperty	(	string	category,
		string	property )

Gets a property for a category.

Parameters

category	The category.
property	The property.

Returns

Returns a string value, or null if the category has no such property.

GetEntryID()

integer SceneList.GetEntryID	(	string	categoryName,
		string	entryName )

Gets the entry ID for the specified category and entry name.

Parameters

categoryName	The category name.
entryName	The entry name.

Returns

Returns the entry ID, or -1 if not found.

GetEntryName()

string SceneList.GetEntryName	(	string	category,
		integer	entryID )

Gets the entry name for the specified category and entry.

Parameters

category	The category.
entryID	The entry ID.

Returns

Returns the entry name.

GetEntryProperty()

string SceneList.GetEntryProperty	(	string	category,
		string	entry,
		string	property )

Gets a property for an entry.

Parameters

category	The category.
entry	The entry.
property	The property.

Returns

Returns a string value, or null if the entry has no such property.

GetSceneCount() [1/2]

integer SceneList.GetSceneCount

(

)

Gets the amount of scenes.

Returns

Returns the total amount of scenes.

GetSceneCount() [2/2]

integer SceneList.GetSceneCount

(

string

categoryName

)

Gets the amount of scenes in a category.

Parameters

categoryName

The category name.

Returns

Returns the number of scenes in the category.

HasCategoryProperty()

boolean SceneList.HasCategoryProperty	(	string	category,
		string	property )

Checks if a given property exists in the category.

Parameters

category	The category.
property	The property.

Returns

Returns whether the property exists.

HasEntryProperty()

boolean SceneList.HasEntryProperty	(	string	category,
		string	entry,
		string	property )

Checks if a given property exists in the entry.

Parameters

category	The category.
entry	The entry.
property	The property.

Returns

Returns whether the property exists.