Difference between revisions of "Ryzom API/Time"
From EncyclopAtys
(Created page with "To know the time and date in Ryzom. ===Usage=== <base URL>/time.php ===URL Parameters=== ====format==== (optional), defaults ro raw. :*<code>raw</code> : Returns the tick....") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | <noinclude>{{Trad|DE=Ryzom API/Time|FR=Ryzom API/Time|palette=atys|H=1}}</noinclude> | ||
To know the time and date in Ryzom. | To know the time and date in Ryzom. | ||
===Usage=== | ===Usage=== | ||
<base URL>/time.php | <base URL>/time.php | ||
| − | ===URL Parameters=== | + | ====URL Parameters==== |
| − | + | ;format: (optional), defaults ro raw. | |
| − | |||
| − | (optional), defaults ro raw. | ||
:*<code>raw</code> : Returns the tick. The server tick is a 32 bit integer that increases by one every 100 milliseconds. | :*<code>raw</code> : Returns the tick. The server tick is a 32 bit integer that increases by one every 100 milliseconds. | ||
:*<code>txt</code> : Returns a homine-readable string. | :*<code>txt</code> : Returns a homine-readable string. | ||
| − | :*<code>xml</code> : Returns an xml file that contains all shard time information. | + | :*<code>xml</code> : Returns an xml file that contains all shard time information. |
| − | ===Cache duration=== | + | ====Cache duration==== |
The data is cached for 1 minute. | The data is cached for 1 minute. | ||
| − | = | + | ==== XML structure ==== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | === XML structure === | ||
| − | |||
:<syntaxhighlight lang="xml"><shard_time> | :<syntaxhighlight lang="xml"><shard_time> | ||
<server_tick>514105152</server_tick> | <server_tick>514105152</server_tick> | ||
| Line 47: | Line 32: | ||
<cache created="1387437183" expire="1387437243"/> | <cache created="1387437183" expire="1387437243"/> | ||
</shard_time></syntaxhighlight> | </shard_time></syntaxhighlight> | ||
| + | |||
| + | ===PHP interface=== | ||
| + | :<code>ryzom_time_api()</code> : Returns SimpleXMLElement or boolean false on failure. | ||
| + | |||
| + | :<syntaxhighlight lang="php"><?php | ||
| + | require_once "ryzomapi_lite.php"; | ||
| + | |||
| + | $time = ryzom_time_api('xml'); | ||
| + | if ($time !== false) { | ||
| + | $txt_en = htmlspecialchars($time->txt_en); | ||
| + | echo "Atys time is {$txt_en}"; | ||
| + | } else { | ||
| + | echo "API failure"; | ||
| + | } | ||
| + | ?></syntaxhighlight> | ||
| + | |||
| + | <noinclude>[[Category:Ryzom API|Time]]</noinclude> | ||
Latest revision as of 05:29, 15 March 2023
To know the time and date in Ryzom.
Usage
<base URL>/time.php
URL Parameters
- format
- (optional), defaults ro raw.
raw: Returns the tick. The server tick is a 32 bit integer that increases by one every 100 milliseconds.txt: Returns a homine-readable string.xml: Returns an xml file that contains all shard time information.
Cache duration
The data is cached for 1 minute.
XML structure
<shard_time> <server_tick>514105152</server_tick> <jena_year>2576</jena_year> <day_of_jy>319</day_of_jy> <month_of_jy>10</month_of_jy> <cycle>0</cycle> <day_of_cycle>319</day_of_cycle> <month_of_cycle>10</month_of_cycle> <day_of_month>19</day_of_month> <day_of_week>1</day_of_week> <season>3</season> <day_of_season>49</day_of_season> <time_of_day>13</time_of_day> <txt_en>13h - Dua, Mystia 20, 1st AC 2576</txt_en> <txt_fr>13h - Dua, Mystia 20, 1er CA 2576</txt_fr> <txt_de>13h - Dua, Mystia 20, 1. AZ 2576</txt_de> <cache created="1387437183" expire="1387437243"/> </shard_time>
PHP interface
ryzom_time_api(): Returns SimpleXMLElement or boolean false on failure.
<?php require_once "ryzomapi_lite.php"; $time = ryzom_time_api('xml'); if ($time !== false) { $txt_en = htmlspecialchars($time->txt_en); echo "Atys time is {$txt_en}"; } else { echo "API failure"; } ?>
