API ReferenceSandbox.Services

Jamclass

A game jam: the theme, the schedule, the categories and their prizes, and the package query that lists the entries. Read-only. Voting lives in the menu.

objectJam
Namespace
Sandbox.Services
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Services.Jam

Constructors1

Showing 1 constructors

public Jam()PUBLICCONSTRUCTOR

Methods2

Showing 2 methods

public static System.Threading.Tasks.Task`1<Sandbox.Services.Jam> Get(string ident)PUBLICSTATIC

One jam by its url name, e.g. "three". Null if it doesn't exist or isn't public yet.

ParameterTypeDescription
identstring
Returns:Task<Jam>

public static System.Threading.Tasks.Task`1<Sandbox.Services.Jam> GetActive()PUBLICSTATIC

The jam that is on right now: teased, running, or crowned within the last week. Null between jams. Cached for a few minutes, and falls back to the last copy on disk if the backend is unreachable.

Returns:Task<Jam>

Properties26

Showing 26 properties

public bool Sandbox.Services.Jam.AcceptingEntries { get; set; }PUBLICGETSET

True while entries can still be submitted.

Returns:bool

public System.Nullable`1<System.DateTimeOffset> Sandbox.Services.Jam.Announced { get; set; }PUBLICGETSET

When the teaser went public. Null when the jam had no teaser phase.

Returns:Nullable<DateTimeOffset>

public Sandbox.Services.Jam.Category[] Sandbox.Services.Jam.Categories { get; set; }PUBLICGETSET

Returns:Category[]

public bool Sandbox.Services.Jam.CommunityVoting { get; set; }PUBLICGETSET

Whether the winners are decided by the players who play the entries.

Returns:bool

public Sandbox.Services.Jam.Phase Sandbox.Services.Jam.CurrentPhase { get; set; }PUBLICGETSET

The step the jam is on right now.

Returns:Phase

public int Sandbox.Services.Jam.CurrentStepIndex { get; set; }PUBLICGETSET

The step in `Sandbox.Services.Jam.Timeline` that is current, or -1 before the first one.

Returns:int

public System.DateTimeOffset Sandbox.Services.Jam.Deadline { get; set; }PUBLICGETSET

Entries close.

Returns:DateTimeOffset

public string Sandbox.Services.Jam.Description { get; set; }PUBLICGETSET

Returns:string

public int Sandbox.Services.Jam.EntryCount { get; set; }PUBLICGETSET

Returns:int

public System.DateTimeOffset Sandbox.Services.Jam.FinalsStart { get; set; }PUBLICGETSET

The first elimination round opens.

Returns:DateTimeOffset

public System.Nullable`1<System.DateTimeOffset> Sandbox.Services.Jam.GrandFinal { get; set; }PUBLICGETSET

The last two go head to head. Null when the jam has no distinct grand final.

Returns:Nullable<DateTimeOffset>

public bool Sandbox.Services.Jam.HasStarted { get; set; }PUBLICGETSET

True once the theme has dropped and entries are open.

Returns:bool

public string Sandbox.Services.Jam.Ident { get; set; }PUBLICGETSET

Short url name, e.g. "three". Stable for the life of the jam.

Returns:string

public bool Sandbox.Services.Jam.IsLive { get; set; }PUBLICGETSET

True from the theme drop until the winners are crowned.

Returns:bool

public Sandbox.Services.Jam.Step Sandbox.Services.Jam.NextStep { get; set; }PUBLICGETSET

The next step to come, or null once the jam is on its last one.

Returns:Step

public System.DateTimeOffset Sandbox.Services.Jam.NominationsEnd { get; set; }PUBLICGETSET

Nominations lock and the finalists are cut.

Returns:DateTimeOffset

public System.DateTimeOffset Sandbox.Services.Jam.Now { get; set; }PUBLICGETSET

The clock this jam was fetched against. Normally the real time, but shifted when `Sandbox.Services.Jam.PreviewDays` is set, so compare dates to this rather than to UtcNow.

