Format
From SA-MP
[edit]
format
Formats a string to a variable.
(output[], len, const format[], {Float,_}:...)
| output[] | The string to output the result to |
| len | The maximum length output can contain |
| format[] | The format string |
| {Float,_}:... | Indefinite number of arguments of any tag |
This function does not return a specific value, it's best to simply ignore it.
[edit]
Format Strings
| Placeholder | Meaning |
|---|---|
| %c | Inserts a single character. |
| %d | Inserts an integer (whole) number |
| %x | Inserts a number in hexadecimal notation. |
| %f | Inserts a floating point number. |
| %s | Inserts a string. |
| %% | Inserts the literal '%' |
The values for the placeholders follow in the exact same order as parameters in the call.
You may optionally put a number between the '%' and the letter of the placeholder code. This number indicates the field width; if the size of the parameter to print at the position of the placeholder is smaller than the field width, the field is expanded with spaces.
new result[256]; new number = 42; format(result,sizeof(result), "The number is %d.",number); //-> The number is 42. new string[]= "simple message"; format(result,sizeof(result), "This is a %s containing the number %d.",string,number); //-> This is a simple message containing the number 42.
[edit]
Related Functions
The following functions might be useful as well, as they're related to this function in one way or another.
- print: Print a string.
- printf: Print a formatted string.
