Show / Hide Table of Contents

Class GameMapPrototype

Prototype data for a game map.

Inheritance
System.Object
GameMapPrototype
Implements
Robust.Shared.Prototypes.IPrototype
Namespace: Content.Server.Maps
Assembly: Content.Server.dll
Syntax
public sealed class GameMapPrototype : object, IPrototype
Remarks

Forks should not directly edit existing parts of this class. Make a new partial for your fancy new feature, it'll save you time later.

Properties

| Improve this Doc View Source

Conditions

The game map conditions that must be fulfilled for this map to be selectable.

Declaration
public IReadOnlyList<GameMapCondition> Conditions { get; }
Property Value
Type Description
IReadOnlyList<GameMapCondition>
| Improve this Doc View Source

Fallback

Controls if the map can be used as a fallback if no maps are eligible.

Declaration
public bool Fallback { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ID

Declaration
public string ID { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

MapName

Name of the map to use in generic messages, like the map vote.

Declaration
public string MapName { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

MapPath

Relative directory path to the given map, i.e. /Maps/saltern.yml

Declaration
public ResPath MapPath { get; }
Property Value
Type Description
Robust.Shared.Utility.ResPath
| Improve this Doc View Source

MaxPlayers

Maximum players for the given map.

Declaration
public uint MaxPlayers { get; }
Property Value
Type Description
System.UInt32
| Improve this Doc View Source

MinPlayers

Minimum players for the given map.

Declaration
public uint MinPlayers { get; }
Property Value
Type Description
System.UInt32
| Improve this Doc View Source

Stations

The stations this map contains. The names should match with the BecomesStation components.

Declaration
public IReadOnlyDictionary<string, StationConfig> Stations { get; }
Property Value
Type Description
IReadOnlyDictionary<System.String, StationConfig>

Implements

Robust.Shared.Prototypes.IPrototype
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