Strings - Revision history

Outerbeast at 20:14, 29 March 2025

2025-03-29T20:14:41Z

← Older revision		Revision as of 22:14, 29 March 2025
Line 76:		Line 76:
	All functions that support the use of this formatting note this in their documentation. It is also possible to use this simply to copy strings by not specifying any placeholders, but that should be avoided due to the increased overhead in parsing the string.		All functions that support the use of this formatting note this in their documentation. It is also possible to use this simply to copy strings by not specifying any placeholders, but that should be avoided due to the increased overhead in parsing the string.

			== Global Functions ==
			{\| class="wikitable"
			\|-
			! Declaration
			! Description
			\|-
			\| <code>string tolower(const string& in)
			\| style="font-weight:normal;" \| Converts the given character to lower case.
			\|-
			\| <code>string toupper(const string& in)
			\| style="vertical-align:middle;" \| Converts the given character to upper case.
			\|-
			\| <code>string formatInt(int64 value, const string &in options = "", uint width = 0)
			\| style="vertical-align:middle;" \| Formats a signed integer into a string.<br />The options string is a combination of the following characters:<br />'l' = left justify<br />'0' = pad with zeroes<br />'+' = always include the sign, even if positive<br />' ' = add a space in case of positive number<br />'h' = hexadecimal integer small letters<br />'H' = hexadecimal integer capital letters<br />
			\|-
			\| <code>string formatUInt(uint64 value, const string &in options = "", uint width = 0)
			\| style="vertical-align:middle;" \| Formats a unsigned integer into a string.<br />The options string is a combination of the following characters:<br />'l' = left justify<br />'0' = pad with zeroes<br />'+' = always include the sign, even if positive<br />' ' = add a space in case of positive number<br />'h' = hexadecimal integer small letters<br />'H' = hexadecimal integer capital letters<br />
			\|-
			\| <code>string formatFloat(double value, const string &in options = "", uint width = 0, uint precision = 0)
			\| style="vertical-align:middle;" \| Formats a double into a string.<br />The options string is a combination of the following characters:<br />'l' = left justify<br />'0' = pad with zeroes<br />'+' = always include the sign, even if positive<br />' ' = add a space in case of positive number<br />'e' = exponent character with small e<br />'E' = exponent character with capital E
			\|}
	[[Category:Scripting]]		[[Category:Scripting]]

Outerbeast: /* Conversions */

2025-02-14T20:02:56Z

Conversions

← Older revision		Revision as of 22:02, 14 February 2025
Line 55:		Line 55:
	\|-		\|-
	\| <code>bool atobool(const string& in, bool& out fIsValid)		\| <code>bool atobool(const string& in, bool& out fIsValid)
	\| style="vertical-align:middle;" \| Converts the given string to a boolean. fIsValid is true if the given string was a valid boolean value.		\| style="vertical-align:middle;" \| Converts the given string to a boolean. <code>fIsValid</code> is true if the given string was a valid boolean value.
	\|}		\|}

Outerbeast at 20:02, 14 February 2025

2025-02-14T20:02:04Z

← Older revision		Revision as of 22:02, 14 February 2025
Line 3:		Line 3:
	Most of the string documentation is fairly straightforward, so this documentation will only cover a few items.		Most of the string documentation is fairly straightforward, so this documentation will only cover a few items.

	==== string_t ====		== string_t ==
	string_t is a special string type used to refer to strings allocated from the game's string pool. This type will automatically convert to and from the string type when needed, but you may sometimes have to manually convert it using value type conversion syntax:		string_t is a special string type used to refer to strings allocated from the game's string pool. This type will automatically convert to and from the string type when needed, but you may sometimes have to manually convert it using value type conversion syntax:
	<nowiki>		<nowiki>

Outerbeast: /* Converting strings to other types */

2025-02-14T20:01:00Z

Converting strings to other types

