This component maintains a list of map icons.
More...
|
bool | IsValidIconName (string iconName) |
| Checks whether a specified icon name is valid for this object.
|
|
void | UseIcon (string iconName) |
| Uses an icon specified by an icon name.
|
|
void | UseIcon (KGFMapIcon icon) |
| Uses an icon.
|
|
void | OnConversationEnd (Transform actor) |
| When a conversation ends, it's possible that a KGFMapIcon has changed its visibility.
|
|
This component maintains a list of map icons.
All map icons should be active when the GameObject awakes.
◆ IsValidIconName()
bool PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.IsValidIconName |
( |
string |
iconName | ) |
|
|
inline |
Checks whether a specified icon name is valid for this object.
- Returns
true
if the icon name is valid; otherwise, false
.
- Parameters
-
◆ OnConversationEnd()
void PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.OnConversationEnd |
( |
Transform |
actor | ) |
|
|
inline |
When a conversation ends, it's possible that a KGFMapIcon has changed its visibility.
If the KGFMapSystem was disabled during the conversation, it will not have refreshed its visibility. This method refreshes the visiblity after a two-frame delay to give SetEnabledOnDialogueEvent time to re-enable the map.
- Parameters
-
◆ UseIcon() [1/2]
void PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.UseIcon |
( |
KGFMapIcon |
icon | ) |
|
|
inline |
Uses an icon.
This icon becomes visible, and all others become invisible.
- Parameters
-
◆ UseIcon() [2/2]
void PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.UseIcon |
( |
string |
iconName | ) |
|
|
inline |
Uses an icon specified by an icon name.
This icon becomes visible, and all other icons become invisible.
- Parameters
-
◆ startingIcon
KGFMapIcon PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.startingIcon = null |
The starting icon.
When the GameObject starts, this icon will be visible, and the others will be invisible.
The documentation for this class was generated from the following file:
- C:/Dev/Dialogue System/Dev/Integration2/KGFMapSystem Integration/Assets/Pixel Crushers/Dialogue System/Third Party Support/KGFMapSystem Support/Scripts/KGFMapIcons.cs