C# Class FSO.Files.Formats.IFF.Chunks.STR

This chunk type holds text strings. The first two bytes correspond to the format code, of which there are four types. Some chunks in the game do not specify any data after the version number, so be sure to implement bounds checking.

Inheritance: IffChunk

Afficher le fichier Open project: RHY3756547/FreeSO Class Usage Examples

Méthodes publiques

Свойство	Type	Description
DefaultLangCode	STRLangCode
LanguageSetNames	string[]
LanguageSets	FSO.Files.Formats.IFF.Chunks.STRLanguageSet[]

Méthodes publiques

Méthode	Description
GetLanguageSet ( STRLangCode set ) : STRLanguageSet
GetString ( int index ) : string	Gets a string from this chunk.
GetString ( int index, STRLangCode language ) : string
GetStringEntry ( int index ) : STRItem	Gets a STRItem instance from this STR chunk.
GetStringEntry ( int index, STRLangCode language ) : STRItem
InitLanguageSet ( STRLangCode set ) : void
InsertString ( int index, STRItem item ) : void
IsSetInit ( STRLangCode set ) : bool
Read ( IffFile iff, Stream stream ) : void	Reads a STR chunk from a stream.
RemoveString ( int index ) : void
STR ( ) : System
SetString ( int index, string value ) : void
SetString ( int index, string value, STRLangCode language ) : void
SwapString ( int srcindex, int dstindex ) : void
Write ( IffFile iff, Stream stream ) : bool

Method Details

GetLanguageSet() public méthode

public GetLanguageSet ( STRLangCode set ) : STRLanguageSet
set	STRLangCode
Résultat	STRLanguageSet

GetString() public méthode

Gets a string from this chunk.

public GetString ( int index ) : string
index	int	Index of string.
Résultat	string

GetString() public méthode

public GetString ( int index, STRLangCode language ) : string
index	int
language	STRLangCode
Résultat	string

GetStringEntry() public méthode

Gets a STRItem instance from this STR chunk.

public GetStringEntry ( int index ) : STRItem
index	int	Index of STRItem.
Résultat	STRItem

GetStringEntry() public méthode

public GetStringEntry ( int index, STRLangCode language ) : STRItem
index	int
language	STRLangCode
Résultat	STRItem

InitLanguageSet() public méthode

public InitLanguageSet ( STRLangCode set ) : void
set	STRLangCode
Résultat	void

InsertString() public méthode

public InsertString ( int index, STRItem item ) : void
index	int
item	STRItem
Résultat	void

IsSetInit() public méthode

public IsSetInit ( STRLangCode set ) : bool
set	STRLangCode
Résultat	bool

Read() public méthode

Reads a STR chunk from a stream.

public Read ( IffFile iff, Stream stream ) : void
iff	IffFile	An Iff instance.
stream	Stream	A Stream object holding a STR chunk.
Résultat	void

RemoveString() public méthode

public RemoveString ( int index ) : void
index	int
Résultat	void

STR() public méthode

public STR ( ) : System
Résultat	System

SetString() public méthode

public SetString ( int index, string value ) : void
index	int
value	string
Résultat	void

SetString() public méthode

public SetString ( int index, string value, STRLangCode language ) : void
index	int
value	string
language	STRLangCode
Résultat	void

SwapString() public méthode

public SwapString ( int srcindex, int dstindex ) : void
srcindex	int
dstindex	int
Résultat	void

Write() public méthode

public Write ( IffFile iff, Stream stream ) : bool
iff	IffFile
stream	Stream
Résultat	bool

Property Details

DefaultLangCode public_oe static_oe property

public static STRLangCode DefaultLangCode
Résultat	STRLangCode

LanguageSetNames public_oe static_oe property

public static string[] LanguageSetNames
Résultat	string[]

LanguageSets public_oe property

public STRLanguageSet[],FSO.Files.Formats.IFF.Chunks LanguageSets
Résultat	FSO.Files.Formats.IFF.Chunks.STRLanguageSet[]