Locale.StartsWith (Civ5 API)

From Civilization Modding Wiki
Jump to: navigation, search

This page is a part of the Lua and UI Reference (Civ5).


Function.png This function is a member of Locale.

This is a static method, invoke it with a dot.


Test if a string starts with a specified prefix (UTF-8 friendly)


Usage

bool Locale.StartsWith(string base_string, string prefix)


Returned Value

Returns true if base_string starts with prefix, false otherwise.

Parameters

base_string: The string to test against.
prefix: The prefix to test with.


Examples

local test = Locale.StartsWith("Civilization", "Civ");
print(test); -- prints true


The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.