Class Place

A site involved in a quest. Can be a random local/remote location or a fixed permanent location.

Inheritance
Object
QuestResource
Place
Inherited Members
Namespace: DaggerfallWorkshop.Game.Questing
Assembly: Assembly-CSharp.dll
Syntax
public class Place : QuestResource, IDisposable

Constructors

| Improve this Doc View Source

Place(Quest)

Default constructor.

Declaration
public Place(Quest parentQuest)
Parameters
Type Name Description
Quest parentQuest

Parent quest.
| Improve this Doc View Source

Place(Quest, String)

Construct a Place resource from QBN input.

Declaration
public Place(Quest parentQuest, string line)
Parameters
Type Name Description
Quest parentQuest

Parent quest.
String line

Place definition line from QBN.

Properties

| Improve this Doc View Source

Name

Gets the Name of this Place used for data table lookup.

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

Param1

Gets parameter 1 of Place.

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

Param2

Gets parameter 2 of Place.

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

Param3

Gets parameter 3 of Place.

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

Scope

Gets the scope of this Place.

Declaration
public Place.Scopes Scope { get; }
Property Value
Type Description
Place.Scopes
| Improve this Doc View Source

SiteDetails

Gets or sets full site details of Place.

Declaration
public SiteDetails SiteDetails { get; set; }
Property Value
Type Description
SiteDetails

Methods

| Improve this Doc View Source

AssignQuestResource(Symbol, Int32, MarkerPreference, Boolean)

Assigns a quest resource to this Place site. Supports Persons, Foes, Items from within same quest as Place. Quest must have previously created SiteLink for layout builders to discover assigned resources.

Declaration
public void AssignQuestResource(Symbol targetSymbol, int markerIndex = -1, MarkerPreference markerIndexPreference = MarkerPreference.Default, bool cullExisting = true)
Parameters
Type Name Description
Symbol targetSymbol

Resource symbol of Person, Item, or Foe to assign.
Int32 markerIndex

Preferred marker index to use instead of random. Must be able to find preferred marker type. Used by main quest only.
MarkerPreference markerIndexPreference
Boolean cullExisting
| Improve this Doc View Source

ConfigureFromPlayerLocation(String)

Sets up Place resource directly from current player location. Player must currently be in a town or dungeon location.

Declaration
public bool ConfigureFromPlayerLocation(string symbolName)
Parameters
Type Name Description
String symbolName
Returns
Type Description
Boolean

True if location configured or false if could not be configured (e.g. player not in town or dungeon).
| Improve this Doc View Source

CustomParseInt(String)

Custom parser to handle hex or decimal values from places data table.

Declaration
public static int CustomParseInt(string value)
Parameters
Type Name Description
String value
Returns
Type Description
Int32
| Improve this Doc View Source

ExpandMacro(MacroTypes, out String)

Expand macro for a Place.

Declaration
public override bool ExpandMacro(MacroTypes macro, out string textOut)
Parameters
Type Name Description
MacroTypes macro

Macro type to expand.
String textOut
Returns
Type Description
Boolean

True if macro expanded, otherwise false.
Overrides
| Improve this Doc View Source

GetSaveData()

Declaration
public override object GetSaveData()
Returns
Type Description
Object
Overrides
| Improve this Doc View Source

IsPlayerAtBuildingType(Int32, Int32)

Declaration
public static bool IsPlayerAtBuildingType(int p2, int p3)
Parameters
Type Name Description
Int32 p2
Int32 p3
Returns
Type Description
Boolean
| Improve this Doc View Source

IsPlayerHere()

Checks if player is at this place.

Declaration
public bool IsPlayerHere()
Returns
Type Description
Boolean

True if player at this place.
| Improve this Doc View Source

ReassignSiteDetailsLegacyMarkers()

Called for each Place resource after Quest has finished loading. Required to map old resource marker allocations to new marker resource system.

Declaration
public void ReassignSiteDetailsLegacyMarkers()
| Improve this Doc View Source

RestoreSaveData(Object)

Declaration
public override void RestoreSaveData(object dataIn)
Parameters
Type Name Description
Object dataIn
Overrides
| Improve this Doc View Source

SetResource(String)

Declaration
public override void SetResource(string line)
Parameters
Type Name Description
String line
Overrides