API:CircleImageSetTextureScale

UI Lua API · CircleImage functions
Version: WAR 1.4.8

Sets the scale at which a CircleImage draws its texture.

CircleImageSetTextureScale(imageName, scale)

Arguments

imageName

string – Name of a CircleImage window.

scale

number – Texture scale. Larger values show a smaller part of the texture in the same circle, so the texture appears larger.

Returns

Nothing.

Details

• The scale is stored and the image is rebuilt with its current texture and texture position.
• In the stock XML, CircleImage elements have a textureScale attribute, for example textureScale="0.65".
• The function needs at least two arguments and only reads the last two.
• The stock UI never calls CircleImageSetTextureScale.

Errors

• Error in function call 'CircleImageSetTextureScale': Window %s does not exist
• Error in function call 'CircleImageSetTextureScale': Window %s is not a CircleImage

Example

A minimal example built from the signature above:

CircleImageSetTextureScale( "MyCircleImage", 0.5 )

See also

• CircleImageSetTexture
• DynamicImageSetTextureScale