← Older revision		Revision as of 22:01, 14 February 2025
Line 25:		Line 25:
	'''Reminder''': string methods cannot be used on a string_t object, so you will have to cast it to string first. A large majority of entity attributes, as well as engine variables that contain strings will be have the type "string_t" so keep this in mind.		'''Reminder''': string methods cannot be used on a string_t object, so you will have to cast it to string first. A large majority of entity attributes, as well as engine variables that contain strings will be have the type "string_t" so keep this in mind.

	== ~~Converting strings to other types~~ ==		== Conversions ==
	There are a variety of global functions that allow you to convert strings to other types, some of which should already be familiar		There are a variety of global functions that allow you to convert strings to other types, some of which should already be familiar

Outerbeast at 20:00, 14 February 2025

2025-02-14T20:00:43Z

@@ Line 25: / Line 25: @@
 '''Reminder''': string methods cannot be used on a string_t object, so you will have to cast it to string first. A large majority of entity attributes, as well as engine variables that contain strings will be have the type "string_t" so keep this in mind.
-==== printf ====
+== Converting strings to other types ==
 One of the features available in our API is a printf style formatting system. This allows you to provide a single string that contains placeholders where a varying number of arguments can be placed in them.

Outerbeast at 22:49, 13 February 2025

2025-02-13T22:49:15Z

← Older revision		Revision as of 00:49, 14 February 2025
Line 1:		Line 1:
	All text in ~~Angelscript~~, and computing in general, is represented by strings. In AngelScript, the string class is what we use for that. This class uses an interface that differs from the one provided by the default Angelscript add-on, so you cannot rely on that for Sven Co-op.		All text in AngelScript, and computing in general, is represented by strings. In AngelScript, the string class is what we use for that. This class uses an interface that differs from the one provided by the default Angelscript add-on, so you cannot rely on that for Sven Co-op.

	Most of the string documentation is fairly straightforward, so this documentation will only cover a few items.		Most of the string documentation is fairly straightforward, so this documentation will only cover a few items.

	===== string_t =====		==== string_t ====
	string_t is a special string type used to refer to strings allocated from the game's string pool. This type will automatically convert to and from the string type when needed, but you may sometimes have to manually convert it using value type conversion syntax:		string_t is a special string type used to refer to strings allocated from the game's string pool. This type will automatically convert to and from the string type when needed, but you may sometimes have to manually convert it using value type conversion syntax:
	<nowiki>		<nowiki>
	// Convert to a string:		// Convert to a string:
	string szString = string( string_t_value );		string szString = string( string_t_value );
	string_t szString_t = string_t( "a string" );		string_t szString_t = string_t( "a string" );</nowiki>
	</nowiki>

	Comparisons between string and string_t are legal:		Comparisons between string and string_t are legal:
Line 20:		Line 19:
	{		{
	// code		// code
	}		}</nowiki>
	</nowiki>

	In most cases, a string_t object will implicitly cast to a string but its recommended to do this explicitly to avoid situations where the type may be ambiguous.		In most cases, a string_t object will implicitly cast to a string but its recommended to do this explicitly to avoid situations where the type may be ambiguous.

	Reminder: string methods cannot be used on a string_t object, so you will have to cast it to string first. A large majority of entity attributes that ~~are~~ strings will be have the type "string_t" so keep this in mind.		'''Reminder''': string methods cannot be used on a string_t object, so you will have to cast it to string first. A large majority of entity attributes, as well as engine variables that contain strings will be have the type "string_t" so keep this in mind.

	===== printf =====		==== printf ====
	One of the features available in our API is a printf style formatting system. This allows you to provide a single string that contains placeholders where a varying number of arguments can be placed in them.		One of the features available in our API is a printf style formatting system. This allows you to provide a single string that contains placeholders where a varying number of arguments can be placed in them.

Line 37:		Line 35:
	{		{
	g_Game.AlertMessage( at_console, szResult );		g_Game.AlertMessage( at_console, szResult );
	}		}</nowiki>
	</nowiki>
	The syntax is fairly simple: every % symbol is considered a placeholder, with a number, starting at 1 for the first argument, referring to the argument that was passed in. If you want to use % itself, simply use %%. You can use the same argument multiple times, and it is not required to use each argument. Using a non-existent argument triggers a warning and causes formatting to fail.		The syntax is fairly simple: every % symbol is considered a placeholder, with a number, starting at 1 for the first argument, referring to the argument that was passed in. If you want to use % itself, simply use %%. You can use the same argument multiple times, and it is not required to use each argument. Using a non-existent argument triggers a warning and causes formatting to fail.

