Show / Hide Table of Contents

Class DaggerfallUnity

DaggerfallUnity main class.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
DaggerfallUnity
Namespace: DaggerfallWorkshop
Assembly: Assembly-CSharp.dll
Syntax
[RequireComponent(typeof(WorldTime))]
[RequireComponent(typeof(MaterialReader))]
[RequireComponent(typeof(MeshReader))]
[RequireComponent(typeof(SoundReader))]
public class DaggerfallUnity : MonoBehaviour

Fields

| Improve this Doc View Source

Arena2Path

Declaration
public string Arena2Path
Field Value
Type Description
String
| Improve this Doc View Source

BlockImporter_BlockName

Declaration
public string BlockImporter_BlockName
Field Value
Type Description
String
| Improve this Doc View Source

CityImporter_CityName

Declaration
public string CityImporter_CityName
Field Value
Type Description
String
| Improve this Doc View Source

DungeonImporter_DungeonName

Declaration
public string DungeonImporter_DungeonName
Field Value
Type Description
String
| Improve this Doc View Source

Experimental_CityLayoutName

Declaration
public string Experimental_CityLayoutName
Field Value
Type Description
String
| Improve this Doc View Source

ModelImporter_ModelID

Declaration
public int ModelImporter_ModelID
Field Value
Type Description
Int32
| Improve this Doc View Source

Option_AddMeshColliders

Declaration
public bool Option_AddMeshColliders
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_AddNavmeshAgents

Declaration
public bool Option_AddNavmeshAgents
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_AutomateCityGates

Declaration
public bool Option_AutomateCityGates
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_AutomateCityLights

Declaration
public bool Option_AutomateCityLights
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_AutomateCityWindows

Declaration
public bool Option_AutomateCityWindows
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_AutomateSky

Declaration
public bool Option_AutomateSky
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_AutomateTextureSwaps

Declaration
public bool Option_AutomateTextureSwaps
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_BatchBillboards

Declaration
public bool Option_BatchBillboards
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_CityBlockPrefab

Declaration
public DaggerfallRMBBlock Option_CityBlockPrefab
Field Value
Type Description
DaggerfallRMBBlock
| Improve this Doc View Source

Option_CityLightPrefab

Declaration
public Light Option_CityLightPrefab
Field Value
Type Description
Light
| Improve this Doc View Source

Option_CombineRDB

Declaration
public bool Option_CombineRDB
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_CombineRMB

Declaration
public bool Option_CombineRMB
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_DungeonBlockPrefab

Declaration
public DaggerfallRDBBlock Option_DungeonBlockPrefab
Field Value
Type Description
DaggerfallRDBBlock
| Improve this Doc View Source

Option_DungeonDoorPrefab

Declaration
public DaggerfallActionDoor Option_DungeonDoorPrefab
Field Value
Type Description
DaggerfallActionDoor
| Improve this Doc View Source

Option_DungeonLightPrefab

Declaration
public Light Option_DungeonLightPrefab
Field Value
Type Description
Light
| Improve this Doc View Source

Option_DungeonWaterPlaneOffset

Declaration
public Vector3 Option_DungeonWaterPlaneOffset
Field Value
Type Description
Vector3
| Improve this Doc View Source

Option_DungeonWaterPlaneSize

Declaration
public Vector3 Option_DungeonWaterPlaneSize
Field Value
Type Description
Vector3
| Improve this Doc View Source

Option_DungeonWaterPrefab

Declaration
public GameObject Option_DungeonWaterPrefab
Field Value
Type Description
GameObject
| Improve this Doc View Source

Option_EnemyPrefab

Declaration
public DaggerfallEnemy Option_EnemyPrefab
Field Value
Type Description
DaggerfallEnemy
| Improve this Doc View Source

Option_ImportDoorPrefabs

Declaration
public bool Option_ImportDoorPrefabs
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_ImportEnemyPrefabs

