Functions Operator - Functions

General
Functions
About

This section will help you program a script inside a command file(.cmd). This script will be executed
automatically by functions operator.

Limitations:
                    - 32,736 Variables maximum
                    - Never use the following characters in a command file for anything else then the specified
                    reference to it: [ ] ; , /


Functions Tree

Audio
Play
Stop
Volume

File
Copy
Delete
DeleteSelf
SaveFunctions

Resolution
Get
Set
Clipboard
Clear
Get
Set

Process
FPS
Hide
Resume
Show
Stop
Terminate

Shell
Run
Computer
Logoff
Restart
Shutdown
Registry
Get
Set

Variable
Clear
Delete
Set

Functions

/Comment/

    Comment = Note to self

    This command is used by the programmer to remind himself a comment.

Audio.Play[Filename,Variable];

    Filename = File name and path to play
    Variable = Variable to store sound settings (Playing, ERROR, etc)

    This command plays sound or music with specifyed file name and path.
Recognized formats: Songs (s3m, it, xm, mod), Streams (wav, mp3, ogg, wma)

Audio.Stop[];

    This command will stop all audio files currently playing.

Audio.Volume[Volume%];

    Volume% = Audio tone percentage (Minimal value: 0, maximal value: 100)

    This command will change the volume of any stream file playing.

Clipboard.Clear[];

    This command clears anything stored in the clipboard.

Clipboard.Get[Variable,Default];

    Variable = Variable to store the text in the clipboard
    Default = Default value stored into variable if no content is in clipboard

    This command stores  the clipboard data into a variable you specify.

Clipboard.Set[Text];

    Text = Text to store in clipboard

    This command changes the clipboard stored text to any text you input.

Computer.Logoff[];

    This command will logoff windows session instantly. Warning: Make sure to save
all datas of programs runing before executing this command!

Computer.Restart[];

    This command will restart windows instantly. Warning: Make sure to save all datas
of programs runing before executing this command!

Computer.Shutdown[];

    This command will shutdown windows instantly. Warning: Make sure to save all datas
of programs runing before executing this command!

File.Copy[Source,Destination];

    Source = File name and path to be copied
    Destination = File name and path to copy into

    This command will copy (one/many) files to another folder. To copy a single file, use
a filename (Example: File.ext), to copy many files, use a star (Example: *.ext).

File.Delete[Filename];

    Filename = File name and path to be deleted

    This command will delete (one/many) files. To delete a single file, use a filename
(Example: File.ext), to delete many files, use a star (Example: *.ext).

File.DeleteSelf[];

    This command will delete the curent command file, puting this function
in a script would delete the file after the other functions are operated.

File.SaveFunctions[Filename];

    Filename = File name and path to save all functions of Functions Operator

    This is THE MOST IMPORTANT COMMAND, in order to see what are the results of your
commands, you must save a file to a specified location and read them threw an external
program.

Process.Hide[];

    This command hides all windows of Functions Operator

Process.Show[];

    This command shows the main window of Functions Operator

Process.Terminate[];

    This command ends Functions Operator

Process.FPS[Speed];

    Speed = Refresh rate of process over a second

    This command sets how many times per second will the process be refreshed

    Example: Process.FPS[30]; would refresh the process every 0.03 seconds

Process.Stop[];

    This command temporary stops all process of Functions Operator

Process.Resume[];

    This command resumes all process of Functions Operator

Registry.Get[Path,Key,Variable,Default];

    Path = Registry path
    Key = Registry item to get value
    Variable = Put value of registry into the custum variable
    Default = Default value of variable if value is blank (The common Default Value is "Error")

    This command will grab the value of a precise location in the windows registry to a variable and
if the variable is null or non-existant, it will return the entered default value.

Registry.Set[Path,Key,Value];

    Path = Registry path
    Key = Registry item to set value
    Value = Store value into registry

    This command will store a value in the windows registry to a precise location

Resolution.Get[VariableX,VariableY,VariableC];

    VariableX = Get screen width and store value into variable
    VariableY = Get screen height and store value into variable
    VariableC = Get screen colors set and store value into variable

    This command will store into 3 variables the screen's width, height and colors set

Resolution.Set[Width,Height,ColorDepth];

    Width = New screen width desired (in pixels)
    Height = New screen height desired (in pixels)
    ColorDepth = New screen colors set desired (in bits)

    This command will change the resolution with specified height, width and colors set

Shell.Run[Filename];

    Filename = File name and path to be executed

    This command executes the specified file with windows explorer (Executable files will
run and web documents will apear in a new window under microsoft internet explorer)

