Tile - String - Includes – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Image:Ylands_Tile_-_String_includes.png]]
<!---
*'''Returns''' (true/false) '''whenever''' given [[Ylands Tile - String literal|'''string''']] '''contains''' characters of a specified '''text'''.
THIS PAGE WAS GENERATED AUTOMATICALLY; DO NOT EDIT IT, OTHERWISE YOUR CHANGES WILL BE LOST DURING FUTURE UPDATE.
*'''Start index'''
-->
**Position at which to start the search.
== Includes(Source, Text, Start index) ==
**Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...


=Notes=
[[File:YlandsTile-83.png]]
*Instruction is '''case''' '''sensitive'''.
 
<pre>includes(text: any, startIndex: number): boolean;</pre>
=== Parameters ===
 
==== text ====
 
String to test
 
==== startIndex ====
 
=== Returns ===
 
'''boolean'''
 
=== Availability ===
 
[[Ylands:Tile Availability - Client|Client]], [[Ylands:Tile Availability - Server|Server]], [[Ylands:Tile Availability - Custom Controller|Custom Controller]]
 
=== Description ===
 
Returns '''whenever''' given '''string''' '''contains''' characters of a specified '''text'''.
 
=== Notes ===
 
* '''Start index''' - position at which to start the search.
* Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...
* Instruction is '''case''' '''sensitive'''.




----
----
{{Ylands scripting navbox}}
{{Navbox/Ylands}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}}
 
[[Category: Instructions]]

Revision as of 12:17, 12 November 2021

Includes(Source, Text, Start index)

YlandsTile-83.png

includes(text: any, startIndex: number): boolean;

Parameters

text

String to test

startIndex

Returns

boolean

Availability

Client, Server, Custom Controller

Description

Returns whenever given string contains characters of a specified text.

Notes

  • Start index - position at which to start the search.
  • Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...
  • Instruction is case sensitive.