Class Person
Defines an NPC involved in a quest.
Assembly: Assembly-CSharp.dll
Syntax
public class Person : QuestResource, IDisposable
Constructors
|
Improve this Doc
View Source
Person(Quest)
Declaration
public Person(Quest parentQuest)
Parameters
Type |
Name |
Description |
Quest |
parentQuest |
|
|
Improve this Doc
View Source
Person(Quest, String)
Declaration
public Person(Quest parentQuest, string line)
Parameters
Properties
|
Improve this Doc
View Source
DiscoveredThroughTalkManager
Declaration
public bool DiscoveredThroughTalkManager { get; set; }
Property Value
|
Improve this Doc
View Source
DisplayName
Declaration
public string DisplayName { get; }
Property Value
|
Improve this Doc
View Source
FaceIndex
Declaration
public int FaceIndex { get; }
Property Value
|
Improve this Doc
View Source
FactionData
Declaration
public FactionFile.FactionData FactionData { get; }
Property Value
|
Improve this Doc
View Source
FactionIndex
Declaration
public int FactionIndex { get; }
Property Value
|
Improve this Doc
View Source
Gender
Declaration
public override Genders Gender { get; }
Property Value
Overrides
|
Improve this Doc
View Source
HomeBuildingName
Declaration
public string HomeBuildingName { get; }
Property Value
|
Improve this Doc
View Source
HomeRegionIndex
Declaration
public int HomeRegionIndex { get; }
Property Value
|
Improve this Doc
View Source
HomeRegionName
Declaration
public string HomeRegionName { get; }
Property Value
|
Improve this Doc
View Source
HomeTownName
Declaration
public string HomeTownName { get; }
Property Value
|
Improve this Doc
View Source
IsDestroyed
Declaration
public bool IsDestroyed { get; }
Property Value
|
Improve this Doc
View Source
IsIndividualAtHome
Declaration
public bool IsIndividualAtHome { get; }
Property Value
|
Improve this Doc
View Source
IsIndividualNPC
Declaration
public bool IsIndividualNPC { get; }
Property Value
|
Improve this Doc
View Source
IsMuted
Declaration
public bool IsMuted { get; set; }
Property Value
|
Improve this Doc
View Source
IsQuestor
Declaration
public bool IsQuestor { get; set; }
Property Value
|
Improve this Doc
View Source
NameSeed
Declaration
public int NameSeed { get; set; }
Property Value
|
Improve this Doc
View Source
QuestorData
Declaration
public StaticNPC.NPCData QuestorData { get; }
Property Value
|
Improve this Doc
View Source
Race
Declaration
public Races Race { get; }
Property Value
Methods
|
Improve this Doc
View Source
DestroyNPC()
Set Person.IsDestroyed=true.
Person can no longer be placed or clicked.
Declaration
|
Improve this Doc
View Source
ExpandMacro(MacroTypes, out String)
Declaration
public override bool ExpandMacro(MacroTypes macro, out string textOut)
Parameters
Returns
Overrides
|
Improve this Doc
View Source
GetAssignedPlaceSymbol()
Gets most recent Place this Person was assigned to.
Notes:
- Can be null when NPC not yet assigned. They are technically nowhere.
- Will continue to return last assigned place even when "hide npc" is used.
- The action "destroy npc" will revoke assignment.
Declaration
public Symbol GetAssignedPlaceSymbol()
Returns
Type |
Description |
Symbol |
Most recent Place symbol assigned, or null if not assigned.
|
|
Improve this Doc
View Source
GetDialogPlace()
Gets best Place resource for use in dialog.
Declaration
public Place GetDialogPlace()
Returns
Type |
Description |
Place |
Assigned Place resource or Home Place resource if not assigned.
|
|
Improve this Doc
View Source
GetFactionData(Int32)
Declaration
public static FactionFile.FactionData GetFactionData(int factionID)
Parameters
Type |
Name |
Description |
Int32 |
factionID |
|
Returns
|
Improve this Doc
View Source
GetHomePlace()
Gets home Place resource assigned to this NPC (if any).
Declaration
public Place GetHomePlace()
Returns
Type |
Description |
Place |
Home Place resource or null.
|
|
Improve this Doc
View Source
GetIndividualFactionID(String)
Declaration
public static int GetIndividualFactionID(string individualNPCName)
Parameters
Type |
Name |
Description |
String |
individualNPCName |
|
Returns
|
Improve this Doc
View Source
GetSaveData()
Declaration
public override object GetSaveData()
Returns
Overrides
|
Improve this Doc
View Source
IsPlayerInSameLocationWorldCell()
Checks if player in same world cell as Place this Person was assigned to.
Does not care about specific building/dungeon or interior/exterior, just matching location mapID.
Does not care if player actually inside bounds, just if inside same world cell.
Declaration
public bool IsPlayerInSameLocationWorldCell()
Returns
Type |
Description |
Boolean |
True if player in same world cell as location.
|
|
Improve this Doc
View Source
PlaceAtHome()
Places NPC to home. This can happen automatically when player enters building or when
quest script uses "create npc" action to automatically assign Person to home.
Declaration
public bool PlaceAtHome()
Returns
|
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
SetAssignedPlaceSymbol(Symbol)
Called by "place npc" to help track current Place assignment.
Declaration
public void SetAssignedPlaceSymbol(Symbol placeSymbol)
Parameters
Type |
Name |
Description |
Symbol |
placeSymbol |
|
|
Improve this Doc
View Source
SetResource(String)
Declaration
public override void SetResource(string line)
Parameters
Type |
Name |
Description |
String |
line |
|
Overrides
|
Improve this Doc
View Source
Tick(Quest)
Declaration
public override void Tick(Quest caller)
Parameters
Type |
Name |
Description |
Quest |
caller |
|
Overrides