Editing
Metamorphis Scripts
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
===Functions=== '''void SetBitmap(string Bitmap, string TransparentColor)'''<br> '''Description''': Sets image for the window. Relative paths can be used. SetBitmap function can be used to change image and region for a window.<br> '''Parameters''':<br> :''Bitmap'' - new bitmap file for the window.<br> :''TransparentColor''- transparent color of new image.<br> '''Example''':<br> Player.SetBitmap( "coolpic.gif", "ff00ff"); ---- '''bool LoadSkinState()'''<br> '''Description''': Loads previously saved state of the skin, usually called in handler for OnInitialize event.<br> '''Return Values''': true if skin state was previously saved using SaveSkinState function, otherwise false.<br> '''Example''':<br> if(Metamorphis.LoadSkinState() == false) { EQ.ShowWindow(true); } ---- '''void SaveSkinState()'''<br> '''Description''': Saves skin state, usually called in handler for OnExit event.<br> '''Example''':<br> Metamorphis.SaveSkinState(); ---- '''void SetStateValue(string Name, variant Value)'''<br> '''Description''': Sets state variable. This variable will be saved in state.xml and can be retrieved when skin is loaded or at any other time. Supported types: number, string, boolean, double<br> '''Parameters''':<br> :''Name'' - Name of the value to be set.<br> :''Value'' - Specifies the data to be stored.<br> '''Example''':<br> Metamorphis.SetStateValue("SomeName", "SomeValue"); Metamorphis.SetStateValue("SomeName2", 1); ---- '''variant GetStateValue(string Name)'''<br> '''Description''': Retrieves previously set state value. Supported types: number, string, boolean, double<br> '''Parameters''':<br> :''Name'' - Name of the value to be retrieved.<br> '''Return Values''': the value's data<br> '''Example''':<br> var SoveValue = Metamorphis.GetStateValue("SomeName"); // check if value was previously set if( SomeValue == null) // value was not set { ... do something } ---- '''long StartTimer(long Timeout, string FunctionName)'''<br> '''Description''': This function creates a timer with the specified time-out value.<br> '''Parameters''':<br> :''Timeout'' - specifies the time-out value, in milliseconds<br> :''FunctionName'' - name the function to be notified when the time-out value elapses.<br> '''Return Values''': Identifier of the new timer.<br> '''Example''':<br> var TimerID = Metamorphis.StartTimer(1000, DoExtraCoolStuff ); ---- '''void StopTimer(long TimerID)'''<br> '''Description''': The function destroys the specified timer.<br> '''Parameters''':<br> :''TimerID''- Identifier of the timer.<br> '''Example''':<br> Metamorphis.StopTimer(TimerID ); ---- '''bool IsAlwaysOnTop ()'''<br> '''Description''': Retrieves Always on State state<br> '''Return Values''': 0 - off, 1- on<br> '''Example''':<br> var State = Metamorphis.IsAlwaysOnTop(); '''void Minimize()'''<br> '''Description''': Minimizes the skin.<br> '''void Maximize()'''<br> '''Description''': Returns Media Jukebox to MEGA-ME state.<br> '''void Close()'''<br> '''Description''': Closes Media Jukebox.<br> '''void Restore()'''<br> '''Description''': If a skin was minimized it will be restored.<br> '''bool IsMinimized()'''<br> '''Description''': Returns true if a skin is minimized.<br> '''void EnableTooltips(bool bEnable)'''<br> '''Description''': Turns tooltips on and off.<br> '''Parameters''':<br> :''bEnable'' - true(default) - to turn tooltips on, false - to turn tooltips off<br> '''long GetScreenWidth()'''<br> '''Description''': retrieves screen width.<br> '''long GetScreenHeight()'''<br> '''Description''': retrieves screen height.<br> '''long GetScreenLeft()'''<br> '''Description''': retrieves screen left.<br> '''long GetScreenTop()'''<br> '''Descriptio'''n: retrieves screen top.<br>
Summary:
Please note that all contributions to wiki.jriver.com may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Wiki.jriver.com:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
View history
More
Search
Navigation
Interact Forum
Main Page
User Manual
Community portal
Recent changes
Tools
What links here
Related changes
Special pages
Page information