Contains information about a conversation participant that the dialogue UI or Sequencer may need.
More...
|
bool | IsPlayer [get] |
| Indicates whether this character is a player (PC). More...
|
|
bool | IsNPC [get] |
| Indicates whether this character is an NPC. More...
|
|
string | Name [get, set] |
| Gets the character's name. More...
|
|
Contains information about a conversation participant that the dialogue UI or Sequencer may need.
CharacterInfo also contains a static list of mappings of transforms to actor names. A GameObject can register that its transform corresponds to a specific actor. This is typically done automatically by the OverrideActorName component.
◆ CharacterInfo()
PixelCrushers.DialogueSystem.CharacterInfo.CharacterInfo |
( |
int |
id, |
|
|
string |
nameInDatabase, |
|
|
Transform |
transform, |
|
|
CharacterType |
characterType, |
|
|
Texture2D |
portrait |
|
) |
| |
Initializes a new CharacterInfo.
- Parameters
-
actorID | Actor ID. |
actorName | Name of the actor as defined in the dialogue database. |
transform | Transform. |
characterType | Character type. |
portrait | Portrait. |
◆ GetLocalizedDisplayNameInDatabase()
static string PixelCrushers.DialogueSystem.CharacterInfo.GetLocalizedDisplayNameInDatabase |
( |
string |
nameInDatabase | ) |
|
|
static |
◆ GetPicOverride()
Texture2D PixelCrushers.DialogueSystem.CharacterInfo.GetPicOverride |
( |
int |
picNum | ) |
|
Gets the pic override portrait.
Dialogue text can include [pic=#]
tags. This number corresponds to the actor's portrait (if picNum == 1) or alternatePortraits (if picNum >= 2).
- Returns
- The pic override portrait.
- Parameters
-
◆ GetRegisteredActorTransform()
static Transform PixelCrushers.DialogueSystem.CharacterInfo.GetRegisteredActorTransform |
( |
string |
actorName | ) |
|
|
static |
◆ RegisterActorTransform()
static void PixelCrushers.DialogueSystem.CharacterInfo.RegisterActorTransform |
( |
string |
actorName, |
|
|
Transform |
actorTransform |
|
) |
| |
|
static |
◆ UnregisterActorTransform()
static void PixelCrushers.DialogueSystem.CharacterInfo.UnregisterActorTransform |
( |
string |
actorName, |
|
|
Transform |
actorTransform |
|
) |
| |
|
static |
◆ characterType
CharacterType PixelCrushers.DialogueSystem.CharacterInfo.characterType |
The type of the character (PC or NPC).
◆ id
int PixelCrushers.DialogueSystem.CharacterInfo.id |
The actor ID of the character.
◆ nameInDatabase
string PixelCrushers.DialogueSystem.CharacterInfo.nameInDatabase |
The name of the actor as defined in the dialogue database.
◆ portrait
Texture2D PixelCrushers.DialogueSystem.CharacterInfo.portrait |
The portrait texture of the character.
◆ transform
Transform PixelCrushers.DialogueSystem.CharacterInfo.transform |
The transform of the character's GameObject.
◆ IsNPC
bool PixelCrushers.DialogueSystem.CharacterInfo.IsNPC |
|
get |
Indicates whether this character is an NPC.
true
if this is an NPC; otherwise, false
for a player.
◆ IsPlayer
bool PixelCrushers.DialogueSystem.CharacterInfo.IsPlayer |
|
get |
Indicates whether this character is a player (PC).
true
if this is a player; otherwise, false
for an NPC.
◆ Name
string PixelCrushers.DialogueSystem.CharacterInfo.Name |
|
getset |
Gets the character's name.
If the character info has been provided a non-null transform, this property returns the name of the transform's game object. Otherwise it returns the name of the actor in the dialogue database.
The documentation for this class was generated from the following file:
- D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Core/Model-View-Controller/Model/Logic/Shared/CharacterInfo.cs