Declaration
public bool Option_ImportEnemyPrefabs
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_ImportLightPrefabs

Declaration
public bool Option_ImportLightPrefabs
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_ImportRandomTreasure

Declaration
public bool Option_ImportRandomTreasure
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_InteriorDoorPrefab

Declaration
public DaggerfallActionDoor Option_InteriorDoorPrefab
Field Value
Type Description
DaggerfallActionDoor
| Improve this Doc View Source

Option_InteriorLightPrefab

Declaration
public Light Option_InteriorLightPrefab
Field Value
Type Description
Light
| Improve this Doc View Source

Option_LootContainerPrefab

Declaration
public DaggerfallLoot Option_LootContainerPrefab
Field Value
Type Description
DaggerfallLoot
| Improve this Doc View Source

Option_MobileNPCPrefab

Declaration
public MobilePersonMotor Option_MobileNPCPrefab
Field Value
Type Description
MobilePersonMotor
| Improve this Doc View Source

Option_RMBGroundPlane

Declaration
public bool Option_RMBGroundPlane
Field Value
Type Description
Boolean
| Improve this Doc View Source

Option_SetStaticFlags

Declaration
public bool Option_SetStaticFlags
Field Value
Type Description
Boolean
| Improve this Doc View Source

staticGeometryTag

Declaration
public const string staticGeometryTag = "StaticGeometry"
Field Value
Type Description
String

Properties

| Improve this Doc View Source

ContentReader

Declaration
public ContentReader ContentReader { get; }
Property Value
Type Description
ContentReader
| Improve this Doc View Source

CurrentUID

Gets or sets current unique identifier counter. This property used for serialization/deserialization. Should not be changed any other time. UIDs 0-4095 are reserved.

Declaration
public static ulong CurrentUID { get; set; }
Property Value
Type Description
UInt64
| Improve this Doc View Source

HasInstance

