About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class TimeSpan

Represents a time interval.

Hierarchy (View Summary)

System.Object
- TimeSpan

Index

Constructors

Accessors

Days Hours Milliseconds Minutes Seconds Ticks TotalDays TotalHours TotalMilliseconds TotalMinutes TotalSeconds

Methods

Cast Equals GetHashCode ToString TryCast Equals

Constructors

constructor

new TimeSpan(
    hours: number | Int32,
    minutes: number | Int32,
    seconds: number | Int32,
): TimeSpan
Initializes a new instance of the System.TimeSpan structure to a specified number of hours, minutes, and seconds.
Parameters
- hours: number | Int32
  Number of hours.
- minutes: number | Int32
  Number of minutes.
- seconds: number | Int32
  Number of seconds.
Returns TimeSpan
Overrides Object.constructor

Accessors

Days

get Days(): number
Gets the days component of the time interval represented by the current System.TimeSpan structure.

Returns number
The day component of this instance. The return value can be positive or negative.

Hours

get Hours(): number
Gets the hours component of the time interval represented by the current System.TimeSpan structure.

Returns number
The hour component of the current System.TimeSpan structure. The return value ranges from -23 through 23.

Milliseconds

get Milliseconds(): number
Gets the milliseconds component of the time interval represented by the current System.TimeSpan structure.

Returns number
The millisecond component of the current System.TimeSpan structure. The return value ranges from -999 through 999.

Minutes

get Minutes(): number
Gets the minutes component of the time interval represented by the current System.TimeSpan structure.

Returns number
The minute component of the current System.TimeSpan structure. The return value ranges from -59 through 59.

Seconds

get Seconds(): number
Gets the seconds component of the time interval represented by the current System.TimeSpan structure.

Returns number
The second component of the current System.TimeSpan structure. The return value ranges from -59 through 59.

Ticks

get Ticks(): number
Gets the number of ticks that represent the value of the current System.TimeSpan structure.

Returns number
The number of ticks contained in this instance.

TotalDays

get TotalDays(): number
Gets the value of the current System.TimeSpan structure expressed in whole and fractional days.

Returns number
The total number of days represented by this instance.

TotalHours

get TotalHours(): number
Gets the value of the current System.TimeSpan structure expressed in whole and fractional hours.

Returns number
The total number of hours represented by this instance.

TotalMilliseconds

get TotalMilliseconds(): number
Gets the value of the current System.TimeSpan structure expressed in whole and fractional milliseconds.

Returns number
The total number of milliseconds represented by this instance.

TotalMinutes

get TotalMinutes(): number
Gets the value of the current System.TimeSpan structure expressed in whole and fractional minutes.

Returns number
The total number of minutes represented by this instance.

TotalSeconds

get TotalSeconds(): number
Gets the value of the current System.TimeSpan structure expressed in whole and fractional seconds.

Returns number
The total number of seconds represented by this instance.

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals