scripting:reference:system_functions:textfunctions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| scripting:reference:system_functions:textfunctions [2020/02/04 21:47] – mit | scripting:reference:system_functions:textfunctions [2020/02/07 03:13] (current) – mit | ||
|---|---|---|---|
| Line 11: | Line 11: | ||
| ==== sysGetPlayerName ==== | ==== sysGetPlayerName ==== | ||
| - | ^ Format | sysGetPlayerName( | + | ^ Format | sysGetPlayerName( PlayerID )| |
| ^ Description | Returns the name of the specified player| | ^ Description | Returns the name of the specified player| | ||
| - | ^ Parameters | Player ID | | ||
| ^ Returns | Player Name | | ^ Returns | Player Name | | ||
| // | // | ||
| Line 33: | Line 32: | ||
| ==== sysGetItemNum ==== | ==== sysGetItemNum ==== | ||
| - | ^ Format | sysGetItemNum( | + | ^ Format | sysGetItemNum( Item Name )| |
| ^ Description | Gets an item number from a name| | ^ Description | Gets an item number from a name| | ||
| - | ^ Parameters | Item Name | | ||
| ^ Returns | Item number | | ^ Returns | Item number | | ||
| // | // | ||
| Line 50: | Line 48: | ||
| ==== sysGetPriceText ==== | ==== sysGetPriceText ==== | ||
| - | ^ Format | sysGetPriceText ( [Price] )| | + | ^ Format | sysGetPriceText ( Price )| |
| ^ Description | Returns a text string displaying the price value expressed in a short format - e.g 2s 3d | | ^ Description | Returns a text string displaying the price value expressed in a short format - e.g 2s 3d | | ||
| - | ^ Parameters | Price value (in denari) | | ||
| ^ Returns | Price text | | ^ Returns | Price text | | ||
| + | ^ Notes | Price parameter is the value in denari | | ||
| // | // | ||
| < | < | ||
| Line 72: | Line 70: | ||
| </ | </ | ||
| ==== sysGetDateText ==== | ==== sysGetDateText ==== | ||
| - | ^ Format | sysGetDateText( | + | ^ Format | sysGetDateText( |
| ^ Description | Returns a text string displaying the date and time | | ^ Description | Returns a text string displaying the date and time | | ||
| - | ^ Parameters | Unix time (Number of seconds since 1 Jan 1970) | | ||
| ^ Returns | Text of the date and time (e.g. "31st December 2014 18:00" ) | | ^ Returns | Text of the date and time (e.g. "31st December 2014 18:00" ) | | ||
| + | ^ Notes | Parameter is 'Unix time' ; (Number of seconds since 1 Jan 1970) | | ||
| // | // | ||
| < | < | ||
| Line 98: | Line 96: | ||
| ==== sysGetTimeText ==== | ==== sysGetTimeText ==== | ||
| - | ^ Format | sysGetTimeText ( [Num_seconds] )| | + | ^ Format | sysGetTimeText ( Num_seconds )| |
| ^ Description | Returns text form of the time provided in seconds using the most appropriate resolution ; i.e. if you pass 110 seconds, the text will be "1 minute and 50 seconds" | ^ Description | Returns text form of the time provided in seconds using the most appropriate resolution ; i.e. if you pass 110 seconds, the text will be "1 minute and 50 seconds" | ||
| - | ^ Parameters | Number of seconds | | ||
| ^ Returns | Text representation of given time period | | ^ Returns | Text representation of given time period | | ||
| // | // | ||
| Line 124: | Line 121: | ||
| ==== sysGetRealTimeTextForDays ==== | ==== sysGetRealTimeTextForDays ==== | ||
| - | ^ Format | sysGetRealTimeTextForDays ( [Number of game days] )| | + | ^ Format | sysGetRealTimeTextForDays ( Number_of_game_days |
| - | ^ Description | Returns a text description of the time that will pass for the specified number of game days | | + | ^ Description | Returns a text description of the time that will pass for the specified number of game days, using the most appropriate resolution. (e.g. If the result is 30 seconds, it'll return "30 seconds", |
| - | ^ Parameters | Number of game days | | + | |
| ^ Returns | Time text | | ^ Returns | Time text | | ||
| // | // | ||
scripting/reference/system_functions/textfunctions.1580874432.txt.gz · Last modified: 2020/02/04 21:47 by mit