Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:CircleImageSetTextureSlice

From RoR Wiki

UI Lua API · CircleImage functions
Version: WAR 1.4.8

Shows a named slice of a CircleImage's texture.

CircleImageSetTextureSlice(imageName, sliceName)

Arguments

imageName
string – Name of a CircleImage window.
sliceName
string – Name of a slice defined for the image's texture.

Returns

Nothing.

Details

  • The slice name is stored on the image. If the image's texture is loaded and has a slice with that name, the texture position is reset to 0, 0 and the circle is rebuilt.
  • A slice name that is not found raises no error; the image is left as it was.
  • The stock UI never calls CircleImageSetTextureSlice.

Errors

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

Example

A minimal example built from the signature above:

CircleImageSetTextureSlice( "MyCircleImage", "MySliceName" )

See also