Show / Hide Table of Contents

Class MySpawnGroupDefinition

Inheritance
System.Object
MyDefinitionBase
MySpawnGroupDefinition
Inherited Members
MyDefinitionBase.Id
MyDefinitionBase.DisplayNameEnum
MyDefinitionBase.DescriptionEnum
MyDefinitionBase.DisplayNameString
MyDefinitionBase.DescriptionString
MyDefinitionBase.DescriptionArgs
MyDefinitionBase.Icons
MyDefinitionBase.Enabled
MyDefinitionBase.Public
MyDefinitionBase.AvailableInSurvival
MyDefinitionBase.Context
MyDefinitionBase.Init(MyObjectBuilder_DefinitionBase, MyModContext)
MyDefinitionBase.Postprocess()
MyDefinitionBase.ToString()
MyDefinitionBase.CheckDefinitionDLCs(String[])
MyDefinitionBase.DLCs
MyDefinitionBase.DisplayNameText
MyDefinitionBase.DescriptionText
Namespace: Sandbox.Definitions
Assembly: Sandbox.Game.dll
Syntax
[MyDefinitionType]
public class MySpawnGroupDefinition : MyDefinitionBase

Constructors

MySpawnGroupDefinition()

Declaration
public MySpawnGroupDefinition()

Fields

EnableNpcResources

Declaration
public bool EnableNpcResources
Field Value
Type Description
System.Boolean

EnableTradingStationVisit

Declaration
public bool EnableTradingStationVisit
Field Value
Type Description
System.Boolean

FactionSubEncounters

Declaration
public List<SubEncounter> FactionSubEncounters
Field Value
Type Description
System.Collections.Generic.List<SubEncounter>

Frequency

Declaration
public float Frequency
Field Value
Type Description
System.Single

GlobalEncounterSettings

Declaration
public GlobalEncounterSettings GlobalEncounterSettings
Field Value
Type Description
GlobalEncounterSettings

HostileSubEncounters

Declaration
public List<SubEncounter> HostileSubEncounters
Field Value
Type Description
System.Collections.Generic.List<SubEncounter>

IsCargoShip

Declaration
public bool IsCargoShip
Field Value
Type Description
System.Boolean

IsEncounter

Declaration
public bool IsEncounter
Field Value
Type Description
System.Boolean

PlanetaryInstallationSettings

Declaration
public PlanetaryInstallationSettings PlanetaryInstallationSettings
Field Value
Type Description
PlanetaryInstallationSettings

Prefabs

Declaration
public List<MySpawnGroupDefinition.SpawnGroupPrefab> Prefabs
Field Value
Type Description
System.Collections.Generic.List<MySpawnGroupDefinition.SpawnGroupPrefab>

RandomizedPaint

Declaration
public bool RandomizedPaint
Field Value
Type Description
System.Boolean

ReactorsOn

Declaration
public bool ReactorsOn
Field Value
Type Description
System.Boolean

Voxels

Declaration
public List<MySpawnGroupDefinition.SpawnGroupVoxel> Voxels
Field Value
Type Description
System.Collections.Generic.List<MySpawnGroupDefinition.SpawnGroupVoxel>

Properties

FactionSubtypeIds

Declaration
public List<string> FactionSubtypeIds { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

FactionTypesSubtypeIds

Declaration
public List<string> FactionTypesSubtypeIds { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

IsGlobalEncounter

Declaration
public bool IsGlobalEncounter { get; set; }
Property Value
Type Description
System.Boolean

IsPirate

Declaration
public bool IsPirate { get; }
Property Value
Type Description
System.Boolean

IsPlanetaryEncounter

Declaration
public bool IsPlanetaryEncounter { get; set; }
Property Value
Type Description
System.Boolean

IsValid

Declaration
public bool IsValid { get; }
Property Value
Type Description
System.Boolean

MaxFactionSubEncounters

Max count of faction sub encounters to spawn

Declaration
public byte MaxFactionSubEncounters { get; }
Property Value
Type Description
System.Byte

MaxHostileSubEncounters

Max count of hostile sub encounters to spawn

Declaration
public byte MaxHostileSubEncounters { get; }
Property Value
Type Description
System.Byte

MinFactionSubEncounters

Min count of faction sub encounters to spawn

Declaration
public byte MinFactionSubEncounters { get; }
Property Value
Type Description
System.Byte

MinHostileSubEncounters

Min count of hostile sub encounters to spawn

Declaration
public byte MinHostileSubEncounters { get; }
Property Value
Type Description
System.Byte

SpawnRadius

Declaration
public float SpawnRadius { get; }
Property Value
Type Description
System.Single

Methods

GetObjectBuilder()

Declaration
public override MyObjectBuilder_DefinitionBase GetObjectBuilder()
Returns
Type Description
MyObjectBuilder_DefinitionBase
Overrides
MyDefinitionBase.GetObjectBuilder()

Init(MyObjectBuilder_DefinitionBase)

Declaration
protected override void Init(MyObjectBuilder_DefinitionBase baseBuilder)
Parameters
Type Name Description
MyObjectBuilder_DefinitionBase baseBuilder
Overrides
MyDefinitionBase.Init(MyObjectBuilder_DefinitionBase)

ReloadPrefabs()

Declaration
public void ReloadPrefabs()

TryGetOwnerId(out Int64, Boolean)

Tries to get owner id for spawning this group based on FactionSubtypeIds and FactionTypesSubtypeIds

Declaration
public bool TryGetOwnerId(out long ownerId, bool isGlobalSubEncounter = false)
Parameters
Type Name Description
System.Int64 ownerId

result ownerId for this group

System.Boolean isGlobalSubEncounter

marks if spawn groups is spawning as global sub encounter

Returns
Type Description
System.Boolean

True if target faction was found, false otherwise

☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