Template:Sprintf/doc

From Old School RuneScape Wiki
Jump to: navigation, search
Information icon-grey.svg
This is a documentation subpage for Template:Sprintf.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Sprintf invokes function main in Module:Sprintf using Lua.
Template:Sprintf invokes Module:sprintf using Lua.

Provides access to the lua string.format function.

Usage

{{Sprintf|format string|param1|param2|...|paramN}}

The format string is specified according to string.format, which uses printf formatting with a few exceptions. See documentation for full details. The paramters should be provided as required by the format string.

Examples

* Two strings: {{Sprintf|%s - %s|abyssal|whip}}
* Floating point formatting: {{Sprintf|%3.2f|12345.678901}}
* Hexadecimal conversion: {{Sprintf|%x|100}}
  • Two strings: abyssal - whip
  • Floating point formatting: 12345.68
  • Hexadecimal conversion: 64

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.


Provides access to the lua string formatting function.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Format string1

no description

Default
empty
Example
empty
Auto value
empty
Unknownrequired
Parameter 12

Param to be inserted in the first replacement position.

Default
empty
Example
empty
Auto value
empty
Stringrequired
Parameter 23

Second parameter (repeat for as many as are specified by the format string)

Default
empty
Example
empty
Auto value
empty
Unknownoptional