com.fs.starfarer.api.campaign

Interface CampaignClockAPI

public interface CampaignClockAPI

Method Summary

Modifier and Type	Method and Description
float	convertToDays(float realSeconds)
float	convertToMonths(float realSeconds)
float	convertToSeconds(float days)
CampaignClockAPI	createClock(long timestamp) New clock based on the timestamp.
java.util.GregorianCalendar	getCal() Returns the game calender using the Java.util.GregorianCalendar
int	getCycle() Displays the current year cycle.
java.lang.String	getCycleString() Gets the cycle number in a string format Example: Returns 206
java.lang.String	getDateString() Outputs the current date in a string format.
int	getDay() Get the day since game start.
float	getElapsedDaysSince(long timestamp) Gets the time elasped after the specified timestamp.
int	getHour() Gives the hour of the day.
int	getMonth() 1 = January, 12 = December.
java.lang.String	getMonthString() Outputs the current in game month as a full string.
float	getSecondsPerDay()
java.lang.String	getShortDate() Gets the short date in the format of cYYY.MM.DD.
java.lang.String	getShortMonthString() Returns short hand string of the in game month.
long	getTimestamp() Gets the timestamp of the current date as a 14 digit, negative signed long number.

Method Detail

getCycle

int getCycle()

Displays the current year cycle. Example: outputs 206

Returns:

int value

getMonth

int getMonth()

1 = January, 12 = December.

Returns:

int value

getDay

int getDay()

Get the day since game start. If game started 4 in-game days ago, it will return 4.0. Example: Global.getSector().getClock().getDay()

Returns:

int value

getHour

int getHour()

Gives the hour of the day. Example: outputs 3 if 3rd hour of day.

Returns:

int value

convertToDays

float convertToDays(float realSeconds)

convertToMonths

float convertToMonths(float realSeconds)

getTimestamp

long getTimestamp()

Gets the timestamp of the current date as a 14 digit, negative signed long number. March 2, c206 is -55661253120000. Example: Global.getSector().getClock().getTimestamp()

Returns:

long value

getElapsedDaysSince

float getElapsedDaysSince(long timestamp)

Gets the time elasped after the specified timestamp. Example: Returns the time in float time. If partial day, it will return 0.5966898.

Returns:

float value

getMonthString

java.lang.String getMonthString()

Outputs the current in game month as a full string.

Returns:

String value

getShortMonthString

java.lang.String getShortMonthString()

Returns short hand string of the in game month. Example: Mar for March, Jun for June.

Returns:

String value

getSecondsPerDay

float getSecondsPerDay()

createClock

CampaignClockAPI createClock(long timestamp)

New clock based on the timestamp.

Parameters:

timestamp -

Returns:

getDateString

java.lang.String getDateString()

Outputs the current date in a string format. Example: output is Mar 2, c206.

Returns:

String value

convertToSeconds

float convertToSeconds(float days)

getShortDate

java.lang.String getShortDate()

Gets the short date in the format of cYYY.MM.DD. Example: Returns 206.3.3

Returns:

string value

getCycleString

java.lang.String getCycleString()

Gets the cycle number in a string format Example: Returns 206

Returns:

string value

getCal

java.util.GregorianCalendar getCal()

Returns the game calender using the Java.util.GregorianCalendar

Returns:

Java.util.GregorianCalendar[]