API Host ScriptDate

ScriptDate

Script date wrapper over DateTimeOffset.

Namespace: AuroraScript.Runtime.Types. Kind: class.

Back to .NET Host API Reference

Overview

Script date wrapper over DateTimeOffset.

Quick Reference

A minimal use of ScriptDate.

var date = new ScriptDate(
    new DateTimeOffset(2026, 8, 19, 0, 0, 0, TimeSpan.Zero));

Console.WriteLine(date.Format("yyyy-MM-dd")); // 2026-08-19

Constructors

ScriptDate(DateTime date)

Creates a ScriptDate instance.

ScriptDate(DateTime date)

Parameters

Name	Type	Required	Description
date	DateTime	Yes	Date value to wrap.

Returns

A new ScriptDate instance.

ScriptDate(DateTimeOffset dateTimeOffset)

Creates a ScriptDate instance.

ScriptDate(DateTimeOffset dateTimeOffset)

Parameters

Name	Type	Required	Description
dateTimeOffset	DateTimeOffset	Yes	Date and offset to wrap.

Returns

A new ScriptDate instance.

ScriptDate(long ticks)

Creates a ScriptDate instance.

ScriptDate(long ticks)

Parameters

Name	Type	Required	Description
ticks	long	Yes	Date ticks to wrap.

Returns

A new ScriptDate instance.

Properties

DateTime

DateTimeOffset DateTime

Parameters

None.

Returns

Returns DateTimeOffset.

Year

Calendar year.

int Year

Parameters

None.

Returns

Returns int.

Month

Calendar month.

int Month

Parameters

None.

Returns

Returns int.

Day

Day of the month.

int Day

Parameters

None.

Returns

Returns int.

Hour

Hour component.

int Hour

Parameters

None.

Returns

Returns int.

Minute

Minute component.

int Minute

Parameters

None.

Returns

Returns int.

Second

Second component.

int Second

Parameters

None.

Returns

Returns int.

Millisecond

Millisecond component.

int Millisecond

Parameters

None.

Returns

Returns int.

DayOfWeek

Day of the week.

DayOfWeek DayOfWeek

Parameters

None.

Returns

Returns DayOfWeek.

DayOfYear

One-based day of the year.

int DayOfYear

Parameters

None.

Returns

Returns int.

Ticks

Underlying date ticks.

long Ticks

Parameters

None.

Returns

Returns long.

Methods

Format

string Format(string format = null)

Parameters

Name	Type	Required	Description
format	string	No	The string parameter required by the signature.

Returns

Returns string.