ScriptWorldClock Interface Reference

Public Member Functions
proto external void	SetTimeOfDay (float hours24)
	Sets current time of the day as <0.0, 24.0> hours.
proto external float	GetTimeOfDay ()
	Returns current time of the day as <0.0, 24.0> hours.
proto external void	SetMonth (int month_1_12)
	Sets the month in 1...12 range.
proto external int	GetMonth ()
	Gets the month in 1...12 range.
proto external void	SetYear (int year)
	Sets the year (0 = 0AD).
proto external int	GetYear ()
	Gets the year (0 = 0AD).
proto external void	SetDay (int day_1_31)
	Sets the day of the month in 1...31 range.
proto external int	GetDay ()
	Gets the day of the month in 1...31 range.
proto external void	SetDayInYear (int dayInYear_1_371)
	Sets the day of the month in 1...371 range.
proto external int	GetDayInYear ()
	Gets the day of the month in 1...371 range.

Member Function Documentation

GetDay()

proto external int ScriptWorldClock.GetDay

(

)

Gets the day of the month in 1...31 range.

GetDayInYear()

proto external int ScriptWorldClock.GetDayInYear

(

)

Gets the day of the month in 1...371 range.

GetMonth()

proto external int ScriptWorldClock.GetMonth

(

)

Gets the month in 1...12 range.

GetTimeOfDay()

proto external float ScriptWorldClock.GetTimeOfDay

(

)

Returns current time of the day as <0.0, 24.0> hours.

GetYear()

proto external int ScriptWorldClock.GetYear

(

)

Gets the year (0 = 0AD).

SetDay()

proto external void ScriptWorldClock.SetDay

(

int

day_1_31

)

Sets the day of the month in 1...31 range.

SetDayInYear()

proto external void ScriptWorldClock.SetDayInYear

(

int

dayInYear_1_371

)

Sets the day of the month in 1...371 range.

SetMonth()

proto external void ScriptWorldClock.SetMonth

(

int

month_1_12

)

Sets the month in 1...12 range.

SetTimeOfDay()

proto external void ScriptWorldClock.SetTimeOfDay

(

float

hours24

)

Sets current time of the day as <0.0, 24.0> hours.

Can only be set by the authority (server, singleplayer...).

SetYear()

proto external void ScriptWorldClock.SetYear

(

int

year

)

Sets the year (0 = 0AD).

---

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

• GameLib/generated/ScriptWorldClock.c