StatusBar Help File

StatusBar Help File

Plugin Name:

StatusBar

Current Version:

1.4.0.0

Description:

This plugin creates a status bar for all pages and dialogs in your project.
The current status is dynamic and will be displayed on all pages and dialogs without employing extra code to display it.
Note: the status bar object is not a windowed object and will, therefore, be overridden by any intercepting windowed objects.
View the help file for more information.

Version History

1.1.0.0
Configured status bar object to auto-resize with page/dialog resize
Updated the Color fields in the StatusBar.Create() function to use color boxes

1.2.0.0
Fixed a bug in the dialog resize code
Added Image(as status bar icon) support


1.2.0.1
Simplified the creation process and variables
Fixed a bug that caused an error when no image file was specified

1.3.0.0
Added side and bottom padding options
Added the ability to make the StatusBar background and/or border transparent

1.4.0.0
Updated to be compatible with AMS 8.0
Updated the IRLua Plugin Helper Functions to v2.6

Licence:

Free to use and distribute.

Author:

Centauri Soldier

Web:

www.AMSPublic.com

E-mail:

CentauriSoldier@AMSPublic.com

Copyright:

Copyright © 2010 AMSPublic.com

Install Notes:

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


Table of Contents

StatusBar.Create
StatusBar.GetHeight
StatusBar.GetStatus
StatusBar.Hide
StatusBar.SetStatus
StatusBar.SetTitle
StatusBar.Show

StatusBar.Create


StatusBar.Create ( 

(boolean) Use Transparent Background = false,

(number) Background Color = 12632256,

(boolean) Use Transparent Border = false,

(number) Border Color = 0,

(number) Text Color = 0,

(variant) Height = nil,

(number) Side Padding = 0,

(number) Bottom Padding = 0,

(string) Font Name = "",

(variant) Font Size = nil,

(number) Font Weight = FW_NORMAL,

(boolean) Italic = false,

(string) Image Icon = "",

(boolean) Use Transparent Color = false,

(number) Transparent Color = 0,

(number) Opacity = 100,

(number) Tolerance = 10 )

Description

This action must be called in your globals. It creates the status bar object.

Note: If you are running any plugins that modifiy Page or Dialog script, be aware that this action writes script to the "On Show" event of each page and dialog.

Parameters

Use Transparent Background

(boolean) Whether or not to make the status bar background transparent

Background Color

(number) The color to which the background will be set.

Use Transparent Border

(boolean) Whether or not to create the status bar with a transparent border.

Border Color

(number) The color to which the border will be set.

Note: Set to nil to use the default height.

Text Color

(number) The color to which the text will be set.

Note: Leave blank to use the default font.

Height

(variant) The height of the status bar. Set to nil to use the default height.

Side Padding

(number) The distance from each side of the application window to its respective status bar side.

Bottom Padding

(number) The distance that the status bar will be from the bottom of the window.

Font Name

(string) The font to use for the status bar text.

Note: Leave blank to use no image icon.

Font Size

(variant) The size of the status bar font. Set to nil to use the default font size.

Font Weight

(number) The weight of the font (how "dark" the text will appear).

CONSTANT

VALUE

DESCRIPTION

FW_DONTCARE

NA

NA

FW_THIN

NA

NA

FW_EXTRALIGHT

NA

NA

FW_LIGHT

NA

NA

FW_NORMAL

NA

NA

FW_MEDIUM

NA

NA

FW_SEMIBOLD

NA

NA

FW_BOLD

NA

NA

FW_EXTRABOLD

NA

NA

FW_HEAVY

NA

NA

Italic

(boolean) Whether or note the status bar text will be italic.

Value

Description

true

true

false

(Default) false

Image Icon

(string) The path to the image file which will be used as a status bar icon.

Use Transparent Color

(boolean) Whether or not to use a transparent color in the image.

Value

Description

true

Creates the status bar with a transparent background

false

(Default) Creates the status bar with a solid background

Transparent Color

(number) The color in the image icon which will be transparent.

Opacity

(number) The opacity of the image (0 being completely transparent and 100 being opaque).

Tolerance

(number) The tolerance to use for the transparent color, between 0 and 100. 0 requires an exact match to the Transparent color. Increasing this value allows shades of the Transparent Color to be transparent as well.

Returns

This action dose not return any value.


StatusBar.GetHeight


(number) StatusBar.GetHeight ()

Description

Returns the height of the status bar object.

Returns

(number) Returns a number representing the height of the status bar object.
If no status bar exists then nil is returned.


StatusBar.GetStatus


(string) StatusBar.GetStatus ()

Description

Gets the current status set by StatusBar.SetStatus

Returns

(string) Returns the text of the status bar. If there is no status then a blank string is returned.


StatusBar.Hide


StatusBar.Hide ()

Description

Hides the status bar.

Returns

This action dose not return any value.


StatusBar.SetStatus


StatusBar.SetStatus ( 

(string) Text = "Loading" )

Description

Set the text in the status bar object.

Note: This function does not change the title of the status bar. Use StatusBar.SetTitle for that.

Parameters

Text

(string) The text to place in the status bar.

Returns

This action dose not return any value.


StatusBar.SetTitle


StatusBar.SetTitle ( 

(string) Title = "Status: " )

Description

Set the title text in the status bar object.

Parameters

Title

(string) The text to which the status bar title will be set.

Returns

This action dose not return any value.


StatusBar.Show


StatusBar.Show ()

Description

Shows the status bar (if hidden).

Returns

This action dose not return any value.



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