SetItemFromMemblock

Syntax:

SetItemFromMemblock(archiveID as integer, itemName as string, memblockID as integer) as integer

Description:

Sets a item from a memblock. After this process completes, it is safe to delete the memblock.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.

SetItemFromFile

Syntax:

SetItemFromFile(archiveID as integer, itemName as string, fileName as string) as integer

Description:

Sets an item from a file.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.
• If there is a problem creating a memblock from the file.

SetItemFromImage

Syntax:

SetItemFromImage(archiveID as integer, itemName as string, imageID as integer) as integer

Description:

Sets an item from an image. After this process completes, it is safe to delete the image.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.
• If there is a problem creating a memblock from the image.

SetItemFromImageFile

Syntax:

SetItemFromImageFile(archiveID as integer, itemName as string, fileName as string) as integer

Description:

Sets an item from an image file.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.
• If there is a problem creating a memblock from the image file.

SetItemFromObjectMesh

Syntax:

SetItemFromObjectMesh(archiveID as integer, itemName as string, objectID as integer, meshIndex as integer) as integer

Description:

Sets an item from an object mesh. After this process completes, it is safe to delete the object mesh.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.
• If there is a problem creating a memblock from the object mesh.

SetItemFromSound

Syntax:

SetItemFromSound(archiveID as integer, itemName as string, soundID as integer) as integer

Description:

Sets an item from a sound. After this process completes, it is safe to delete the sound.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.
• If there is a problem creating a memblock from the sound.

SetItemFromSoundFile

Syntax:

SetItemFromSoundFile(archiveID as integer, itemName as string, fileName as string) as integer

Description:

Sets an item from a sound file.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.
• If there is a problem creating a memblock from the sound file.

SetItemFromString

Syntax:

SetItemFromString(archiveID as integer, itemName as string, text as string) as integer

Description:

Sets an item from string text.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.
• If there is a problem creating a memblock from the string text.

Clear

Syntax:

Clear(archiveID as integer) as integer

Description:

Removes all items from the archive.

Returns:

1 if operation succeeded; otherwise 0.

PluginError:

• If given an invalid archive ID.

DeleteItem

Syntax:

DeleteItem(archiveID as integer, itemName as string) as integer

Description:

Deletes an item from the archive if it exists.

Returns:

1 if operation succeeded and an item was deleted; otherwise 0.

PluginError:

• If given an invalid archive ID.