AC.ITranslatable Interface Reference

Inheritance diagram for AC.ITranslatable:

Public Member Functions
string	GetTranslatableString (int index)
	Gets the text to be translated, given its index. More...
int	GetTranslationID (int index)
	Gets the translation ID of a given text index. More...
void	UpdateTranslatableString (int index, string updatedText)
int	GetNumTranslatables ()
	Gets the maximum number of possible translatable texts. More...
bool	CanTranslate (int index)
	Checks if a given text index can and should be translated. More...
bool	HasExistingTranslation (int index)
	Checks if a given text index has already been assigned a unique translation ID. More...
void	SetTranslationID (int index, int lineID)
	Sets the translation ID of a given text index More...
string	GetOwner (int index)
	Gets the name of the translatable text's owner. In the case of speech text, it is the name of the character. In the case of menu element text, it is the name of the menu element. More...
bool	OwnerIsPlayer (int index)
	Checks if the translatable text's owner is a Player. This is necessary for speech lines, since multiple player prefabs can feasibly share the same line. More...
AC_TextType	GetTranslationType (int index)
	Gets the translation type of a given text index. More...

Detailed Description

An interface for any component that has translatable strings.

Member Function Documentation

CanTranslate()

bool AC.ITranslatable.CanTranslate

(

int

index

)

Checks if a given text index can and should be translated.

Parameters

index

The index of the translatable text

Returns

True if the text can and should be translated

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.GVar, AC.HotspotPrefix, AC.MenuLabel, AC.MenuSlider, AC.MenuButton, AC.ActionSpeech, AC.MenuToggle, AC.Objective, AC.Document, AC.MenuInput, AC.ActionMenuState, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.Container, AC.InvVar, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, AC.ActionRename, AC.SaveLabels, and AC.CustomTranslatableExample.

GetNumTranslatables()

int AC.ITranslatable.GetNumTranslatables

(

)

Gets the maximum number of possible translatable texts.

Returns

The maximum number of possible translatable texts.

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.HotspotPrefix, AC.GVar, AC.MenuLabel, AC.MenuSlider, AC.MenuButton, AC.MenuToggle, AC.Objective, AC.ActionSpeech, AC.Document, AC.MenuInput, AC.ActionMenuState, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.Container, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, AC.ActionRename, AC.SaveLabels, and AC.CustomTranslatableExample.

GetOwner()

string AC.ITranslatable.GetOwner

(

int

index

)

Gets the name of the translatable text's owner. In the case of speech text, it is the name of the character. In the case of menu element text, it is the name of the menu element.

Parameters

index

The index of the translatable text

Returns

The name of the translatable text's owner.

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.GVar, AC.HotspotPrefix, AC.MenuLabel, AC.MenuSlider, AC.MenuButton, AC.MenuToggle, AC.Objective, AC.ActionSpeech, AC.Document, AC.MenuInput, AC.ActionMenuState, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.Container, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, AC.SaveLabels, AC.ActionRename, and AC.CustomTranslatableExample.

GetTranslatableString()

string AC.ITranslatable.GetTranslatableString

(

int

index

)

Gets the text to be translated, given its index.

Parameters

index

The index of the translatable text

Returns

The text to be translated

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.HotspotPrefix, AC.MenuLabel, AC.GVar, AC.MenuSlider, AC.MenuButton, AC.MenuToggle, AC.Objective, AC.ActionSpeech, AC.MenuInput, AC.ActionMenuState, AC.Document, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.InvVar, AC.Container, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, AC.ActionRename, AC.CustomTranslatableExample, and AC.SaveLabels.

GetTranslationID()

int AC.ITranslatable.GetTranslationID

(

int

index

)

Gets the translation ID of a given text index.

Parameters

index

The index of the translatable text

Returns

The translation ID of the text

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.HotspotPrefix, AC.MenuLabel, AC.GVar, AC.MenuSlider, AC.MenuButton, AC.MenuToggle, AC.Objective, AC.ActionSpeech, AC.MenuInput, AC.Document, AC.ActionMenuState, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.InvVar, AC.Container, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, AC.ActionRename, AC.CustomTranslatableExample, and AC.SaveLabels.

GetTranslationType()

AC_TextType AC.ITranslatable.GetTranslationType

(

int

index

)

Gets the translation type of a given text index.

Parameters

index

The index of the translatable text

Returns

The translation type of a given text index.

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.MenuLabel, AC.HotspotPrefix, AC.MenuSlider, AC.GVar, AC.MenuButton, AC.ActionSpeech, AC.MenuToggle, AC.Objective, AC.MenuInput, AC.ActionMenuState, AC.Document, AC.ObjectiveStateLabel, AC.LocalVariables, AC.MenuDrag, AC.ObjectiveState, AC.PopUpLabelData, AC.InvVar, AC.ActionDialogOptionRename, AC.Container, AC.Variables, AC.ScriptedActionListExample, AC.ActionCharRename, AC.CursorIcon, AC.SaveLabels, AC.ActionRename, and AC.CustomTranslatableExample.

HasExistingTranslation()

bool AC.ITranslatable.HasExistingTranslation

(

int

index

)

Checks if a given text index has already been assigned a unique translation ID.

Parameters

index

The index of the translatable text

Returns

True if the text has been assigned a unique translation ID

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.HotspotPrefix, AC.GVar, AC.MenuLabel, AC.MenuSlider, AC.MenuButton, AC.MenuToggle, AC.Objective, AC.ActionSpeech, AC.Document, AC.MenuInput, AC.ActionMenuState, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.Container, AC.InvVar, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, AC.ActionRename, AC.SaveLabels, and AC.CustomTranslatableExample.

OwnerIsPlayer()

bool AC.ITranslatable.OwnerIsPlayer

(

int

index

)

Checks if the translatable text's owner is a Player. This is necessary for speech lines, since multiple player prefabs can feasibly share the same line.

Parameters

index

The index of the translatable text

Returns

True if the translatable text's owner is a Player.

Implemented in AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.GVar, AC.HotspotPrefix, AC.MenuLabel, AC.MenuSlider, AC.MenuButton, AC.ActionSpeech, AC.MenuToggle, AC.Objective, AC.Document, AC.MenuInput, AC.ActionMenuState, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.Container, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, AC.SaveLabels, AC.ActionRename, and AC.CustomTranslatableExample.

SetTranslationID()

void AC.ITranslatable.SetTranslationID	(	int	index,
		int	lineID
	)

Sets the translation ID of a given text index

Parameters

index	The index of the translatable text
lineID	The new translation ID to assign the translatable text

Implemented in AC.SaveLabels, AC.CustomTranslatableExample, AC.Char, AC.Hotspot, AC.MenuSavesList, AC.InvItem, AC.ActionVarSet, AC.MenuCycle, AC.Conversation, AC.MenuJournal, AC.GVar, AC.HotspotPrefix, AC.MenuLabel, AC.MenuSlider, AC.MenuButton, AC.MenuToggle, AC.Objective, AC.ActionSpeech, AC.Document, AC.MenuInput, AC.ActionMenuState, AC.ObjectiveStateLabel, AC.ObjectiveState, AC.LocalVariables, AC.MenuDrag, AC.PopUpLabelData, AC.Container, AC.InvVar, AC.ActionDialogOptionRename, AC.Variables, AC.CursorIcon, AC.ScriptedActionListExample, AC.ActionCharRename, and AC.ActionRename.