Class InitialSpawnManager

Class that handles giving players choices where they would like to initially spawn. Provides two sets: procedurally generated spots, based on clusters of resources, and settlements that are accepting new citizens.

Inheritance
System.Object
InitialSpawnManager
Namespace: Eco.Gameplay.Civics.Immigration
Assembly: Eco.Gameplay.dll
Syntax
[ChatCommandHandler]
public class InitialSpawnManager : Singleton<InitialSpawnManager>, IController, IViewController, IHasUniversalID, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions

Constructors

InitialSpawnManager()

Declaration
public InitialSpawnManager()

Fields

UpdatedInitialPoints

Invoked when the initial points are regenerated.

Declaration
public ThreadSafeAction UpdatedInitialPoints
Field Value
Type Description
ThreadSafeAction

UpdateTimer

Declaration
public PeriodicUpdateConfig UpdateTimer
Field Value
Type Description
PeriodicUpdateConfig

Properties

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

DescribePoints

Describes the points available for initial spawn.

Declaration
public LocString DescribePoints { get; }
Property Value
Type Description
LocString

Subscriptions

Declaration
public ref ThreadSafeSubscriptions Subscriptions { get; }
Property Value
Type Description
ThreadSafeSubscriptions

SummaryPoints

Declaration
public LocString SummaryPoints { get; }
Property Value
Type Description
LocString

Methods

Do(IChatClient, User)

Declaration
[ChatSubCommand]
public static void Do(IChatClient chatClient, User user = null)
Parameters
Type Name Description
IChatClient chatClient
User user

GenerateAllSpawnPoints(Boolean)

Generates spawn points. If DisplayOnlySettlements (in the configuration) is true and there are settlements this method will generate only settlements points

Declaration
public void GenerateAllSpawnPoints(bool debugPoints = false)
Parameters
Type Name Description
System.Boolean debugPoints

GetSpawnPoints()

Called by the client to get the updated spawn points.

Declaration
public IEnumerable<InitialSpawnPoint> GetSpawnPoints()
Returns
Type Description
System.Collections.Generic.IEnumerable<InitialSpawnPoint>

InitialSpawn(IChatClient)

Declaration
[ChatCommand]
public static void InitialSpawn(IChatClient chatClient)
Parameters
Type Name Description
IChatClient chatClient

List(IChatClient)

Declaration
[ChatSubCommand]
public static void List(IChatClient chatClient)
Parameters
Type Name Description
IChatClient chatClient

SetUpdateRequired()

Declaration
public void SetUpdateRequired()

StartHere(Player, InitialSpawnPoint)

Called by a player when they want to spawn at a given position.

Declaration
public void StartHere(Player player, InitialSpawnPoint point)
Parameters
Type Name Description
Player player
InitialSpawnPoint point

Tick()

Declaration
public void Tick()

Update(IChatClient)

Declaration
[ChatSubCommand]
public static void Update(IChatClient chatClient)
Parameters
Type Name Description
IChatClient chatClient

UpdateDebug(IChatClient)

Declaration
[ChatSubCommand]
public static void UpdateDebug(IChatClient chatClient)
Parameters
Type Name Description
IChatClient chatClient

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

Extension Methods