- Found in:
- Vanilla
floatfunctionExpiryDay(floatDaysFromNow, PlanetLocalPlanet=NONE, floatMaxUniversalDays=-1, floatFutureStartDay=-1)Global
Description
Documentation Comment
returns a float representing days in the future from now (in terms of GameDaysPassed - where 1 = 24 hours)
DaysFromNow: how many days in the future should the expiration date be?
LocalPlanet: (optional, ignored if none) will scale DaysFromNow so that it will reflect local day length on planet is if different than universal 24 standard
MaxUniversalDays: (optional, ignored if <= 0) - no matter the local day length scale, this is the max (24 hour) days you want to add - useful for tidally locked planets, or planets with exceptionally long days
FutureStartDay: (optional, ignored if < GameDaysPassed) - the start day to add DaysFromNow to.
Parameters
floatDaysFromNow
PlanetLocalPlanet=NONE
floatMaxUniversalDays=-1
floatFutureStartDay=-1
Examples
Auto-Generated Example
float myFloat__DaysFromNow
Planet myPlanet__LocalPlanet
float myFloat__MaxUniversalDays
float myFloat__FutureStartDay
float returnedValue = Utility.ExpiryDay(myFloat__DaysFromNow, myPlanet__LocalPlanet, myFloat__MaxUniversalDays, myFloat__FutureStartDay)