Class BasicHunterJournalEntry

A basic hunter's journal entry that uses basic strings

Inheritance
object
Object
ScriptableObject
HunterJournalEntry
BasicHunterJournalEntry
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Namespace: WeaverCore.Features
Assembly: WeaverCore.dll
Syntax
[CreateAssetMenu(fileName = "Basic Hunter Journal Entry", menuName = "WeaverCore/Basic Hunter Journal Entry")]
public class BasicHunterJournalEntry : HunterJournalEntry

Fields

| Edit this page View Source

description

Declaration
[SerializeField]
[Tooltip("The description of the enemy in the hunter's journal")]
protected string description
Field Value
Type Description
string
| Edit this page View Source

discoveredSaveFieldName

Declaration
[SerializeField]
[Tooltip("The field in the Save Settings used for storing whether or not the enemy has been discovered")]
[SaveSpecificFieldName(typeof(bool), "saveSettings")]
protected string discoveredSaveFieldName
Field Value
Type Description
string
| Edit this page View Source

entryName

Declaration
[SerializeField]
[Tooltip("The internal name of this journal entry")]
protected string entryName
Field Value
Type Description
string
| Edit this page View Source

huntersNotes

Declaration
[SerializeField]
[Tooltip("The hunter's notes on the enemy in the hunter's journal. Only visible after the amount of kills has reached the Hunter's Notes Threshold")]
protected string huntersNotes
Field Value
Type Description
string
| Edit this page View Source

huntersNotesThreshold

Declaration
[SerializeField]
[Tooltip("The amount of kills required before the Hunter's Notes becomes visible")]
protected int huntersNotesThreshold
Field Value
Type Description
int
| Edit this page View Source

icon

Declaration
[SerializeField]
[Tooltip("The icon shown in the menu at the left-side of the hunter's journal")]
protected Sprite icon
Field Value
Type Description
Sprite
| Edit this page View Source

isNewEntrySaveFieldName

Declaration
[SerializeField]
[Tooltip("The field in the Save Settings used for storing whether or not this is a brand new entry in the journal")]
[SaveSpecificFieldName(typeof(bool), "saveSettings")]
protected string isNewEntrySaveFieldName
Field Value
Type Description
string
| Edit this page View Source

killCountSaveFieldName

Declaration
[SerializeField]
[Tooltip("The field in the Save Settings used for storing the kill count")]
[SaveSpecificFieldName(typeof(int), "saveSettings")]
protected string killCountSaveFieldName
Field Value
Type Description
string
| Edit this page View Source

saveSettings

Declaration
[Header("Persistent Settings")]
[SerializeField]
[Tooltip("Used for storing how many times this enemy was killed, and whether or not it has been discovered")]
protected SaveSpecificSettings saveSettings
Field Value
Type Description
SaveSpecificSettings
| Edit this page View Source

sprite

Declaration
[SerializeField]
[Tooltip("The image of the enemy shown in the hunter's journal when selected")]
protected Sprite sprite
Field Value
Type Description
Sprite
| Edit this page View Source

title

Declaration
[SerializeField]
[Tooltip("The title of the enemy in the hunter's journal")]
protected string title
Field Value
Type Description
string

Properties

| Edit this page View Source

Description

The description of the enemy in the hunter's journal

Declaration
public override string Description { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

Discovered

Records whether or not this enemy has been discovered

Declaration
public override bool Discovered { get; set; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

EntryName

The internal name of this journal entry

Declaration
public override string EntryName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

HuntersNotes

The hunter's notes on the enemy in the hunter's journal. Only visible after the amount of kills has reached the HuntersNotesThreshold

Declaration
public override string HuntersNotes { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

HuntersNotesThreshold

The amount of kills required before the HuntersNotes becomes visible

Declaration
public override int HuntersNotesThreshold { get; }
Property Value
Type Description
int
Overrides
| Edit this page View Source

Icon

The icon shown in the menu at the left-side of the hunter's journal

Declaration
public override Sprite Icon { get; }
Property Value
Type Description
Sprite
Overrides
| Edit this page View Source

IsNewEntry

Is this a brand new entry in the journal? This is mainly used to highlight brand new elements in the journal

Declaration
public override bool IsNewEntry { get; set; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

KillCount

The recorded amount of times this enemy has been killed. NOTE: This will stop counting up once the number reaches the HuntersNotesThreshold

Declaration
public override int KillCount { get; set; }
Property Value
Type Description
int
Overrides
| Edit this page View Source

Sprite

The image of the enemy shown in the hunter's journal when selected

Declaration
public override Sprite Sprite { get; }
Property Value
Type Description
Sprite
Overrides
| Edit this page View Source

Title

The title of the enemy in the hunter's journal

Declaration
public override string Title { get; }
Property Value
Type Description
string
Overrides

Extension Methods