tgstation-server 6.12.3
The /tg/station 13 server suite
Loading...
Searching...
No Matches
Instance.cs
Go to the documentation of this file.
1using System.ComponentModel.DataAnnotations;
2
4{
8 public abstract class Instance : NamedEntity
9 {
13 [Required]
14 [RequestOptions(FieldPresence.Required, PutOnly = true)]
15 public string? Path { get; set; }
16
20 [Required]
21 [RequestOptions(FieldPresence.Ignored, PutOnly = true)]
22 public bool? Online { get; set; }
23
27 [Required]
28 [EnumDataType(typeof(ConfigurationType))]
30
35 [Required]
36 public uint? AutoUpdateInterval { get; set; }
37
42 [Required]
43 [StringLength(Limits.CronStringLength)]
44 public string? AutoUpdateCron { get; set; }
45
49 [Required]
50 public ushort? ChatBotLimit { get; set; }
51
56 [Required]
57 [StringLength(Limits.CronStringLength)]
58 public string? AutoStartCron { get; set; }
59
64 [Required]
65 [StringLength(Limits.CronStringLength)]
66 public string? AutoStopCron { get; set; }
67 }
68}
Metadata about a server instance.
Definition Instance.cs:9
string? AutoStartCron
A cron expression indicating when the game server should start. Must be a valid 6 part cron schedule ...
Definition Instance.cs:58
bool? Online
If the Instance is online.
Definition Instance.cs:22
string? Path
The path to where the Instance is located. Can only be changed while the Instance is offline....
Definition Instance.cs:15
string? AutoUpdateCron
A cron expression indicating when auto-updates should trigger. Must be a valid 6 part cron schedule (...
Definition Instance.cs:44
ushort? ChatBotLimit
The maximum number of chat bots the Instance may contain.
Definition Instance.cs:50
string? AutoStopCron
A cron expression indicating when the game server should stop. Must be a valid 6 part cron schedule (...
Definition Instance.cs:66
uint? AutoUpdateInterval
The time interval in minutes the repository is automatically pulled and compiles. 0 disables.
Definition Instance.cs:36
Sanity limits to prevent users from overloading.
Definition Limits.cs:9
const int CronStringLength
Length limit for cron strings in fields.
Definition Limits.cs:18
Base class for named entities.
Definition NamedEntity.cs:9
FieldPresence
Indicates whether a request field is Required or Ignored.
ConfigurationType
The type of configuration allowed on an Instance.
@ Required
DMAPI validation must suceed for the deployment to succeed.