EasyTalk.Character.CharacterDefinition Class Reference

Defines attributes for a character, such as their name, icons, and portrayal images/spritesheets. More...

Public Member Functions
AnimatableDisplayImage	GetIconSprite (string id)
	Returns the character's icon which has the specified ID, if it exists.
AnimatableDisplayImage	GetPortrayalSprite (string id)
	Returns the character's portrait which has the specified ID, if it exists.

Properties
string	CharacterName [get, set]
	Gets or sets the name of the character.
List< AnimatableDisplayImage >	IconsSprites [get]
	GEts the List of icons for the character.
List< AnimatableDisplayImage >	PortrayalSprites [get]
	Gets the List of portraits for the character.
bool	OverrideDefaultGibberishAudio [get, set]
List< AudioClip >	GibberishAudioClips [get]
	Gets the List of gibberish audio clips used by the character.

Private Attributes
string	characterName
	The name of the character.
List< AnimatableDisplayImage >	iconsSprites = new List<AnimatableDisplayImage>()
	A collection of displayable icons for the character.
List< AnimatableDisplayImage >	portrayalSprites = new List<AnimatableDisplayImage>()
	A collection of displayable portraits for the character.
bool	overrideDefaultGibberishAudio = false
	Indicates whether the character should use their own unique gibberish audio, rather than the defaults.
List< AudioClip >	gibberishAudioClips = new List<AudioClip>()
	The collection of gibberish audio clips used for the character.

Detailed Description

Defines attributes for a character, such as their name, icons, and portrayal images/spritesheets.

Member Function Documentation

GetIconSprite()

AnimatableDisplayImage EasyTalk.Character.CharacterDefinition.GetIconSprite

(

string

id

)

Returns the character's icon which has the specified ID, if it exists.

Parameters

id	The ID of the icon to retrieve.

Returns

The specified icon, if it exists; otherwise null.

GetPortrayalSprite()

AnimatableDisplayImage EasyTalk.Character.CharacterDefinition.GetPortrayalSprite

(

string

id

)

Returns the character's portrait which has the specified ID, if it exists.

Parameters

id	The ID of the portrait to retrieve.

Returns

The specified portrait, if it exists; otherwise null.

Member Data Documentation

characterName

string EasyTalk.Character.CharacterDefinition.characterName

private

The name of the character.

gibberishAudioClips

List<AudioClip> EasyTalk.Character.CharacterDefinition.gibberishAudioClips = new List<AudioClip>()

private

The collection of gibberish audio clips used for the character.

iconsSprites

List<AnimatableDisplayImage> EasyTalk.Character.CharacterDefinition.iconsSprites = new List<AnimatableDisplayImage>()

private

A collection of displayable icons for the character.

overrideDefaultGibberishAudio

bool EasyTalk.Character.CharacterDefinition.overrideDefaultGibberishAudio = false

private

Indicates whether the character should use their own unique gibberish audio, rather than the defaults.

portrayalSprites

List<AnimatableDisplayImage> EasyTalk.Character.CharacterDefinition.portrayalSprites = new List<AnimatableDisplayImage>()

private

A collection of displayable portraits for the character.

Property Documentation

CharacterName

string EasyTalk.Character.CharacterDefinition.CharacterName

getset

Gets or sets the name of the character.

GibberishAudioClips

List<AudioClip> EasyTalk.Character.CharacterDefinition.GibberishAudioClips

get

Gets the List of gibberish audio clips used by the character.

IconsSprites

List<AnimatableDisplayImage> EasyTalk.Character.CharacterDefinition.IconsSprites

get

GEts the List of icons for the character.

OverrideDefaultGibberishAudio

bool EasyTalk.Character.CharacterDefinition.OverrideDefaultGibberishAudio

getset

PortrayalSprites

List<AnimatableDisplayImage> EasyTalk.Character.CharacterDefinition.PortrayalSprites

get

Gets the List of portraits for the character.