C# Class KFreonLib.Scripting.ModMaker.ModJob

This is the object for storing .mod job data.

Mostra file Open project: ME3Explorer/ME3Explorer Class Usage Examples

Public Properties

Property	Type	Description
ExpIDs	List
JobType	string
Length	uint
Name	string
OrigExpIDs	List
OrigPCCs	List
OriginalScript	string
PCCs	List
Script	string
Texname	string
WhichGame	int

Public Methods

Method	Description
DetectJobType ( ) : string	Decides what current job is. If a texture job, returns TEXTURE, else OTHER. For now anyway, likely add mesh detection later.
FixLegacyDLCPaths ( ) : void	Corrects incorrect DLC PCC paths from before ME3 DLC's were extracted.
GenerateJobThumbnail ( ) : Image	Returns a thumbnail sized bitmap of current job data (if texture).
GetJobDetails ( bool update, bool &versionConflict, int version ) : bool	Gets details, like pcc's and expID's, from current script and sets local properties. Properties: ExpID's, PCC's, Texname, WhichGame, JobType.
ModJob ( ) : System	Constructor. Empty cos things get added dynamically.
UpdateJob ( List BIOGames, string ExecFolder ) : bool	Updates current job script to new format. Returns true if all bits to udpdate are found. NOTE that true does not mean updated script works.
WriteJobToFile ( FileStream fs ) : void	Write current job to fileStream.

Private Methods

Method	Description
GuessGame ( List pccs ) : int

Method Details

DetectJobType() public method

Decides what current job is. If a texture job, returns TEXTURE, else OTHER. For now anyway, likely add mesh detection later.

public DetectJobType ( ) : string
return	string

FixLegacyDLCPaths() public method

Corrects incorrect DLC PCC paths from before ME3 DLC's were extracted.

public FixLegacyDLCPaths ( ) : void
return	void

GenerateJobThumbnail() public method

Returns a thumbnail sized bitmap of current job data (if texture).

public GenerateJobThumbnail ( ) : Image
return	Image

GetJobDetails() public method

Gets details, like pcc's and expID's, from current script and sets local properties. Properties: ExpID's, PCC's, Texname, WhichGame, JobType.

public GetJobDetails ( bool update, bool &versionConflict, int version ) : bool
update	bool
versionConflict	bool
version	int
return	bool

ModJob() public method

Constructor. Empty cos things get added dynamically.

public ModJob ( ) : System
return	System

UpdateJob() public method

Updates current job script to new format. Returns true if all bits to udpdate are found. NOTE that true does not mean updated script works.

public UpdateJob ( List BIOGames, string ExecFolder ) : bool
BIOGames	List	List of BIOGame paths for the games. MUST have only 3 elements. Each can be null if game files not found.
ExecFolder	string	Path to the ME3Explorer \exec\ folder.
return	bool

WriteJobToFile() public method

Write current job to fileStream.

public WriteJobToFile ( FileStream fs ) : void
fs	System.IO.FileStream	FileStream to write to.
return	void

Property Details

ExpIDs public_oe property

public List ExpIDs
return	List

JobType public_oe property

public string JobType
return	string

Length public_oe property

public uint Length
return	uint

Name public_oe property

public string Name
return	string

OrigExpIDs public_oe property

public List OrigExpIDs
return	List

OrigPCCs public_oe property

public List OrigPCCs
return	List

OriginalScript public_oe property

public string OriginalScript
return	string

PCCs public_oe property

public List PCCs
return	List

Script public_oe property

public string Script
return	string

Texname public_oe property

public string Texname
return	string

WhichGame public_oe property

public int WhichGame
return	int