Variable.Clear[];

    This command will delete all variables stored in Functions Operator. Ensure this is really
the command you meant to execute!

Variable.Delete[VariableName]; or Variable.Del[VariableName];

    VariableName = Variable name to be deleted

    This command deletes a variable with specified name

Variable.Set[Variable,Value];

    Variable = Variable name to change
    Value = Variable value to change

    This command changes a variable value
 
 
 Functions Amount: 27


Featuring the following functions


 

Encrypt.Ace[Filename,NewFilename];

    Filename = File name and path of the file to encrypt
    NewFilename = File name and path of a file to be created encrypted

    This command encrypts a file in the standard ACE compression format.

Encrypt.File[Filename,FormulaPower,FormulaMultiplier,FormulaIncrease,NewFilename];

    Filename = File name and path of the file to encrypt
    FormulaPower = Exponential value to encryption formula
    FormulaMultiplier = Multiplication value to encryption formula
    FormulaIncrease = Addition value to encryption formula
    NewFilename = File name and path of a file to be created encrypted

    This command encrypts a file with a formula you create and stores it directly in a
file. Warning: You are responsible for making any formula that can or not be unencrypted!

Encrypt.Rar[Filename,NewFilename];

    Filename = File name and path of the file to encrypt
    NewFilename = File name and path of a file to be created encrypted

    This command encrypts a file in the standard RAR compression format.

Encrypt.String[Text,FormulaPower,FormulaMultiplier,FormulaIncrease,Variable];

    Text = Text to be encrypted
    FormulaPower = Exponential value to encryption formula
    FormulaMultiplier = Multiplication value to encryption formula
    FormulaIncrease = Addition value to encryption formula
    Variable = Variable holding encrypted text
 

    This command encrypts a text with a formula you create and stores it directly in a
variable. Warning: You are responsible for making any formula that can or not be
unencrypted!

Encrypt.Zip[Filename,NewFilename];

    Filename = File name and path of the file to encrypt
    NewFilename = File name and path of a file to be created encrypted

    This command encrypts a file in the standard ZIP compression format.

Encrypt.UnAce[Filename,NewFilename];

    Filename = File name and path of the encrypted file
    NewFilename = File name and path of a file to be created uncrypted

    This command uncrypts a file in the standard ACE compression format.

Encrypt.unRar[Filename,NewFilename];

    Filename = File name and path of the encrypted file
    NewFilename = File name and path of a file to be created uncrypted

    This command encrypts a file in the standard RAR compression format.

Encrypt.unZIP[Filename,NewFilename];

    Filename = File name and path of the encrypted file
    NewFilename = File name and path of a file to be created uncrypted

    This command encrypts a file in the standard ZIP compression format.

File.ImportFunctions[Filename];

    Filename = File name and path to load all functions in Functions Operator

    This comand will retreive all variables, functions and data of a file and store it in Functions Operator.

Graphic.Merge[Filename1,Filename2,TransparencyColor,NewFilename];

    Filename1 = File name and path of an image
    Filename2 = File name and path of another image
    TransparencyColor = Color to use as transparency
    NewFilename = Result image file name and path

    This command will put the first image on top of the second with a specified
transparency color, then will create an image file in the specified location.

Graphic.Rotate[Filename,Degree,NewFilename];

    Filename = File name and path of an image
    Degree = Angle to rotate the specifyed image (If Positive, clockwise, otherwise counterclockwise.
                                                                          Minimal value of -360, maximum value of 360)
    NewFilename = Result image file name and path

    This command will rotate an image with specified degrees, then will create an image
file in the specified location.

Internet.Connect[ServerIP,ServerPort];

    ServerIP = Specified server IP
    ServerPort = Specified server port

    This command allows you to connect to a Functions Operator server with specified IP and port

Internet.Disconect[];

    This command disconect Functions Operator from any internet activities

Internet.StartServer[ClientsAmount,ServerPort,TimeOut];

    ClientsAmount = Number of clients that will connect to the server
    ServerPort = Specified server port
    TimeOut = Time limit to connect (0 = None)

    This command will create a server allowing clients to connect on it and to share variables

Internet.SendFunctionsToServer[Filename];

    Filename = File name and path of the function file to be sent

    This command will save a function file to the server
    Warning: Sending a file with a path valid to the client might not be the same path for the server,
                   use ".\" for Functions Operator installed folder
 
 Functions Amount: 15



 
 Total Functions: 42