Declaration
public static bool HasInstance { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Instance

Declaration
public static DaggerfallUnity Instance { get; }
Property Value
Type Description
DaggerfallUnity
| Improve this Doc View Source

IsPathValidated

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

IsReady

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

ItemHelper

Declaration
public ItemHelper ItemHelper { get; }
Property Value
Type Description
ItemHelper
| Improve this Doc View Source

MaterialReader

Declaration
public MaterialReader MaterialReader { get; }
Property Value
Type Description
MaterialReader
| Improve this Doc View Source

MeshReader

Declaration
public MeshReader MeshReader { get; }
Property Value
Type Description
MeshReader
| Improve this Doc View Source

NameHelper

Declaration
public NameHelper NameHelper { get; }
Property Value
Type Description
NameHelper
| Improve this Doc View Source

NextUID

Gets a new UID. Counter is incremented on each call.

Declaration
public static ulong NextUID { get; }
Property Value
Type Description
UInt64
| Improve this Doc View Source

Settings

Declaration
public static SettingsManager Settings { get; }
Property Value
Type Description
SettingsManager
| Improve this Doc View Source

SoundReader

Declaration
public SoundReader SoundReader { get; }
Property Value
Type Description
SoundReader
| Improve this Doc View Source

TerrainMaterialProvider

Declaration
public ITerrainMaterialProvider TerrainMaterialProvider { get; set; }
Property Value
Type Description
ITerrainMaterialProvider
| Improve this Doc View Source

TerrainNature

Declaration
public ITerrainNature TerrainNature { get; set; }
Property Value
Type Description
ITerrainNature
| Improve this Doc View Source

TerrainSampler

Declaration
public ITerrainSampler TerrainSampler { get; set; }
Property Value
Type Description
ITerrainSampler
| Improve this Doc View Source

TerrainTexturing

Declaration
public ITerrainTexturing TerrainTexturing { get; set; }
Property Value
Type Description
ITerrainTexturing
| Improve this Doc View Source

TextProvider

Declaration
public ITextProvider TextProvider { get; set; }
Property Value
Type Description
ITextProvider
| Improve this Doc View Source

WorldTime

Declaration
public WorldTime WorldTime { get; }
Property Value
Type Description
WorldTime

Methods

| Improve this Doc View Source

ChangeArena2Path(String)

Sets new arena2 path and sets up DaggerfallUnity.

Declaration
public void ChangeArena2Path(string arena2Path)
Parameters
Type Name Description
String arena2Path

New arena2 path. Must be valid.

| Improve this Doc View Source

FindDaggerfallUnity(out DaggerfallUnity)

Declaration
public static bool FindDaggerfallUnity(out DaggerfallUnity dfUnityOut)
Parameters
Type Name Description
DaggerfallUnity dfUnityOut
Returns
Type Description
Boolean
| Improve this Doc View Source

LogMessage(String, Boolean)

Declaration
public static void LogMessage(string message, bool showInEditor = false)
Parameters
Type Name Description
String message
Boolean showInEditor
| Improve this Doc View Source

RaiseOnReadyEvent()

Declaration
protected virtual void RaiseOnReadyEvent()
| Improve this Doc View Source

RaiseOnSetArena2SourceEvent()

Declaration
protected virtual void RaiseOnSetArena2SourceEvent()
| Improve this Doc View Source

RaiseOnSetTerrainSamplerEvent()

Declaration
protected virtual void RaiseOnSetTerrainSamplerEvent()
| Improve this Doc View Source

RaiseOnSetTextProviderEvent()

Declaration
protected virtual void RaiseOnSetTextProviderEvent()
| Improve this Doc View Source

ResetUID()

Resets UID back to starting state. Should only be used when starting a fresh new game (e.g. classic save import).

Declaration
public static void ResetUID()
| Improve this Doc View Source

TestArena2Exists(String)

Declaration
public static string TestArena2Exists(string parent)
Parameters
Type Name Description
String parent
Returns
Type Description
String
| Improve this Doc View Source

ValidateArena2Path(String)

Declaration
public static bool ValidateArena2Path(string path)
Parameters
Type Name Description
String path
Returns
Type Description
Boolean

Events

| Improve this Doc View Source

OnPruneCache

Declaration
public event DaggerfallUnity.OnPruneCacheEventHandler OnPruneCache
Event Type
Type Description
DaggerfallUnity.OnPruneCacheEventHandler
| Improve this Doc View Source

OnReady

Declaration
public static event DaggerfallUnity.OnReadyEventHandler OnReady
Event Type
Type Description
DaggerfallUnity.OnReadyEventHandler
| Improve this Doc View Source

OnSetArena2Source

Declaration
public static event DaggerfallUnity.OnSetArena2SourceEventHandler OnSetArena2Source
Event Type
Type Description
DaggerfallUnity.OnSetArena2SourceEventHandler
| Improve this Doc View Source

OnSetTerrainSampler

Declaration
public static event DaggerfallUnity.OnSetTerrainSamplerEventHandler OnSetTerrainSampler
Event Type
Type Description
DaggerfallUnity.OnSetTerrainSamplerEventHandler
| Improve this Doc View Source

OnSetTextProvider

Declaration
public static event DaggerfallUnity.OnSetTextProviderEventHandler OnSetTextProvider
Event Type
Type Description
DaggerfallUnity.OnSetTextProviderEventHandler

Extension Methods

MBExtensions.Invoke(MonoBehaviour, Action, Single)
MBExtensions.Invoke<T>(MonoBehaviour, Action<T>, T, Single)
MBExtensions.Invoke<T1, T2>(MonoBehaviour, Action<T1, T2>, T1, T2, Single)
MBExtensions.Invoke<T1, T2, T3>(MonoBehaviour, Action<T1, T2, T3>, T1, T2, T3, Single)
MBExtensions.Invoke<T1, T2, T3, T4>(MonoBehaviour, Action<T1, T2, T3, T4>, T1, T2, T3, T4, Single)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX