SendRoom
This procedure will send text in the room. You need to be friend, operator, opplus or owner in order to use this command.
NOTE: This procedure also call Sleep if IMMEDIATE COMMANDS is disabled.
Declaration:
procedure SendRoom(text: WideString; visible: Boolean);
Usage:
SendRoom('text to send',true);
Parameters:
- text (WideString)
Your text to be send in room. - visible (Boolean)
If you want to see the command in your screen.
We suggest to use FALSE if your text is a server command (ex: /msg)
SetTarget
This procedure change the name in the nickname field.
Declaration:
procedure SetTarget(text: String);
Usage:
SetTarget('username');
Parameters:
- text (WideString)
Your text to be in nickname field of IceOp main box.
IceOpSettings
This procedure opens the IceOp settings window.
Declaration:
procedure IceOpSettings();
Usage:
IceOpSettings();
IceOpActions
This procedure opens or close the IceOp Actions box.
Declaration:
procedure IceOpActions(show: Boolean);
Usage:
IceOpActions(true);
Parameters:
- show (Boolean)
Set to TRUE if you want to open. Set to FALSE if you want to close.
IceOpMsgBox
This procedure opens or close the IceOp Messages Box.
Declaration:
procedure IceOpMsgBox(show: Boolean);
Usage:
IceOpMsgBox(true);
Parameters:
- show (Boolean)
Set to TRUE if you want to open. Set to FALSE if you want to close.
IceOpMinimize
This procedure minimize IceOp main box to tray. (Hide IceOp)
Declaration:
procedure IceOpMinimize();
Usage:
IceOpMinimize();
IceOpRestore
This procedure restore IceOp main box from tray. (Show IceOp)
Declaration:
procedure IceOpRestore();
Usage:
IceOpRestore();
SendPlugin
This procedure send a message to all plugins. See plugin documentation to know possible messages to be used with specific plugins.
Declaration:
procedure SendPlugin(msg: String; param: Integer);
Usage:
SendPlugin('MyMessage',1);
Parameters:
- message (String)
The message to be sent to all plugins. - param (Integer)
The numeric parameter to assign to the message.
SetCaption
This procedure set the title (caption) for your IceOp main box.
Declaration:
procedure SetCaption(text: String);
Usage:
SetCaption('My IceOp');
Parameters:
- text (String)
The new title for your main box window.
Sleep
This procedure will perform a pause (delay) of a specified time in milliseconds. This works only if IMMEDIATE COMMANDS is disabled in your settings.
Declaration:
procedure Sleep(milliseconds: Cardinal);
Usage:
Sleep(900);
Parameters:
- milliseconds (Cardinal)
The time to wait before execute the next line.
PlaySound
This procedure plays a wave sound.
Declaration:
procedure PlaySound(filename: String);
Usage:
PlaySound('C:\sound.wav');
Parameters:
- filename (String)
Path and name of a wave file.
StopSound
This procedure stops all wave sounds playing from IceOp.
Declaration:
procedure StopSound();
Usage:
StopSound();
MakeNotification
[ Added in 6.2 ] This function raises a notification to IceOp core.
Declaration:
function MakeNotification(title,text,icon:string;timeout:integer):boolean;
Usage:
MakeNotification('My title', 'My text', 'C:\images\icon.png', 4);
Parameters
- title (String)
header of the notification - text (String)
body of the notification - icon (String)
file path to an image (works only with Snarl notification type)
NOTE: leave empty to use default - timeout (Integer)
amount of second to keep the notification visible
