AddIconToken

This defines a token (e.g. $EmptyShop$) for icon replacement in menus and suchlike.

It takes a string representing the token to be replaced, a string giving the filepath to the spritesheet, the dimensions of the sprite and the frame number of the spritesheet to use.

There are two variants, one of which will also accept a color (SColor), used as a background colour.

void AddIconToken( const string &token, const string &texture, dimension2di frameDimension, int frame, SColor color )
void AddIconToken( const string &token, const string &token, dimension2di frameDimension, int frame )

Example from Entities/Characters/Scripts/BuilderInventory.as:

void onInit( CInventory@ this )
{
  AddIconToken( "$EmptyShop$", "Entities/Workshops/Sprites/WorkshopIcons.png", dimension2di(16,16), 0 );
}

This icon token means that whenever $EmptyShop$ is included in menu text, the first frame of the WorkshopIcons.png spritesheet will be substituted in.