编辑“︁StendhalScripting/LuaAPI”︁（章节）

= Supplemental Methods =

A few convenience methods are added to make scripting easier.

== String Manipulation ==

The following methods have been added to the built-in Lua [https://www.lua.org/manual/5.3/manual.html#6.4 string] library.

; ''<span style="color:green;">string.startsWith</span>(st, prefix)''
: Checks if a string begins with a set of characters.
: '''''st:''''' The string to be checked.
: '''''prefix:''''' The prefix to be compared with.
: ''returns:'' <code>true</code> if <code>prefix</code> matches the beginning characters of <code>st</code>.
:; ''aliases:''
:: <span style="color:green; font-style:italic;">string.beginsWith</span>

; ''<span style="color:green;">string.endsWith</span>(st, suffix)''
: Checks if a string ends with a set of characters.
: '''''st:''''' The string to be checked.
: '''''suffix:''''' The suffix to be compared with.
: ''returns:'' <code>true</code> if <code>suffix</code> matches then end characters of <code>st</code>.

; ''<span style="color:green;">string.isNumber</span>(st)''
: Checks if a string contains numeric characters only.
: '''''st:''''' The string to be checked.
: ''returns:'' <code>true</code> if all characters are numeric, <code>false</code> otherwise.
:; ''aliases:''
:: <span style="color:green; font-style:italic;">string.isNumeric</span>

; ''<span style="color:green;">string.trim</span>(st)''
: Removes leading & trailing whitespace from a string.
: '''''st:''''' The string to be trimmed.
: ''returns:'' Trimmed string.

; ''<span style="color:green;">string.ltrim</span>(st)''
: Removes leading whitespace from a string.
: '''''st:''''' The string to be trimmed.
: ''returns:'' Trimmed string.

; ''<span style="color:green;">string.rtrim</span>(st)''
: Removes trailing whitespace from a string.
: '''''st:''''' The string to be trimmed.
: ''returns:'' Trimmed string.

; ''<span style="color:green;">string.builder</span>(st)''
: Creates a new instance of [https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html java.lang.StringBuilder].
: '''''st:''''' (optional) String to append on instantiation.
: ''returns:'' new StringBuilder instance.

== Table Manipulation ==

The following methods have been added to the built-in Lua [https://www.lua.org/manual/5.3/manual.html#6.6 table] library.

; ''<span style="color:green;">table.concat</span>(tbl1, tbl2)''
: Merges the contents of one table into another.
: '''''tbl1:''''' The table receiving the new content.
: '''''tbl2:''''' The table containing the content to be copied.

{{PublicMethod | table.contains | params=table, o | desc=Checks if a table contains a value. | paramlist=
{{MethodParam | table | type=table | desc=Table to be checked.}}
{{MethodParam | o | desc=The object to check for.}}
| ret=<code>true</code> if <code>o</code> is in <code>table</code>. | rettype=boolean }}

; ''<span style="color:green;">table.clean</span>(tbl)''
: Removes <code>nil</code> values from a table.
: '''''tbl:''''' The table to be cleaned.
: ''returns:'' Copy of <code>tbl</code> with <code>nil</code> values removed.

{{PublicMethod | table.join | params=table, delim | desc=Joins a table of strings into a string. | paramlist=
{{MethodParam | table | type=table | desc=Table to be joined.}}
{{MethodParam | delim | type=string | desc=Character(s) to be used as separator.}}
| ret=The resulting string. | rettype=string }}