Returns how many seconds have passed since the Unix epoch (1 January 1970,
00:00:00), under current UTC time. If provided a table formatted similarly
to that returned by `Library.os.date()`, it will return the number of
seconds since that time instead.

```lua
print(os.time())  --> 1586982482 (ran at approx. April 15th, 2020 at 1:28 PM PST)
print(os.time{
    year=2020, month=4, day=15,  -- Date components
    hour=16, min=28, sec=0  -- Time components
})  --> 1586968080
```


os.time

time

A dictionary table describing a specific time, similar to that
returned by `Library.os.date()`. If not provided, uses the current UTC
time.


Returns how many seconds have passed since the Unix epoch (1 January 1970,
00:00:00) under current UTC time.


Returns the number of seconds from t1 to t2. The difference is computed
assuming that t1 and t2 are correctly casted to the
[time_t](http://en.cppreference.com/w/cpp/chrono/c/time_t) format.


os.difftime

Returns the number of seconds from t1 to t2, assuming the arguments are
correctly casted to the time_t format.


Formats the given `formatString` with date/time information based on the
given time, or if not provided, the value returned by `Library.os.time()`.
The following specifiers (based on the C function strftime) are supported:

<table>
  <thead>
    <tr>
      <th>Specifier</th>
      <th>Meaning</th>
      <th>Example<sup>&dagger;</sup></th>
     </tr>
  </thead>
<tbody>
<tr><td>%a</td><td>Abbreviated weekday name *</td> <td>Wed</td></tr>
<tr><td>%A</td><td>Full weekday name *</td>        <td>Wednesday</td></tr>
<tr><td>%b</td><td>Abbreviated month name *</td>   <td>Sep</td></tr>
<tr><td>%B</td><td>Full month name *</td>          <td>September</td></tr>
<tr><td>%c</td><td>Date and time *</td>            <td>09/16/98 23:48:10</td></tr>
<tr><td>%d</td><td>Day of the month</td>         <td>16</td></tr>
<tr><td>%H</td><td>Hour, using 24-hour clock</td><td>23</td></tr>
<tr><td>%I</td><td>Hour, using 12-hour clock</td><td>11</td></tr>
<tr><td>%j</td><td>Day of year</td>              <td>259</td></tr>
<tr><td>%m</td><td>Month</td>                    <td>09</td></tr>
<tr><td>%M</td><td>Minute</td>                   <td>48</td></tr>
<tr><td>%p</td><td>Either "AM" or "PM"</td>      <td>pm</td></tr>
<tr><td>%S</td><td>Second</td>                   <td>10</td></tr>
<tr><td>%U</td><td>Week number (first Sunday as the first day of week one)</td><td>37</td></tr>
<tr><td>%w</td><td>Weekday</td>                  <td>3</td></tr>
<tr><td>%W</td><td>Week number (first Monday as the first day of week one)</td><td>37</td></tr>
<tr><td>%x</td><td>Date *</td>                     <td>09/16/98</td></tr>
<tr><td>%X</td><td>Time *</td>                     <td>23:48:10</td></tr>
<tr><td>%y</td><td>Two-digit year</td>           <td>98</td></tr>
<tr><td>%Y</td><td>Full year</td>                <td>1998</td></tr>
<tr><td>%z</td><td>ISO 8601 offset from UTC in timezone (1 minute = 1, 1 hour = 100)</td><td>-0400</td></tr>
<tr><td>%Z</td><td>Timezone name or abbreviation *</td><td>Eastern Daylight Time</td></tr>
<tr><td>%%</td><td>The % character</td>          <td>%</td></tr>
</tbody>
</table>

\* This value can vary depending on the current locale.

&dagger; The example provided is for September 16th, 1998 (a Wednesday) at
11:48:10 PM (23:48:10), ran using locale "en-us" in Eastern Time (ET).

If the provided `formatString` is exactly `"*t"` (local time) or `"!*t"`
(UTC time), this function instead returns a dictionary containing the
following components, which are normally available in the specifiers
above.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
<tbody>
  <tr>
    <td>year</td>
    <td>int</td>
    <td>An integer that describes the current year of the Current Era (ex. 2017)</td>
  </tr>
  <tr>
    <td>month</td>
    <td>int</td>
    <td>An integer between 1 and 12 (starting from January) that describes the current month.</td>
  </tr>
  <tr>
    <td>wday</td>
    <td>int</td>
    <td>An integer between 1 and 7 (starting from Sunday) that describes the current week day.</td>
  </tr>
  <tr>
    <td>yday</td>
    <td>int</td>
    <td>An integer between 1 and 366 describing how many days we are into the year.<br />There can be 366 days if it is a leap year.</td>
  </tr>
  <tr>
    <td>day</td>
    <td>int</td>
    <td>An integer between 1 and 31 describing the current day of the month.</td>
  </tr>
  <tr>
    <td>hour</td>
    <td>int</td>
    <td>An integer between 1 and 24 describing the current hour of the day.</td>
  </tr>
  <tr>
    <td>min</td>
    <td>int</td>
    <td>An integer between 0 and 59 describing the current minute of the hour.</td>
  </tr>
  <tr>
    <td>sec</td>
    <td>int</td>
    <td>An integer between 0 and 60 describing the current second of the hour.<br />(60 because the function is described to indicate leap seconds, but in practice it probably doesn't).</td>
  </tr>
  <tr>
    <td>isdst</td>
    <td>bool</td>
    <td>A boolean describing if daylight savings time is currently active.</td>
  </tr>
</tbody>
</table>


os.date

formatString

Formats the given string with date/time information based on the given
time (or if not provided, the value returned by os.time).


Returns the amount of CPU time used by Lua in seconds. This value has high
precision, about 1 microsecond, and is intended for use in benchmarking.

```lua
-- Record the initial time:
local startTime = os.clock()
-- Do something you want to measure the performance of:
local a, b = 0, 1
for i = 1, 5000000 do
    a, b = b, a
end
-- Measure amount of time this took:
local deltaTime = os.clock() - startTime
print("Elapsed time: " .. deltaTime)
-->  Elapsed time: 0.044425600033719 (actual number may vary)
```


os.clock

Returns a high-precision amount of CPU time used by Lua in seconds,
intended for use in benchmarking.


This library provides functions related to time and date.


Overview

Guides

Reference

Resources

Design

Engine

Cloud

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Managing API Keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This grants the ability to publish messages on behalf of users.

This operation grants access to publish new versions of experiences to Roblox.

This enables Single Sign-On functionality

This grants access to read your profile information

Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Learn how to create successful content on Roblox with comprehensive guides, code samples, reference, and tutorials.


{pageTitle} | {SiteName}

Unable to add to inventory

The code sample {title} has been added to your Inventory.

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

os

Summary

Functions

Functions

time

Parameters

Returns

difftime

Parameters

Returns

date

Parameters

Returns

clock

Returns