Animations API - Geocube101/Iota-Modular-Jump-Gates GitHub Wiki
This mod has a animations API for defining and adding custom jump gate animations
The current Animation API Version is 1.0
Installing the Animation API
The animation API can be found here: "https://github.com/Geocube101/Iota-Modular-Jump-Gates/tree/ed3eff005e5f01693b977b932e3a2de1ffc8f3aa/Iota%20Modular%20Jump%20Gates/API"
This contains all the wrapper code and classes to access the API. Simply copy the entire "AnimationAPI" folder into your mod or project folder.
Using the Animation API
The Animation API Session
The animation API's session holds some information about the animation API version but for the most part holds very little functionality
Animations can be added through it and that's about it.
Unless its guaranteed your mod will load after mine, the best bet for properly initializing the animation API is calling MyAnimationAPISession.Init(IMyModContext)
within your session's BeforeStart
method. This allows time for my mod to begin listening for API connections.
Animation API Updates
Like the mod API, the Animation API has a system in-place to validate whether the used version of the API matches or is supported by this mod.
Check the log for information on whether the animation API in your mod needs to be updated along with whether your mod has successfully connected to the API.
Extra Notes
All classes and properties are commented to make their purpose easier to understand. For examples of animations, see the Animations Folder