Tile - String - Substring – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Ylands editor navbox}}" to "{{Navbox/Ylands}}")
No edit summary
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Image:Ylands_Tile_-_String_substring.png]]
<!---
*'''Returns''' new [[Ylands Tile - String literal|'''string''']] of given length '''extracted''' from source 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 substring.
-->
*'''Length''' - number of characters to be extracted.
== Substring(Source, Start index, Length) ==


[[File:YlandsTile-86.png]]


[[Image:Ylands_Tile_-_String_substring2.png]]
<pre>substr(start: number, length: number): string;</pre>
*'''Returns''' new [[Ylands Tile - String literal|'''string''']] '''extracted''' from source text '''within''' the given '''range'''.
=== Parameters ===
*Interval is '''half closed''' and does not include character at '''end''' position.


==== start ====


[[Image:Ylands_Tile_-_String_substring3.png]]
Starting position of removed text
*'''Returns''' new [[Ylands Tile - String literal|'''string''']] '''extracted''' from given '''start''' position until the end source text.
*'''Start index''' - position at which to start substring.


=Notes=
==== length ====
*Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...
 
Lenght of removed text
 
=== Returns ===
 
'''string'''
 
=== Availability ===
 
[[Ylands:Tile Availability - Client|Client]], [[Ylands:Tile Availability - Server|Server]], [[Ylands:Tile Availability - Custom Controller|Custom Controller]]
 
=== Description ===
 
Returns new '''string''' of given length '''extracted''' from source text.
 
=== Notes ===
 
* '''Start index''' - position at which to start substring.
* '''Length''' - number of characters to be extracted.
* Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...
 
== Substring(Source, Start index, End Index) ==
 
[[File:YlandsTile-87.png]]
 
<pre>substring(start: number, end: number): string;</pre>
=== Parameters ===
 
==== start ====
 
==== end ====
 
=== Returns ===
 
'''string'''
 
=== Availability ===
 
[[Ylands:Tile Availability - Client|Client]], [[Ylands:Tile Availability - Server|Server]], [[Ylands:Tile Availability - Custom Controller|Custom Controller]]
 
=== Description ===
 
'''Returns''' new '''string''' '''extracted''' from source text '''within''' the given '''range'''.
 
=== Notes ===
 
* Interval is '''half closed''' and does not include character at '''end''' position.
* Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...
 
== Substring(Source, Start index) ==
 
[[File:YlandsTile-88.png]]
 
<pre>substring(start: number): string;</pre>
=== Parameters ===
 
==== start ====
 
Starting position of removed text
 
=== Returns ===
 
'''string'''
 
=== Availability ===
 
[[Ylands:Tile Availability - Client|Client]], [[Ylands:Tile Availability - Server|Server]], [[Ylands:Tile Availability - Custom Controller|Custom Controller]]
 
=== Description ===
 
'''Returns''' new '''string''' '''extracted''' from given '''start''' position until the end of source text.
 
=== Notes ===
 
* '''Start index''' - position at which to start substring.
* Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...




Line 23: Line 97:


[[Category: Instructions]]
[[Category: Instructions]]
[[Category: Ylands 0.10]]

Revision as of 12:17, 12 November 2021

Substring(Source, Start index, Length)

YlandsTile-86.png

substr(start: number, length: number): string;

Parameters

start

Starting position of removed text

length

Lenght of removed text

Returns

string

Availability

Client, Server, Custom Controller

Description

Returns new string of given length extracted from source text.

Notes

  • Start index - position at which to start substring.
  • Length - number of characters to be extracted.
  • Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...

Substring(Source, Start index, End Index)

YlandsTile-87.png

substring(start: number, end: number): string;

Parameters

start

end

Returns

string

Availability

Client, Server, Custom Controller

Description

Returns new string extracted from source text within the given range.

Notes

  • Interval is half closed and does not include character at end position.
  • Script counts positions from zero. 0 is the first position in a string, 1 is the second, 2 is the third ...

Substring(Source, Start index)

YlandsTile-88.png

substring(start: number): string;

Parameters

start

Starting position of removed text

Returns

string

Availability

Client, Server, Custom Controller

Description

Returns new string extracted from given start position until the end of source text.

Notes

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