Harmony
Scripting Interface Documentation
PaletteLocator Class Reference

This class is used to retrieve Constants used in the palette and colors. More...

Public Slots

String folderForLocation (int location, int elementId)
 Will return the full palette-library path for a given location. More...
 
String palettePathForLocation (int location, int elementId, String paletteName)
 Will return the filename of the palette including the .plt extension for a given palette and location. More...
 
String textureFolderForLocation (int location, int elementId, String paletteName)
 Will return the texture folder of the palette for a given palette and location. More...
 
StringList palettesAtLocation (int location, int elementId, bool fullFileName)
 
bool importPaletteAtLocation (String palettePath, int location, int elementId, String paletteName)
 

Detailed Description

This class is used to retrieve Constants used in the palette and colors.

Member Function Documentation

◆ folderForLocation

String PaletteLocator::folderForLocation ( int  location,
int  elementId 
)
slot

Will return the full palette-library path for a given location.

Parameters
locationOne of the PaletteLocation constants.
elementIdIf location is PaletteLocation.ELEMENT, the element id

◆ importPaletteAtLocation

bool PaletteLocator::importPaletteAtLocation ( String  palettePath,
int  location,
int  elementId,
String  paletteName 
)
slot

Will copy the plt file at the specified location in the project.

Parameters
palettePathThe full source palette file path.
locationOne of the PaletteLocation constants.
elementIdIf location is PaletteLocation.ELEMENT, the element id
paletteNameThe name the palette will have in the project.

◆ palettePathForLocation

String PaletteLocator::palettePathForLocation ( int  location,
int  elementId,
String  paletteName 
)
slot

Will return the filename of the palette including the .plt extension for a given palette and location.

Parameters
locationOne of the PaletteLocation constants.
elementIdIf location is PaletteLocation.ELEMENT, the element id
paletteNameThe palette name without the .plt extension

◆ palettesAtLocation

StringList PaletteLocator::palettesAtLocation ( int  location,
int  elementId,
bool  fullFileName 
)
slot

Will return the list of all .plt files at a given location.

Parameters
locationOne of the PaletteLocation constants.
elementIdIf location is PaletteLocation.ELEMENT, the element id
fullFileNameIf true will return the complete path list. Will return only the names otherwise.

◆ textureFolderForLocation

String PaletteLocator::textureFolderForLocation ( int  location,
int  elementId,
String  paletteName 
)
slot

Will return the texture folder of the palette for a given palette and location.

Parameters
locationOne of the PaletteLocation constants.
elementIdIf location is PaletteLocation.ELEMENT, the element id
paletteNameThe palette name without the .plt extension