Skip to content

GetStringWidth

Description

Retrieves the width of a string in pixels when displayed with DrawText.

Parameters

  • aniFrames The SpriteAnimation to use frames from.
  • listID The index of the animation in the animation list to use frames from.
  • string The string that characters are retrieved from.
  • startIndex The starting character index.
  • length The end character index. A value of 0 will result in the end character index being string.length.
  • spacing The number of pixels between each character.

Return Value

Returns the width of the string in pixels as an int32. This width is the same as it would be if DrawText was called with the same parameters.

Syntax

RSDK.GetStringWidth(uint16 aniFrames, uint16 listID, String *string, int32 startIndex, int32 length, int32 spacing);

String.GetWidth(SpriteAnimation aniFrames, uint16 listID, int32 startIndex, int32 length, int32 spacing);

Example

int32 width = RSDK.LoadSpriteAnimation(MyObject->aniFrames, 0, &string, 0, string.length, 1);

int32 width = string.GetWidth(sVars->aniFrames, 0, 0, string.length, 1);