Using String Table

   Print  Previous  Next

Functions Provided For Using The String Table

The following table provides an overview of all functions the effect can use to modify the elements in a String Table:

 

Function

Description

int StringTableGetCount(int page)

Returns the current number of elements in the String Table.

void StringTableMoveStringUp(int index, int page)

Moves an element with its specified index up a place in the String Table. Indexing starts with 0.

void StringTableMoveStringDown(int index, int page)

Moves an element with its specified index down a place in the String Table. Indexing starts with 0.

void StringTableInvert(int page)

Inverts the complete String Table regarding the positions of the elements in the table.

void StringTableSwapStrings(int index1, int index2, int page)

Swaps elements with their specified indices in the String Table. Indexing starts with 0.

void StringTableSetString(int index, string, int page)

Sets a new string text for the element with the specified index. Indexing starts with 0.

string StringTableGetString(int index, int page)

Returns the text as a string for the element with the specified index. Indexing starts with 0.

void StringTableAddString(int index, string, int page)

Adds a new element with its text as string to the specified index. Indexing starts with 0.

void StringTableRemoveString(int index, int page)        

Removes the element with the specified index from the String Table. Indexing starts with 0.

void StringTableSetLoop(int enable)

Sets the Loop Mode. Use 1 (TRUE) to activate it. Use 0 (FALSE) to deactivate it.

int StringTableGetLoop()

Returns 1 (TRUE) if Loop Mode is activated, otherwise 0 (FALSE).

void StringTableToggleLoop()        

Toggles the Loop Mode.

int StringTableGetShuffle()

Sets the Shuffle Mode. Use 1 (TRUE) to activate it. Use 0 (FALSE) to deactivate it.

void StringTableSetShuffle(int enable)

Returns 1 (TRUE) if Shuffle Mode is activated, otherwise 0 (FALSE).

void StringTableToggleShuffle()

Toggles the Shuffle Mode.

int StringTableGetPagesCount()

Returns the current number of pages in the String Table.

void StringTableAddPage(int count)

Adds the number of new pages as defined by count.

void StringTableRemovePage(int count)

Removes the number of pages as defined by count.

void StringTableMovePageToNext(int index)

Moves the pages defined by index to the next position to the right. Indexing starts with 0.

void StringTableMovePageToPrev(int index)

Moves the pages defined by index to the previous position. Indexing starts with 0.

void StringTableInvertPages()

Inverts the order of pages.

void StringTableSwapPages(int index1, int index2)

Swaps the position of two pages as defined by index1 and index2. Indexing starts with 0.

 

MADRIX Version: 5.1b | Script Version: 3.10
[Ctrl & +/-] = Zoom In/Out | [Ctrl & 0] = 100%
Print   Previous   Next