Outerbeast at 17:30, 13 February 2025

2025-02-13T17:30:42Z

← Older revision		Revision as of 19:30, 13 February 2025
Line 44:		Line 44:

	All functions that support the use of this formatting note this in their documentation. It is also possible to use this simply to copy strings by not specifying any placeholders, but that should be avoided due to the increased overhead in parsing the string.		All functions that support the use of this formatting note this in their documentation. It is also possible to use this simply to copy strings by not specifying any placeholders, but that should be avoided due to the increased overhead in parsing the string.

			[[Category:Scripting]]

Outerbeast at 17:04, 13 February 2025

2025-02-13T17:04:03Z

← Older revision		Revision as of 19:04, 13 February 2025
Line 25:		Line 25:
	In most cases, a string_t object will implicitly cast to a string but its recommended to do this explicitly to avoid situations where the type may be ambiguous.		In most cases, a string_t object will implicitly cast to a string but its recommended to do this explicitly to avoid situations where the type may be ambiguous.

	A large majority of entity attributes that are strings will be have the type "string_t" so keep this in mind.		Reminder: string methods cannot be used on a string_t object, so you will have to cast it to string first. A large majority of entity attributes that are strings will be have the type "string_t" so keep this in mind.

	===== printf =====		===== printf =====

Outerbeast: Created page with "All text in Angelscript, and computing in general, is represented by strings. In AngelScript, the string class is what we use for that. This class uses an interface that diffe..."

2025-02-13T17:02:10Z

Created page with "All text in Angelscript, and computing in general, is represented by strings. In AngelScript, the string class is what we use for that. This class uses an interface that diffe..."

New page

All text in Angelscript, and computing in general, is represented by strings. In AngelScript, the string class is what we use for that. This class uses an interface that differs from the one provided by the default Angelscript add-on, so you cannot rely on that for Sven Co-op.

Most of the string documentation is fairly straightforward, so this documentation will only cover a few items.

===== string_t =====
string_t is a special string type used to refer to strings allocated from the game's string pool. This type will automatically convert to and from the string type when needed, but you may sometimes have to manually convert it using value type conversion syntax:
<nowiki>
// Convert to a string:
string szString = string( string_t_value );
string_t szString_t = string_t( "a string" );
</nowiki>

Comparisons between string and string_t are legal:

<nowiki>
string sText1 = "a string";
string_t stText2 = "a string";

if( sText1 == stText2 )
{
// code
}
</nowiki>

In most cases, a string_t object will implicitly cast to a string but its recommended to do this explicitly to avoid situations where the type may be ambiguous.

A large majority of entity attributes that are strings will be have the type "string_t" so keep this in mind.

===== printf =====
One of the features available in our API is a printf style formatting system. This allows you to provide a single string that contains placeholders where a varying number of arguments can be placed in them.

The standalone snprintf function allows you to format input into a specified output string:
<nowiki>
string szResult;

if ( snprintf( szResult, "this %1 a %2 string\n", "is", "format" ) )
{
g_Game.AlertMessage( at_console, szResult );
}
</nowiki>
The syntax is fairly simple: every % symbol is considered a placeholder, with a number, starting at 1 for the first argument, referring to the argument that was passed in. If you want to use % itself, simply use %%. You can use the same argument multiple times, and it is not required to use each argument. Using a non-existent argument triggers a warning and causes formatting to fail.

You can pass in arguments that are primitives (boolean, integer, floating point) or strings (including string_t). Objects are output as memory addresses. Enums are also supported.

All functions that support the use of this formatting note this in their documentation. It is also possible to use this simply to copy strings by not specifying any placeholders, but that should be avoided due to the increased overhead in parsing the string.