Difference between revisions of "FontBase:getCharIndexAtOffset"

From GiderosMobile
m
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
Returns the offset within the given text string to which corresponds the given X offset in the drawn text.
 
Returns the offset within the given text string to which corresponds the given X offset in the drawn text.
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(number) = FontBase:getCharIndexAtOffset(text,offset,letterSpacing,size)
 
(number) = FontBase:getCharIndexAtOffset(text,offset,letterSpacing,size)
</source>
+
</syntaxhighlight>
  
 
=== Parameters ===
 
=== Parameters ===

Latest revision as of 15:29, 13 July 2023

Available since: Gideros 2018.3.1
Class: FontBase

Description

Returns the offset within the given text string to which corresponds the given X offset in the drawn text.

(number) = FontBase:getCharIndexAtOffset(text,offset,letterSpacing,size)

Parameters

text: (string)
offset: (number)
letterSpacing: (number, default = 0)
size: (number, optional)

Return values

Returns (number) The offset within the text string. The decimal part indicate the relative distance throughout the character itself.