dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Script: Add date methods for getting time in minutes

Browse Source
This commit is contained in:
Jonathan G Rennison
2020-10-29 17:47:05 +00:00
parent 5556ef38b0
commit f094518f8e
3 changed files with 67 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/script-additions.html
View File

@@ -10,7 +10,7 @@
table { border-collapse: collapse; empty-cells: show; } table { border-collapse: collapse; empty-cells: show; }
.code { font-family: "Courier New", Courier, mono; color: darkgreen; } .code { font-family: "Courier New", Courier, mono; color: darkgreen; }
.methodtext{ margin-left: 3em; } .methodtext{ margin-left: 3em; }
.indent { margin-left: 1em; } .indent { margin-left: 1em; margin-bottom: 0.5em; }
dt { font-weight: bold; } dt { font-weight: bold; }
</style> </style>
</head> </head>
@@ -27,7 +27,33 @@
<h4>Additional Static Public Member Functions:</h4> <h4>Additional Static Public Member Functions:</h4>
<div class="indent"> <div class="indent">
<div class="code">static int32 GetDayLengthFactor ()</div> <div class="code">static int32 GetDayLengthFactor ()</div>
<div class="methodtext">Get current day length factor</div> <div class="methodtext">Get current day length factor.</div>
</div>
<div class="indent">
<div class="code">static bool IsTimeShownInMinutes ()</div>
<div class="methodtext">Get whether time is shown in minutes in the game settings.</div>
<div class="methodtext">This ignores the "Use client time settings instead of savegame time settings" setting.</div>
</div>
<div class="indent">
<div class="code">static int32 GetTicksPerMinute ()</div>
<div class="methodtext">Get the ticks per minutes in the game settings.</div>
<div class="methodtext">This ignores the "Use client time settings instead of savegame time settings" setting.</div>
</div>
<div class="indent">
<div class="code">static DateTicksScaled GetCurrentScaledDateTicks ()</div>
<div class="methodtext">Get the current scaled date ticks.</div>
<div class="methodtext">This increments at the same rate regardless of the day length factor.</div>
<div class="methodtext">Changing the day length factor will also change this value.</div>
</div>
<div class="indent">
<div class="code">static int32 GetHour (DateTicksScaled ticks)</div>
<div class="methodtext">Get the hour of the given scaled date ticks value.</div>
<div class="methodtext">This ignores the "Use client time settings instead of savegame time settings" setting.</div>
</div>
<div class="indent">
<div class="code">static int32 GetMinute (DateTicksScaled ticks)</div>
<div class="methodtext">Get the minute of the given scaled date ticks value.</div>
<div class="methodtext">This ignores the "Use client time settings instead of savegame time settings" setting.</div>
</div> </div>
</div> </div>
@@ -36,8 +62,8 @@
<h4>Additional Static Public Member Functions:</h4> <h4>Additional Static Public Member Functions:</h4>
<div class="indent"> <div class="indent">
<div class="code">static bool BuildRiver (TileIndex tile)</div> <div class="code">static bool BuildRiver (TileIndex tile)</div>
<div class="methodtext">Builds a river on tile (subject to permissions/settings)</div> <div class="methodtext">Builds a river on tile (subject to permissions/settings).</div>
<div class="methodtext">All other details are the same as BuildCanal</div> <div class="methodtext">All other details are the same as BuildCanal.</div>
</div> </div>
</div> </div>
</body> </body>

27
src/script/api/script_date.cpp
View File

@@ -72,3 +72,30 @@
time(&t); time(&t);
return t; return t;
} }
/* static */ bool ScriptDate::IsTimeShownInMinutes()
{
return _settings_game.game_time.time_in_minutes;
}
/* static */ int32 ScriptDate::GetTicksPerMinute()
{
return _settings_game.game_time.ticks_per_minute;
}
/* static */ DateTicksScaled ScriptDate::GetCurrentScaledDateTicks()
{
return _scaled_date_ticks;
}
/* static */ int32 ScriptDate::GetHour(DateTicksScaled ticks)
{
Minutes minutes = (ticks / _settings_game.game_time.ticks_per_minute) + _settings_game.game_time.clock_offset;
return MINUTES_HOUR(minutes);
}
/* static */ int32 ScriptDate::GetMinute(DateTicksScaled ticks)
{
Minutes minutes = (ticks / _settings_game.game_time.ticks_per_minute) + _settings_game.game_time.clock_offset;
return MINUTES_MINUTE(minutes);
}

10
src/script/api/script_date.hpp
View File

@@ -89,6 +89,16 @@ public:
* @note This uses the clock of the host system, which can skew or be set back. Use with caution. * @note This uses the clock of the host system, which can skew or be set back. Use with caution.
*/ */
static int32 GetSystemTime(); static int32 GetSystemTime();
static bool IsTimeShownInMinutes();
static int32 GetTicksPerMinute();
static DateTicksScaled GetCurrentScaledDateTicks();
static int32 GetHour(DateTicksScaled ticks);
static int32 GetMinute(DateTicksScaled ticks);
}; };
#endif /* SCRIPT_DATE_HPP */ #endif /* SCRIPT_DATE_HPP */