C# Class EasyVoiceDataAsset, RoverGame

Inheritance: UnityEngine.ScriptableObject
Mostra file Open project: Stumpstump/RoverGame Class Usage Examples

Public Properties

Property Type Description
dataVersion int

Public Methods

Method Description
AddNewLine ( ) : int
AddNewLine ( int givenId, string givenGroup, byte givenStatus, string givenName, string givenText, string givenFileName, LineIssue givenIssues ) : int
ClearClip ( int index, bool markChanged = false ) : void
DeleteAllLines ( ) : void
DeleteLine ( int index, bool createEmptyLineOnNoLines = true ) : void
DuplicateLine ( int index ) : void
FirstInitialize ( ) : void
GetClip ( int index ) : AudioClip
GetFileName ( int index ) : string

NOTE: This will not return a default file name correctly filled, use GetFileNameOrDefault() for that

GetFileNameOrDefault ( int index ) : string
GetGroup ( int index ) : string
GetId ( int index ) : int
GetIssues ( int index ) : LineIssue
GetOutputStatus ( int index ) : bool
GetSpeakerName ( int index ) : string

Note: This will not replace any default values

GetSpeakerNameOrSelectDefault ( int index ) : string
GetSpeechText ( int index ) : string
GetStatus ( int index ) : byte
HasIssue ( int index, LineIssue saughtIssues ) : bool
IntegrityErrorReport ( ) : string
LineCount ( ) : int

This will return how many lines there are currently stored

MakeSureAllDefaultFileNamesAreUnique ( ) : void
MoveLine ( int fromIndex, int toIndex ) : void
MoveLineDown ( int index ) : void
MoveLineUp ( int index ) : void
SanitizeFileName ( string fileName ) : string
SetClip ( int index, AudioClip newClip, bool markChanged = false ) : void
SetDefaultFileName ( int index ) : void
SetFileName ( int index, string newValue, bool forceVerification, bool markChanged = true ) : void
SetGroup ( int index, string newValue ) : void
SetId ( int index, int newValue ) : void
SetIssue ( int index, LineIssue chosenIssue, bool newValue ) : void
SetIssues ( int index, LineIssue newIssues ) : void
SetOutputStatus ( int index, bool newValue ) : void
SetSpeakerName ( int index, string newValue ) : void
SetSpeechText ( int index, string newValue ) : void
SetStatus ( int index, byte newValue ) : void
SortLinesByFileName ( bool descending ) : void
SortLinesBySpeaker ( bool descending, EasyVoiceSettings, settings ) : void
Upgrade ( int newVersion ) : void

This will, if necessary, upgrade the data asset to the given version There is no need to call this manually and Easy Voice will upgrade the asset automatically, when version mismatch is detected

VerifyIntegrity ( ) : bool

Private Methods

Method Description
GenerateUniqueId ( int ourIndex, int minId = 1 ) : int

This will run through all lines and return a unique int id

IdExists ( int seekerIndex, int id ) : bool
MakeSureDefaultFileNameIsUnique ( int index ) : void

This makes sure the current DEFAULT file name is unique to all other file names (i.e. ID is unique and non-clashing with manually typed ones)

MakeSureOtherFileNamesAreUnique ( int index ) : void
OnEnable ( ) : void
Swap ( int index, int otherIndex ) : void

Method Details

AddNewLine() public method

public AddNewLine ( ) : int
return int

AddNewLine() public method

public AddNewLine ( int givenId, string givenGroup, byte givenStatus, string givenName, string givenText, string givenFileName, LineIssue givenIssues ) : int
givenId int
givenGroup string
givenStatus byte
givenName string
givenText string
givenFileName string
givenIssues LineIssue
return int

ClearClip() public method

public ClearClip ( int index, bool markChanged = false ) : void
index int
markChanged bool
return void

DeleteAllLines() public method

public DeleteAllLines ( ) : void
return void

DeleteLine() public method

public DeleteLine ( int index, bool createEmptyLineOnNoLines = true ) : void
index int
createEmptyLineOnNoLines bool
return void

DuplicateLine() public method

public DuplicateLine ( int index ) : void
index int
return void

