Torque3D Documentation / _generateds / AssetTagsManifest

AssetTagsManifest

consoledoc.h

More...

Public Functions

void
createTag(string tagName)

Creates an asset tag.

bool
deleteTag(string tagName)

Deletes an asset tag.

string
getAssetTag(string assetId, int tagIndex)

Gets the asset tag on the specified asset Id at the specified index.

int
getAssetTagCount(string assetId)

Gets the asset tag count on the specified asset Id.

string
getTag(int tagIndex)

Gets the asset tag at the specified index.

int

Gets the total asset tag count.

bool
hasTag(string assetId, string tagName)

Checks whether the asset Id is tagged with the specified asset tag.

bool
isTag(string tagName)

Checks whether the specified asset tag exists or not.

bool
renameTag(string oldTagName, string newTagName)

Renames an existing asset tag.

bool
tag(string assetId, string tagName)

Tags the asset Id with the specified asset tag.

bool
untag(string assetId, string tagName)

Un-tags the asset Id from the specified asset tag.

Detailed Description

UNDOCUMENTED!

Public Functions

createTag(string tagName)

Creates an asset tag.

Parameters:

tagName

The tag name to create.

return:

No return value.

deleteTag(string tagName)

Deletes an asset tag.

Parameters:

tagName

The tag name to delete.

return:

Whether the asset tag was deleted or not.

getAssetTag(string assetId, int tagIndex)

Gets the asset tag on the specified asset Id at the specified index.

Parameters:

assetId

The asset Id to count tags on.

tagIndex

The asset tag index.This must be 0 to the asset tag count less one.

return:

The asset tag on the specified asset Id at the specified index or NULL if invalid.

getAssetTagCount(string assetId)

Gets the asset tag count on the specified asset Id.

Parameters:

assetId

The asset Id to count tags on.

return:

The asset tag count on the specified asset Id.

getTag(int tagIndex)

Gets the asset tag at the specified index.

Parameters:

tagIndex

The asset tag index.This must be 0 to the asset tag count less one.

return:

The asset tag at the specified index or NULL if invalid.

getTagCount()

Gets the total asset tag count.

return:

The total asset tag count.

hasTag(string assetId, string tagName)

Checks whether the asset Id is tagged with the specified asset tag.

Parameters:

assetId

The asset Id to check.

tagName

The tag name to check.

return:

Whether the asset Id is tagged with the specified asset tag or not.

isTag(string tagName)

Checks whether the specified asset tag exists or not.

Parameters:

tagName

The tag name to check.

return:

Whether the specified asset tag exists or not.

renameTag(string oldTagName, string newTagName)

Renames an existing asset tag.

Parameters:

tagName

The tag name to rename.

newTagName

The new tag name to assign.

return:

Whether the asset tag was renamed or not.

tag(string assetId, string tagName)

Tags the asset Id with the specified asset tag.

Parameters:

assetId

The asset Id to tag.

tagName

The tag name to assign.

return:

Whether the tag operation was successful or not.

untag(string assetId, string tagName)

Un-tags the asset Id from the specified asset tag.

Parameters:

assetId

The asset Id to un - tag.

tagName

The tag name to un - assign.

return:

Whether the un - tag operation was successful or not.