Star Tenon Time API

这是一个方便的时间 API，提供了游戏内时间管理的统一接口。

Time

Time 类是时间系统的核心 API，提供了时间管理的统一接口。

Time 类文档

概述

Time 类是一个用于处理时间相关的工具类，提供了获取计算机时间、本地时区时间以及游戏时间的功能。

getComputerTime()

获取当前计算机时间，这将会返回按照 GMT 0000 时区计算的时间：

const currentTime = Time.getComputerTime();
console.log(currentTime);

getLocalTime(i: number)

获取不同时区的计算机时间：

• 参数:
  • i: number - 从标准时间开始增加或减少的小时数
• 返回值: Date - 指定时区的本地时间
• 示例:

console.log("标准时间：" + Time.getComputerTime());
console.log("北京时间（UTC +8）：" + Time.getLocalTime(8));
console.log("美国太平洋标准时间：" + Time.getLocalTime(-8));

getGameTime()

获取当前游戏时间：

• 返回值: number - 当前游戏时间
• 示例:

const gameTime = Time.getGameTime();
console.log("当前游戏时间：" + gameTime);

getGameTimeSpec()

获取当前游戏时间段：

• 返回值: TimeSpec - 游戏时间段枚举值

try {
  const timeSpec = Time.getGameTimeSpec();
  console.log("当前游戏时间段：" + timeSpec);
} catch (error) {
  console.error(error);
}

TimeSpec

TimeSpec 枚举定义了时间规范的常量，用于标准化时间单位：

• TimeSpec.MORNING: 早晨时间段
• TimeSpec.NOON: 中午时间段
• TimeSpec.SUNSET: 日落时间段
• TimeSpec.NIGHT: 夜晚时间段
• TimeSpec.SUNRISE: 日出时间段

Tick 与 Second

这两个类类提供游戏刻（tick）与秒的时间转换功能：

Tick.toSecond(20)  // 将提供的游戏刻转换为秒
Second.toTick(1)  // 将提供的秒转换为游戏刻

支持版本

本 API 支持任意可以运行 Script API v2.0.0+ 的游戏版本，包括：

• 1.21.90；
• 1.21.100；
• 1.21.110；
• 以及更多……

注意：本包理论上可以在部分更旧的版本上运作，但未经过严格的测试。

协议

本项目使用 MIT License 授权：

The MIT License (MIT)

Copyright © 2025 CTN Studios

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.