PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons Class Reference

This component maintains a list of map icons. More...

Inheritance diagram for PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons:

Collaboration diagram for PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons:

Public Member Functions
bool	IsValidIconName (string iconName)
	Checks whether a specified icon name is valid for this object. More...
void	UseIcon (string iconName)
	Uses an icon specified by an icon name. More...
void	UseIcon (KGFMapIcon icon)
	Uses an icon. More...
void	OnConversationEnd (Transform actor)
	When a conversation ends, it's possible that a KGFMapIcon has changed its visibility. More...

Public Attributes
KGFMapIcon	startingIcon = null
	The starting icon. More...

Detailed Description

This component maintains a list of map icons.

All map icons should be active when the GameObject awakes.

Member Function Documentation

IsValidIconName()

bool PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.IsValidIconName

(

string

iconName

)

Checks whether a specified icon name is valid for this object.

Returns

true if the icon name is valid; otherwise, false.

Parameters

iconName

Icon name.

OnConversationEnd()

void PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.OnConversationEnd

(

Transform

actor

)

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

actor

Actor.

UseIcon() [1/2]

void PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.UseIcon

(

KGFMapIcon

icon

)

Uses an icon.

This icon becomes visible, and all others become invisible.

Parameters

icon

Icon.

UseIcon() [2/2]

void PixelCrushers.DialogueSystem.KGFMapSystem.KGFMapIcons.UseIcon

(

string

iconName

)

Uses an icon specified by an icon name.

This icon becomes visible, and all other icons become invisible.

Parameters

iconName

Icon name.

Member Data Documentation

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:

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/KGFMapSystem Integration/Assets/Dialogue System/Third Party Support/KGFMapSystem/Scripts/KGFMapIcons.cs