You are viewing a potentially older version of this package. View all versions.
misterj05-LSTAPI-0.1.4 icon

LSTAPI

An API for synchronizing time related mods to a central source.

Date uploaded a year ago
Version 0.1.4
Download link misterj05-LSTAPI-0.1.4.zip
Downloads 9783
Dependency string misterj05-LSTAPI-0.1.4

This mod requires the following mods to function

NotNet-GDWeave-2.0.14 icon
NotNet-GDWeave

Mod loader & runtime script patching for Godot

Preferred version: 2.0.14
PuppyGirl-TackleBox-0.5.2 icon
PuppyGirl-TackleBox

A mod menu for WEBFISHING and config API for mod devs!

Preferred version: 0.5.2

README

LSTAPI

The LonelyStars TimeAPI, made for WEBFISHING.

A mod API for synchronizing time related mods to a central source.

The Problem

Right now WEBFISHING mods related to time rely on using the users real life time to remain synced with one another, the instant one tries to use an in-game time cycle the whole ship breaks apart. This fixes that.

The Solution

Making one mod serve as the pseudo time that all others follow keeps them all synced to one source instead of each making up their own and therefore aren't synced with one another.

Further Detailed Information

For more in-depth information regarding the Mod, User Config, Mod Author Instructions and Code Examples check out the Wiki.

CHANGELOG

0.1.5

  • Added multiplayer sync support.
    • Both the player AND the host need to have the new "Multiplayer Sync" option enabled for sync to happen.
    • If the "Multiplayer Sync" option is disabled the mod makes ZERO Steam API calls, I wanted to make sure if you didn't want multiplayer sync that this was the case for security/privacy reasons.
    • To Mod Authors: To become multiplayer compatible all your mod needs to do is to react to LSTAPI's "time_has_jumped" signal and update your mod's state in accordance to it. If you need further docs check out the Wiki.
    • This is still not entirely tested so please report issues if you encounter them.
  • The mod's icon now displays in the TackleBox menu.

0.1.4

  • Reimplement seconds into the API.
    • second_has_passed signal added.
    • get_second function added.

0.1.3

  • Fix overflowed time values being passed on signal emission.

0.1.2

  • Hot-reloading for config changes.
  • Enforce static types on the time variables for a slight performance boost.
  • New signal: time_has_jumped. Will be useful for the future multiplayer integration, for further information check out the Wiki.
  • Removed unneeded get_config() function. You can just grab the config once you already have the node via ".config".

0.1.1

  • 2 new functions: get_hour() and get_minute(). For those who don't like working with dictionaries, you can now work with the hour and minute as ints.
  • The time dictionary is now passed on signal emission. See updated examples in the Wiki.

0.1.0

  • Initial Release