Frozen Fish 1: Amiga/FrozenFish-Apr94.iso/bbs/alib/d8xx/d888/mainactor.lha/MainActor/Docs/Arexx.Doc

Text File | 1993-07-16 | 7KB | 352 lines

MainActor Arexx Doc
-------------------

The arexx port name is "MAINACTOR".

Format:

<>     Parmaters in these angle brackets have to be supplied

[]     Parameters in square brackets are optional

|      Vertical bars mean OR and are used to seperate
       options of which you can choose one : [ON | OFF]

The result variable contains the result of the operation, its possible
contents are listed in the command reference.

The returncode (rc) contains 0 for success, 10 for error and 20
for fatal error.

Look at the rexx:mainactor/ directory for examples.

MAINACTOR DOES NOT SUPPORT BLANKS IN FILENAMES WHICH ARE AREXX ARGUMENTS !!

------------------------------------------------------

Append
------

    Appends the selected frames/pictures of the source project
    to the destination project (look at MainActor.Doc).

 result: -

DeSelectAll
-----------

 Deselects all frames/pictures in the source project.

 result: -

 REFERENCE: SelectAll,SelectRange,DeSelectRange

DeSelectRange <from> <to>
-------------------------

 Will deselect all frames/pictures in the source project from the
 integer value <from> to <to>

 result: -

 REFERENCE: SelectAll,DeSelectAll,SelectRange

DeSelectRangeRequest
--------------------

 The DeSelectRange requester will appear, letting you choose
 the frames/pictures to deselect.

 result: -

 REFERENCE: SelectAll,DeSelectAll,SelectRangeRequest

GetSPInfo
---------

 returns 7 arguments :

 the width of the Source Project, followed by its height, followed
 by the amount of Colors ('HAM6','HAM8','EHB' will be given back
 literally for AdPro compatibility), followed by the number of
 frames/pictures in your project, followed by "CACHING=NO"
 or "CACHING=YES" depending if you have caching en/disabled, followed
 by "LOOP=YES" or "LOOP=NO" depending on the loop status and at last
 "CPF=YES" or "CPF=NO" depending on your color per frame status.

 Picture lists have LOOP disabled and CPF enabled.

 result: width height colors pics caching loop cpf

 EXAMPLES:

 result=320 256 HAM6 220 CACHING=YES LOOP=YES CPF=NO

 or

 result=320 256 16 10 CACHING=YES LOOP=YES CPF=YES

GetSPLoader
-----------

 returns two arguments, the first is "ANIM" or "PIC"
 depending of the loader module type of the source project.
 The second argument is the name of the module itself.

 result: ModuleType ModuleName

 REFERENCE: SetSPLoader,GetSPSaver,SetSPSaver

GetSPName
---------

 source project has an animation loaded :

  returns the full animation name with path

 source project has a picture list loaded

  returns two arguments, the first is the name of the
  first picture with full path, the second is the name
  of the last picture without path.

 result: Name of animation or name of first/last picture.

 REFERENCE: LoadProject

GetSPSaver
----------

 returns two arguments, the first is "ANIM" or "PIC"
 depending of the saver module type of the source project.
 The second argument is the name of the module itself.

 result: ModuleType ModuleName

 REFERENCE: SetSPLoader,GetSPLoader,SetSPSaver

LoadProject <Name1> [Name2]
---------------------------

 LoadProject will load an animation or picture list, according to
 the type of the load module of the source project.

 <Name1> is the name of the animation or the name of the first picture
 of the picture list.

 [Name2] is only needed when you want to load a picture list, it is
 the name of the last picture.

 Example :

 LoadProject "Graphics:CountAnim.00001" "Graphics:CountAnim.00010"

 or

 LoadProject "Graphics:CountAnim.00001" "CountAnim.00010"

 or

 LoadProject "Graphics:Test/mandel7_32"

 result: -

OpenNewProject [CACHING]
------------------------

 Opens a new project window (up to five)
 If you supply the CACHING parameter, the project window
 will have caching enabled, otherwise it will be disabled.

 result: -

PlayProject
-----------

 Plays the animation of the source project.

 result: -

Quit
----

 Closes all projects and quits MainActor.

 result: -

PrintTxt <text>
---------------

 Displays <text> in the Text Buffer Window.

 result: -

PrintAndStoreTxt <text>
-----------------------

 Displays and buffers <text> in the Text Buffer Window.

 result: -

RequestInteger <InitValue> <text>
---------------------------------

 This command pops up an integer requester, <text> will
 be displayed above the integer value which was initialized with
 <InitValue>.

 Example:

 RequestInteger 640 "Enter new Width"

 result: integer value

Save <Name> [CPF=YES|NO] [LOOP=YES|NO]
--------------------------------------

 An animation saver saves the selected frames into a new animation
 under the name you put in the <Name> parameter. CPF decides wether
 you want a color palette per frame of not, LOOP decides if you
 want to have a looping animation. LOOP and CPF overrule the
 normal behaviour, if you dont supply them, everything will be saved
 as though you had activated the "Save" gadget (look at MainActor.Doc).

 If you have a picture saver, <Name> is the base name for the pictures,
 LOOP and CPF have, in this case, no meaning.

 result: -

ScreenToBack
------------

 Flips the MainActor screen to the back.

 result: -

 REFERENCE: WBToFront,ScreenToFront

ScreenToFront
-------------

 Flips the MainActor screen to the front.

 result: -

 REFERENCE: WBToFront,ScreenToBack

SelectAll
---------

 Selects all frames/pictures in the source project.

 result: -

 REFERENCE: DeSelectAll,SelectRange,DeSelectRange

SelectRange
-----------

 Will select all frames/pictures in the source project from the
 integer value <from> to <to>

 result: -

 REFERENCE: SelectAll,DeSelectAll,DeSelectRange

SelectRangeRequest
------------------

 The SelectRange requester will appear, letting you choose
 the frames/pictures to select.

 result: -

 REFERENCE: SelectAll,DeSelectAll,DeSelectRangeRequest

ShowPictures
------------

 Shows the selected pictures/frames of the source project.

 result: -

SetSPLoader <ModuleType> <ModuleName>
-------------------------------------

 sets the load module of the source project to the module
 type <ModuleType> with the module name <ModuleName>.

 result:-

 EXAMPLES:

 SetSPLoader PIC IFF

 SetSPLoader ANIM "IFF-Anim5"

 REFERENCE: GetSPLoader,GetSPSaver,SetSPSaver

SetSPSaver <ModuleType> <ModuleName>
------------------------------------

 sets the save module of the source project to the module
 type <ModuleType> with the module name <ModuleName>.

 result:-

 EXAMPLES:

 SetSPSaver PIC IFF

 SetSPSaver ANIM "IFF-Anim5"

 REFERENCE: GetSPLoader,GetSPSaver,SetSPLoader

SetTimecode <Timecode>
----------------------

 sets <Timecode> (a value from 1 to 999) in the selected frames
 of the source project.

 result: -

SwapDeActivatedToSource
-----------------------

 Flips the first deactivated project to the source and the source
 project to the destination project.

 result: -

SwapProjects
------------

 Flips the destination project to the source and the source
 project to the destination project.

 result: -

UnloadProject
-------------

 Unloads the current project of the source project.

 result: -

Version
-------

 result: The actual version string of MainActor.

WBToFront
---------

 Flips the WorkBench screen to the front.

 result: -

 REFERENCE: ScreenToFront

------------------------------------------------------