com.fs.starfarer.api.campaign.CampaignClockAPI Interface Reference

Public Member Functions
int	getCycle ()
int	getMonth ()
int	getDay ()
int	getHour ()
float	convertToDays (float realSeconds)
float	convertToMonths (float realSeconds)
long	getTimestamp ()
float	getElapsedDaysSince (long timestamp)
String	getMonthString ()
String	getShortMonthString ()
float	getSecondsPerDay ()
CampaignClockAPI	createClock (long timestamp)
String	getDateString ()
float	convertToSeconds (float days)
String	getShortDate ()
String	getCycleString ()
GregorianCalendar	getCal ()

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 11 of file CampaignClockAPI.java.

Member Function Documentation

convertToDays()

float com.fs.starfarer.api.campaign.CampaignClockAPI.convertToDays

(

float

realSeconds

)

convertToMonths()

float com.fs.starfarer.api.campaign.CampaignClockAPI.convertToMonths

(

float

realSeconds

)

convertToSeconds()

float com.fs.starfarer.api.campaign.CampaignClockAPI.convertToSeconds

(

float

days

)

createClock()

CampaignClockAPI com.fs.starfarer.api.campaign.CampaignClockAPI.createClock

(

long

timestamp

)

New clock based on the timestamp.

Parameters

timestamp

Returns

getCal()

GregorianCalendar com.fs.starfarer.api.campaign.CampaignClockAPI.getCal

(

)

getCycle()

int com.fs.starfarer.api.campaign.CampaignClockAPI.getCycle

(

)

getCycleString()

String com.fs.starfarer.api.campaign.CampaignClockAPI.getCycleString

(

)

getDateString()

String com.fs.starfarer.api.campaign.CampaignClockAPI.getDateString

(

)

getDay()

int com.fs.starfarer.api.campaign.CampaignClockAPI.getDay

(

)

getElapsedDaysSince()

float com.fs.starfarer.api.campaign.CampaignClockAPI.getElapsedDaysSince

(

long

timestamp

)

getHour()

int com.fs.starfarer.api.campaign.CampaignClockAPI.getHour

(

)

getMonth()

int com.fs.starfarer.api.campaign.CampaignClockAPI.getMonth

(

)

1 = January, 12 = December.

Returns

getMonthString()

String com.fs.starfarer.api.campaign.CampaignClockAPI.getMonthString

(

)

getSecondsPerDay()

float com.fs.starfarer.api.campaign.CampaignClockAPI.getSecondsPerDay

(

)

getShortDate()

String com.fs.starfarer.api.campaign.CampaignClockAPI.getShortDate

(

)

getShortMonthString()

String com.fs.starfarer.api.campaign.CampaignClockAPI.getShortMonthString

(

)

getTimestamp()

long com.fs.starfarer.api.campaign.CampaignClockAPI.getTimestamp

(

)

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/campaign/CampaignClockAPI.java