Revision Difference
utf8.offset#524928
<function name="offset" parent="utf8" type="libraryfunc">
<description>Returns the byte-index of the n'th UTF-8-character after the given startPos (nil if none). startPos defaults to 1 when n is positive and -1 when n is negative. If n is zero, this function instead returns the byte-index of the UTF-8-character startPos lies within.</description>
<realm>Shared</realm>
<file line="226-L296">lua/includes/modules/utf8.lua</file>
<args>
<arg name="string" type="string">The string that you will get the byte position from.</arg>
<arg name="n" type="number">The position to get the beginning byte position from.</arg>
<arg name="startPos" type="number" default="1 when n\u0026amp;gt;=0, -1 otherwise">The offset for n.</arg>
<arg name="startPos" type="number" default="1 when n>=0, -1 otherwise">The offset for n.</arg>
</args>
<rets>
<ret name="" type="number">Starting byte-index of the given position.</ret>
</rets>
</function>
<example>
<description>Returns the byte-index where the character at the 5th byte begins.</description>
<code>print(utf8.offset("( ͡° ͜ʖ ͡°)", 5))</code>
<output>7</output>
</example>