Returns:DateTimeOffset

public static int Sandbox.Services.Jam.PreviewDays { get; set; }PUBLICSTATICGETSET

Move the jam clock this many days ahead. Needs an admin account on the backend, for looking at a phase before it happens.

Returns:int

public string Sandbox.Services.Jam.PrizePool { get; set; }PUBLICGETSET

Headline prize figure as it should read, e.g. "£50,000".

Returns:string

public string Sandbox.Services.Jam.Query { get; set; }PUBLICGETSET

Package search query that lists the entries, e.g. "jam:three".

Returns:string

public System.DateTimeOffset Sandbox.Services.Jam.Results { get; set; }PUBLICGETSET

Winners crowned.

Returns:DateTimeOffset

public System.DateTimeOffset Sandbox.Services.Jam.Starts { get; set; }PUBLICGETSET

The theme drop. Building and entries open here.

Returns:DateTimeOffset

public string Sandbox.Services.Jam.Theme { get; set; }PUBLICGETSET

The theme. Null until the jam has started.

Returns:string

public Sandbox.Services.Jam.Step[] Sandbox.Services.Jam.Timeline { get; set; }PUBLICGETSET

The jam's steps in order.

Returns:Step[]

public string Sandbox.Services.Jam.Title { get; set; }PUBLICGETSET

Returns:string

public string Sandbox.Services.Jam.Url { get; set; }PUBLICGETSET

The jam page on the website.

Returns:string

On this page

Constructorspublic Jam()Methodspublic static System.Threading.Tasks.Task`1<Sandbox.Services.Jam> Get(System.String ident)public static System.Threading.Tasks.Task`1<Sandbox.Services.Jam> GetActive()Propertiespublic System.Boolean Sandbox.Services.Jam.AcceptingEntries { get; set; }public System.Nullable`1<System.DateTimeOffset> Sandbox.Services.Jam.Announced { get; set; }public Sandbox.Services.Jam.Category[] Sandbox.Services.Jam.Categories { get; set; }public System.Boolean Sandbox.Services.Jam.CommunityVoting { get; set; }public Sandbox.Services.Jam.Phase Sandbox.Services.Jam.CurrentPhase { get; set; }public System.Int32 Sandbox.Services.Jam.CurrentStepIndex { get; set; }public System.DateTimeOffset Sandbox.Services.Jam.Deadline { get; set; }public System.String Sandbox.Services.Jam.Description { get; set; }public System.Int32 Sandbox.Services.Jam.EntryCount { get; set; }public System.DateTimeOffset Sandbox.Services.Jam.FinalsStart { get; set; }public System.Nullable`1<System.DateTimeOffset> Sandbox.Services.Jam.GrandFinal { get; set; }public System.Boolean Sandbox.Services.Jam.HasStarted { get; set; }public System.String Sandbox.Services.Jam.Ident { get; set; }public System.Boolean Sandbox.Services.Jam.IsLive { get; set; }public Sandbox.Services.Jam.Step Sandbox.Services.Jam.NextStep { get; set; }public System.DateTimeOffset Sandbox.Services.Jam.NominationsEnd { get; set; }public System.DateTimeOffset Sandbox.Services.Jam.Now { get; set; }public static System.Int32 Sandbox.Services.Jam.PreviewDays { get; set; }public System.String Sandbox.Services.Jam.PrizePool { get; set; }public System.String Sandbox.Services.Jam.Query { get; set; }public System.DateTimeOffset Sandbox.Services.Jam.Results { get; set; }public System.DateTimeOffset Sandbox.Services.Jam.Starts { get; set; }public System.String Sandbox.Services.Jam.Theme { get; set; }public Sandbox.Services.Jam.Step[] Sandbox.Services.Jam.Timeline { get; set; }public System.String Sandbox.Services.Jam.Title { get; set; }public System.String Sandbox.Services.Jam.Url { get; set; }Metadata