BIS fnc trimString: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Some wiki formatting)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|Comments=
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |Game name=
|gr1= Strings


|1.00|Game version=
|descr= Get a substring out of the string.
____________________________________________________________________________________________
{{Feature|arma3|Use [[select#Alternative Syntax 3|select]] instead.}}


| Get a substring out of the string. |DESCRIPTION=
|s1= [someText, beginning, length] call [[BIS_fnc_trimString]]
____________________________________________________________________________________________


| [someText, beginning, length] call [[BIS_fnc_trimString]] |SYNTAX=
|p1= someText: [[String]] - source string


|p1= someText: [[String]] - source string |PARAMETER1=
|p2= beginning: [[Number]] (Optional, default 0) - start index; indexing starts at 0


|p2= beginning: [[Number]] (Optional, default 0) - start index; indexing starts at 0 |PARAMETER2=
|p3= length: [[Number]] (Optional, default end of string) - end index. A negative number means X chars ''from the string end''


|p3= length: [[Number]] (Optional, default end of string) - end index. A negative number means X chars ''from the string end'' |PARAMETER3=
|r1= [[String]]


| [[String]] |RETURNVALUE=
|x1= <sqf>["dreaded_is_the_man", 0, 6] call BIS_fnc_trimString; // will return "dreaded"</sqf>
____________________________________________________________________________________________


|x1= <code>["dreaded_is_the_man", 0, 6] [[call]] [[BIS_fnc_trimString]]; {{codecomment|// will return "dreaded"}}</code> |EXAMPLE1=
|x2= <sqf>["dreaded_is_the_man", 15] call BIS_fnc_trimString; // will return "man"</sqf>


|x2= <code>["dreaded_is_the_man", 15] [[call]] [[BIS_fnc_trimString]]; {{codecomment|// will return "man"}}</code> |EXAMPLE2=
|x3= <sqf>["dreaded_is_the_man"] call BIS_fnc_trimString; // will return "dreaded_is_the_man"</sqf>
 
|x3= <code>["dreaded_is_the_man"] [[call]] [[BIS_fnc_trimString]]; {{codecomment|// will return "dreaded_is_the_man"}}</code> |EXAMPLE3=
____________________________________________________________________________________________
 
| |SEEALSO=


|seealso= [[select]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<!-- CONTINUE Notes -->
|user= R3vo
 
|timestamp= 20170824154500
<dl class="command_description">
|text= <sqf>
<dd class="notedate">Posted on August 24, 2017 - 15:45 (UTC)
"test" select [0, 4]; // 0.0007 ms
<dt class="note">[[User:Revo|Revo]]
["test", 0, 4] call BIS_fnc_trimString; // 0.013 ms
<dd class="note">
</sqf>
<code>"test" [[select]] [0,4];</code>
Result: '''0.0007 ms'''<br><br>
 
<code>["test",0,4] [[call]] [[BIS_fnc_trimString]];</code>
Result: '''0.013 ms'''<br><br>


The first method is about '''18 times faster'''.
The first method is about '''18 times faster'''.
</dl>
}}
<!-- DISCONTINUE Notes -->
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strings|{{uc:trimString}}]]
[[Category:Functions|{{uc:trimString}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:trimString}}]]

Latest revision as of 22:38, 13 May 2023

Hover & click on the images for description

Description

Description:
Get a substring out of the string.
Arma 3
Use select instead.
Execution:
call
Groups:
Strings

Syntax

Syntax:
[someText, beginning, length] call BIS_fnc_trimString
Parameters:
someText: String - source string
beginning: Number (Optional, default 0) - start index; indexing starts at 0
length: Number (Optional, default end of string) - end index. A negative number means X chars from the string end
Return Value:
String

Examples

Example 1:
["dreaded_is_the_man", 0, 6] call BIS_fnc_trimString; // will return "dreaded"
Example 2:
["dreaded_is_the_man", 15] call BIS_fnc_trimString; // will return "man"
Example 3:
["dreaded_is_the_man"] call BIS_fnc_trimString; // will return "dreaded_is_the_man"

Additional Information

See also:
select

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
R3vo - c
Posted on Aug 24, 2017 - 15:45 (UTC)
"test" select [0, 4]; // 0.0007 ms ["test", 0, 4] call BIS_fnc_trimString; // 0.013 ms
The first method is about 18 times faster.