Class Help File

Class Help File

Plugin Name:

Class

Current Version:

1.2.0.0

Description:

The Class Action Plugin has been designed to make the coding of large projects easier.
Projects containing many pages, dialogs or objects can be more easily modified by creating and assigning classes.
This plugin works well with the Group Action Plugin.

Licence:

Free to use and distribute.

Author:

Centauri Soldier

Web:

www.AMSPublic.com

E-mail:

CentauriSoldier@AMSPublic.com

Copyright:

© 2009 AMSPublic.com

Install Notes:

Place the "Class" folder in your AutoPlay Media Studio\Plugins\Actions folder.


Table of Contents

Class.DialogDefine
Class.DialogInherit
Class.ObjectDefine
Class.ObjectInherit
Class.PageDefine
Class.PageInherit

Class.DialogDefine


Class.DialogDefine ( 

(string) Class = "My Class",

(table) Class Properties = tDialogExProps )

Description

Defines a class for Dialogs(DialogEx).

Parameters

Class

(string) The name to call the class.

Class Properties

(table) The table used for the class's properties.

Returns

This action dose not return any value.


Class.DialogInherit


(string) Class.DialogInherit ( 

(string) Class = "My Class",

(string) Dialog Name = "MyDialog",

(boolean) Redraw = false )

Description

Force a Dialog(DialogEx) to inherit properties from a specific class.

Parameters

Class

(string) The name of the class whos properties to inherit.

Dialog Name

(string) The name of the dialog being affected.

Redraw

(boolean) Whether or not to redraw the dialog after applying the changes.

Returns

(string) Returns the class name. If an error occurs then a blank string is returned.


Class.ObjectDefine


Class.ObjectDefine ( 

(string) Class = "My Class",

(number) Object Type = OBJECT_BUTTON,

(table) Class Properties = tButtonProps )

Description

Defines a class for Objects (Excluding OBJECT_PLUGIN type objects).

Parameters

Class

(string) The name to call the class.

Object Type

(number) The type of object being affected.

Class Properties

(table) The table used for the class's properties.

Returns

This action dose not return any value.


Class.ObjectInherit


(string) Class.ObjectInherit ( 

(string) Class = "My Class",

(number) Object Type = OBJECT_BUTTON,

(string) Object Name = "My Button",

(boolean) Redraw = true )

Description

Force an Object to inherit properties from a specific class.

Parameters

Class

(string) The name of the class whos properties to inherit.

Object Type

(number) The type of object being affected.

Object Name

(string) The name of the object being affected.

Redraw

(boolean) Whether or not to redraw the page/dialog after applying the changes.

Returns

(string) Returns the class name. If an error occurs then a blank string is returned.


Class.PageDefine


Class.PageDefine ( 

(string) Class = "My Class",

(table) Class Properties = tPageProps )

Description

Defines a class for Pages.

Parameters

Class

(string) The name to call the class.

Class Properties

(table) The table used for the class's properties.

Returns

This action dose not return any value.


Class.PageInherit


(string) Class.PageInherit ( 

(string) Class = "My Class",

(string) Page Name = "Page1",

(boolean) Redraw = true )

Description

Force a Page to inherit properties from a specific class.

Parameters

Class

(string) The name of the class whos properties to inherit.

Page Name

(string) The name of the page to affect.

Redraw

(boolean) Whether or not to redraw the page after applying the changes.

Returns

(string) Returns the class name. If an error occurs then a blank string is returned.



© 2009 AMSPublic.com
This File Was Generated With AMS ActionFile Editor