FirstInitialize() public method

public FirstInitialize ( ) : void
return void

GetClip() public method

public GetClip ( int index ) : AudioClip
index int
return UnityEngine.AudioClip

GetFileName() public method

NOTE: This will not return a default file name correctly filled, use GetFileNameOrDefault() for that
public GetFileName ( int index ) : string
index int
return string

GetFileNameOrDefault() public method

public GetFileNameOrDefault ( int index ) : string
index int
return string

GetGroup() public method

public GetGroup ( int index ) : string
index int
return string

GetId() public method

public GetId ( int index ) : int
index int
return int

GetIssues() public method

public GetIssues ( int index ) : LineIssue
index int
return LineIssue

GetOutputStatus() public method

public GetOutputStatus ( int index ) : bool
index int
return bool

GetSpeakerName() public method

Note: This will not replace any default values
public GetSpeakerName ( int index ) : string
index int
return string

GetSpeakerNameOrSelectDefault() public method

public GetSpeakerNameOrSelectDefault ( int index ) : string
index int
return string

GetSpeechText() public method

public GetSpeechText ( int index ) : string
index int
return string

GetStatus() public method

public GetStatus ( int index ) : byte
index int
return byte

HasIssue() public method

public HasIssue ( int index, LineIssue saughtIssues ) : bool
index int
saughtIssues LineIssue
return bool

IntegrityErrorReport() public method

public IntegrityErrorReport ( ) : string
return string

LineCount() public method

This will return how many lines there are currently stored
public LineCount ( ) : int
return int

MakeSureAllDefaultFileNamesAreUnique() public method

public MakeSureAllDefaultFileNamesAreUnique ( ) : void
return void

MoveLine() public method

public MoveLine ( int fromIndex, int toIndex ) : void
fromIndex int
toIndex int
return void

MoveLineDown() public method

public MoveLineDown ( int index ) : void
index int
return void

MoveLineUp() public method

public MoveLineUp ( int index ) : void
index int
return void

SanitizeFileName() public static method

public static SanitizeFileName ( string fileName ) : string
fileName string
return string

SetClip() public method

public SetClip ( int index, AudioClip newClip, bool markChanged = false ) : void
index int
newClip UnityEngine.AudioClip
markChanged bool
return void

SetDefaultFileName() public method

public SetDefaultFileName ( int index ) : void
index int
return void

SetFileName() public method

public SetFileName ( int index, string newValue, bool forceVerification, bool markChanged = true ) : void
index int
newValue string
forceVerification bool
markChanged bool
return void

SetGroup() public method

public SetGroup ( int index, string newValue ) : void
index int
newValue string
return void

SetId() public method

public SetId ( int index, int newValue ) : void
index int
newValue int
return void

SetIssue() public method

public SetIssue ( int index, LineIssue chosenIssue, bool newValue ) : void
index int
chosenIssue LineIssue
newValue bool
return void

SetIssues() public method

public SetIssues ( int index, LineIssue newIssues ) : void
index int
newIssues LineIssue
return void

SetOutputStatus() public method

public SetOutputStatus ( int index, bool newValue ) : void
index int
newValue bool
return void

SetSpeakerName() public method

public SetSpeakerName ( int index, string newValue ) : void
index int
newValue string
return void

SetSpeechText() public method

public SetSpeechText ( int index, string newValue ) : void
index int
newValue string
return void

SetStatus() public method

public SetStatus ( int index, byte newValue ) : void
index int
newValue byte
return void

SortLinesByFileName() public method

public SortLinesByFileName ( bool descending ) : void
descending bool
return void

SortLinesBySpeaker() public method

public SortLinesBySpeaker ( bool descending, EasyVoiceSettings, settings ) : void
descending bool
settings EasyVoiceSettings,
return void

Upgrade() public method

This will, if necessary, upgrade the data asset to the given version There is no need to call this manually and Easy Voice will upgrade the asset automatically, when version mismatch is detected
public Upgrade ( int newVersion ) : void
newVersion int
return void

VerifyIntegrity() public method

public VerifyIntegrity ( ) : bool
return bool

Property Details

dataVersion public_oe property

public int dataVersion
return int