Class Cartel

Namespace

S1API.Cartel

Assembly

S1API.dll

Provides access to Cartel status and state information. Wraps the game's Cartel singleton to provide a modder-friendly API.

public sealed class Cartel

Inheritance

object

Cartel

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

GoonPool

Gets the goon manager for spawning and controlling cartel goons. Returns null if the goon pool is not available.

public GoonManager? GoonPool { get; }

Property Value

GoonManager

HoursSinceStatusChange

The number of hours since the Cartel status last changed.

public int HoursSinceStatusChange { get; }

Property Value

int

Influence

Gets the cartel influence manager for regional influence tracking. Returns null if the influence system is not available.

public CartelInfluence? Influence { get; }

Property Value

CartelInfluence

Instance

Gets the current Cartel instance, or null if not available.

public static Cartel? Instance { get; }

Property Value

Cartel

Status

The current status of the Cartel.

public CartelStatus Status { get; }

Property Value

CartelStatus

Methods

SetStatus(CartelStatus, bool)

Sets the cartel status. This is a server RPC that will sync to all clients.

public void SetStatus(CartelStatus status, bool resetTimer = true)

Parameters

status CartelStatus

The new cartel status.

resetTimer bool

Whether to reset the hours since status change timer.

Events

OnStatusChange

Event fired when the Cartel status changes. Provides the old status and new status as parameters.

public event Action<CartelStatus, CartelStatus> OnStatusChange

Event Type

Action<CartelStatus, CartelStatus>