Public Member Functions
bool	IsValidVersion ()

bool	Init ()

void	UpdateMeta (bool updateOnly=false)

void	Activate ()

void	Parse ()

Static Public Member Functions
static string	NormalizeId (string s)

static bool	IsBuiltinDir (string dirName)

static bool	IsBuiltinPackage (DirectoryInfo dir, string packageId)

Public Attributes
string	title

string	author

string	version

string	id

string	description

string	visibility

string[]	tags

string[][]	dependency

string[][]	incompatible

string[][]	loadAfter

string[][]	loadBefore

bool	builtin

bool	activated

bool	willActivate = true

bool	installed

bool	banned

bool	isInPackages

bool	hasPublishedPackage

bool	downloadStarted

int	loadPriority = 100

int	orderIndex = -1

ModGroup	group

BaseModPackage	blockedBy

string	langDepError

BaseModPackage	duplicateOf

string	parseError

object	item

DirectoryInfo	dirInfo

Text	progressText

Static Public Attributes
const int	defaultLoadPriority = 100

const int	minLoadPriority = -999

const int	maxLoadPriority = 999

static XmlReader	xmlReader

static XmlReaderSettings	readerSetting

Properties
bool	CanActivate `[get]`

Static Private Attributes
static readonly Dictionary< string, string >	builtinPackages

Detailed Description

Definition at line 9 of file BaseModPackage.cs.

Member Function Documentation

◆ Activate()

void BaseModPackage.Activate ( )

inline

Definition at line 275 of file BaseModPackage.cs.

    {
        if (CanActivate)
        {
            int num = ((BaseModManager.Instance == null) ? (-1) : BaseModManager.Instance.packages.IndexOf(this));
            Debug.Log("Activating(" + (num + 1) + ") : " + title + "/" + id);
            activated = true;
            Parse();
        }
    }

References activated, CanActivate, Debug, id, BaseModManager.Instance, BaseModManager.packages, Parse(), and title.

◆ Init()

bool BaseModPackage.Init ( )

inline

Definition at line 144 of file BaseModPackage.cs.

    {
        if (!File.Exists(dirInfo.FullName + "/package.xml"))
        {
            return false;
        }
        UpdateMeta();
        return true;
    }

References dirInfo, and UpdateMeta().

Referenced by ModManager.InitPackagesMeta().

◆ IsBuiltinDir()

static bool BaseModPackage.IsBuiltinDir ( string dirName )

inlinestatic

Definition at line 117 of file BaseModPackage.cs.

    {
        if (!dirName.IsEmpty())
        {
            return builtinPackages.ContainsKey(dirName);
        }
        return false;
    }

References builtinPackages.

Referenced by ModManager.LoadLocalPackages().

◆ IsBuiltinPackage()

static bool BaseModPackage.IsBuiltinPackage	(	DirectoryInfo	dir,
		string	packageId
	)

inlinestatic

Definition at line 126 of file BaseModPackage.cs.

    {
        if (dir != null && builtinPackages.TryGetValue(dir.Name, out var value))
        {
            return NormalizeId(packageId) == value;
        }
        return false;
    }

References builtinPackages, and NormalizeId().

Referenced by UpdateMeta().

◆ IsValidVersion()

bool BaseModPackage.IsValidVersion ( )

inline

Definition at line 135 of file BaseModPackage.cs.

    {
        if (!builtin && !version.IsEmpty() && version.Split('.').Length >= 3)
        {
            return !Version.Get(version).IsBelow(BaseCore.Instance.versionMod);
        }
        return true;
    }

References builtin, Version.Get(), BaseCore.Instance, Version.IsBelow(), version, and BaseCore.versionMod.

Referenced by LayerMod.ShowInfo().

◆ NormalizeId()

static string BaseModPackage.NormalizeId ( string s )

inlinestatic

Definition at line 103 of file BaseModPackage.cs.

    {
        if (s.IsEmpty())
        {
            return null;
        }
        string text = s.Trim().ToLowerInvariant();
        if (!text.IsEmpty())
        {
            return text;
        }
        return null;
    }

Referenced by ModManager.ActivatePackageList(), ModManager.FindIncompatible(), IsBuiltinPackage(), ModManager.LoadLoadOrder(), ModXml.ReadIdRow(), ModManager.RegisterLoaded(), and ModManager.UnmetDependency().

◆ Parse()

void BaseModPackage.Parse ( )

inline

Definition at line 286 of file BaseModPackage.cs.

    {
        DirectoryInfo[] directories = dirInfo.GetDirectories();
        foreach (DirectoryInfo directoryInfo in directories)
        {
            if (directoryInfo.Name.ToLower() == "actor")
            {
                FileInfo[] files = directoryInfo.GetFiles("*.xlsx", SearchOption.TopDirectoryOnly);
                foreach (FileInfo fileInfo in files)
                {
                    MOD.actorSources.Add(new ExcelData(fileInfo.FullName));
                }
                DirectoryInfo[] directories2 = directoryInfo.GetDirectories();
                foreach (DirectoryInfo directoryInfo2 in directories2)
                {
                    Log.App(directoryInfo2.FullName);
                    string text = directoryInfo2.Name.ToLower();
                    if (!(text == "pcc"))
                    {
                        if (!(text == "sprite"))
                        {
                            continue;
                        }
                        files = directoryInfo2.GetFiles();
                        foreach (FileInfo fileInfo2 in files)
                        {
                            if (fileInfo2.Name.EndsWith(".png"))
                            {
                                MOD.sprites.Add(fileInfo2);
                            }
                        }
                    }
                    else
                    {
                        DirectoryInfo[] directories3 = directoryInfo2.GetDirectories();
                        foreach (DirectoryInfo obj in directories3)
                        {
                            MOD.OnAddPcc(obj);
                        }
                    }
                }
            }
            else
            {
                BaseModManager.Instance.ParseExtra(directoryInfo, this);
            }
        }
    }

References MOD.actorSources, ExcelDataList.Add(), ModItemList< T >.Add(), Log.App(), dirInfo, BaseModManager.Instance, MOD.OnAddPcc, BaseModManager.ParseExtra(), and MOD.sprites.

Referenced by Activate().

◆ UpdateMeta()

void BaseModPackage.UpdateMeta ( bool updateOnly = false )

inline

Definition at line 154 of file BaseModPackage.cs.

    {
        string text = dirInfo.FullName + "/package.xml";
        if (!File.Exists(text))
        {
            return;
        }
        byte[] bytes;
        try
        {
            bytes = File.ReadAllBytes(text);
        }
        catch (Exception ex)
        {
            parseError = ex.Message;
            Debug.LogWarning($"#mod package.xml can't be read: {text}\n{ex}");
            return;
        }
        string error;
        XDocument xDocument = ModXml.Load(bytes, out error);
        if (xDocument?.Root == null)
        {
            parseError = error.IsEmpty("no root element");
            Debug.LogWarning("#mod package.xml failed to parse: " + text + "\n" + parseError);
            return;
        }
        string text2 = null;
        string text3 = null;
        string packageId = null;
        string text4 = null;
        string text5 = null;
        string text6 = null;
        string[] array = null;
        int num = 100;
        List<string[]> rows = null;
        List<string[]> rows2 = null;
        List<string[]> rows3 = null;
        List<string[]> rows4 = null;
        try
        {
            foreach (XElement item in xDocument.Root.Descendants())
            {
                string text7 = ModXml.ValidXml(item.Name.LocalName);
                if (text7 == null)
                {
                    Debug.LogWarning("#mod package.xml unknown element <" + item.Name.LocalName + ">, ignored: " + text);
                    continue;
                }
                if (text7 != item.Name.LocalName)
                {
                    Debug.LogWarning("#mod package.xml <" + item.Name.LocalName + "> should be written as <" + text7 + ">, parsed: " + text);
                }
                switch (text7)
                {
                case "title":
                    text2 = ModXml.Text(item);
                    break;
                case "author":
                    text3 = ModXml.Text(item);
                    break;
                case "id":
                    packageId = ModXml.Text(item);
                    break;
                case "description":
                    text4 = item.Value;
                    break;
                case "version":
                    text5 = ModXml.Text(item);
                    break;
                case "tag":
                case "tags":
                    array = ModXml.SplitTags(ModXml.Text(item));
                    break;
                case "loadPriority":
                {
                    if (int.TryParse(ModXml.Text(item), out var result))
                    {
                        num = Mathf.Clamp(result, -999, 999);
                    }
                    break;
                }
                case "visibility":
                    text6 = ModXml.Text(item);
                    break;
                case "dependency":
                    ModXml.ReadIdRow(item, ref rows, text);
                    break;
                case "incompatible":
                    ModXml.ReadIdRow(item, ref rows2, text);
                    break;
                case "loadAfter":
                    ModXml.ReadIdRow(item, ref rows3, text);
                    break;
                case "loadBefore":
                    ModXml.ReadIdRow(item, ref rows4, text);
                    break;
                }
            }
        }
        catch (Exception ex2)
        {
            parseError = ex2.Message;
            Debug.LogWarning($"#mod package.xml failed to parse: {text}\n{ex2}");
            return;
        }
        title = text2;
        author = text3;
        id = packageId;
        description = text4;
        version = text5;
        visibility = text6;
        tags = array;
        loadPriority = num;
        dependency = rows?.ToArray();
        incompatible = rows2?.ToArray();
        loadAfter = rows3?.ToArray();
        loadBefore = rows4?.ToArray();
        builtin = IsBuiltinPackage(dirInfo, packageId);
        parseError = null;
    }

References $, author, builtin, Debug, dependency, description, dirInfo, incompatible, IsBuiltinPackage(), item, ModXml.Load(), loadAfter, loadBefore, loadPriority, parseError, ModXml.ReadIdRow(), ModXml.SplitTags(), tags, ModXml.Text(), title, ModXml.ValidXml(), version, and visibility.

Referenced by Steam.CreateUserContent(), Init(), and LayerMod.OnInit().

Member Data Documentation

◆ activated

bool BaseModPackage.activated

Definition at line 45 of file BaseModPackage.cs.

Referenced by Activate(), ModManager.MapActivatedPackages(), LayerFeedback.OnInit(), and LayerFeedback.Submit().

◆ author

string BaseModPackage.author

Definition at line 23 of file BaseModPackage.cs.

Referenced by LayerMod.ShowInfo(), and UpdateMeta().

◆ banned

bool BaseModPackage.banned

Definition at line 51 of file BaseModPackage.cs.

◆ blockedBy

BaseModPackage BaseModPackage.blockedBy

Definition at line 65 of file BaseModPackage.cs.

Referenced by LayerMod.ShowInfo().

◆ builtin

bool BaseModPackage.builtin

Definition at line 43 of file BaseModPackage.cs.

Referenced by ModManager.CountUserMod(), LayerMod.CreateCallbacks(), ModManager.FindIncompatible(), IsValidVersion(), LayerMod.LeaveGroup(), ModManager.LoadLoadOrder(), LayerMod.MoveTo(), LayerMod.NewGroup(), LayerFeedback.OnInit(), ModManager.ParseExtra(), ModManager.RegisterLoaded(), LayerMod.SetGroup(), LayerMod.ShowInfo(), LayerFeedback.Submit(), and UpdateMeta().

◆ builtinPackages

readonly Dictionary<string, string> BaseModPackage.builtinPackages

staticprivate

Initial value:

= new Dictionary<string, string>
    {
        { "_Elona", "elin_core1" },
        { "_Lang_Chinese", "elin_language_chinese" },
        { "_ModdingKit", "elin.plugins.modding" },
        { "Mod_Slot", "elin_minigame_slot" }
    }

Definition at line 79 of file BaseModPackage.cs.

Referenced by IsBuiltinDir(), and IsBuiltinPackage().

◆ defaultLoadPriority

const int BaseModPackage.defaultLoadPriority = 100

static

Definition at line 11 of file BaseModPackage.cs.

◆ dependency

string [][] BaseModPackage.dependency

Definition at line 35 of file BaseModPackage.cs.

Referenced by LayerMod.ShowInfo(), ModManager.UnmetDependency(), and UpdateMeta().

◆ description

string BaseModPackage.description

Definition at line 29 of file BaseModPackage.cs.

Referenced by Steam.CreateItemData(), LayerMod.ShowInfo(), and UpdateMeta().

◆ dirInfo

DirectoryInfo BaseModPackage.dirInfo

Definition at line 75 of file BaseModPackage.cs.

Referenced by Steam.CreateItemData(), ModManager.FormatLoadOrder(), LayerPickPCC.GetPartProvider(), ModManager.Halt(), Init(), ModManager.InitPackagesMeta(), ModManager.InstallWorkshopPackage(), ModManager.LoadCachedWorkshopPackages(), ModManager.LoadLoadOrder(), Parse(), ModManager.SaveLoadOrder(), LayerMod.ShowInfo(), ModManager.UnmetDependency(), and UpdateMeta().

◆ downloadStarted

bool BaseModPackage.downloadStarted

Definition at line 57 of file BaseModPackage.cs.

Referenced by ModManager.DownloadSubscriptions().

◆ duplicateOf

BaseModPackage BaseModPackage.duplicateOf

Definition at line 69 of file BaseModPackage.cs.

Referenced by LayerMod.ShowInfo().

◆ group

ModGroup BaseModPackage.group

Definition at line 63 of file BaseModPackage.cs.

Referenced by LayerMod.AddGroupButtons(), LayerMod.CreateCallbacks(), LayerMod.LeaveGroup(), LayerMod.Members(), LayerMod.MoveTo(), LayerMod.OnReorder(), ModManager.SaveLoadOrder(), LayerMod.SetGroup(), and ModManager.SplitGroups().

◆ hasPublishedPackage

bool BaseModPackage.hasPublishedPackage

Definition at line 55 of file BaseModPackage.cs.

Referenced by ModManager.ActivatePackageList().

◆ id

string BaseModPackage.id

Definition at line 27 of file BaseModPackage.cs.

Referenced by Activate(), ModManager.ActivatePackageList(), Steam.CreateItemData(), ModManager.FindIncompatible(), ModManager.FormatLoadOrder(), ModManager.InitPackagesMeta(), ModManager.LoadLoadOrder(), ModManager.MapActivatedPackages(), LayerFeedback.OnInit(), ModManager.RegisterLoaded(), and LayerMod.ShowInfo().

◆ incompatible

string [][] BaseModPackage.incompatible

Definition at line 37 of file BaseModPackage.cs.

Referenced by ModManager.FindIncompatible(), ModManager.RegisterLoaded(), LayerMod.ShowInfo(), and UpdateMeta().

◆ installed

bool BaseModPackage.installed

Definition at line 49 of file BaseModPackage.cs.

Referenced by ModManager.DownloadSubscriptions(), and ModManager.WorkshopDownload.WorkshopDownload().

◆ isInPackages

bool BaseModPackage.isInPackages

Definition at line 53 of file BaseModPackage.cs.

◆ item

object BaseModPackage.item

Definition at line 73 of file BaseModPackage.cs.

Referenced by ModManager.DownloadSubscriptions(), LayerMod.SteamPreview(), UpdateMeta(), and ModManager.WorkshopDownload.WorkshopDownload().

◆ langDepError

string BaseModPackage.langDepError

Definition at line 67 of file BaseModPackage.cs.

Referenced by LayerMod.ShowInfo().

◆ loadAfter

string [][] BaseModPackage.loadAfter

Definition at line 39 of file BaseModPackage.cs.

Referenced by LayerMod.ShowInfo(), and UpdateMeta().

◆ loadBefore

string [][] BaseModPackage.loadBefore

Definition at line 41 of file BaseModPackage.cs.

Referenced by LayerMod.ShowInfo(), and UpdateMeta().

◆ loadPriority

int BaseModPackage.loadPriority = 100

Definition at line 59 of file BaseModPackage.cs.

Referenced by UpdateMeta().

◆ maxLoadPriority

const int BaseModPackage.maxLoadPriority = 999

static

Definition at line 15 of file BaseModPackage.cs.

◆ minLoadPriority

const int BaseModPackage.minLoadPriority = -999

static

Definition at line 13 of file BaseModPackage.cs.

◆ orderIndex

int BaseModPackage.orderIndex = -1

Definition at line 61 of file BaseModPackage.cs.

◆ parseError

string BaseModPackage.parseError

Definition at line 71 of file BaseModPackage.cs.

Referenced by ModManager.Halt(), ModManager.InitPackagesMeta(), ModManager.RefreshMods(), LayerMod.ShowInfo(), and UpdateMeta().

◆ progressText

Text BaseModPackage.progressText

Definition at line 77 of file BaseModPackage.cs.

◆ readerSetting

XmlReaderSettings BaseModPackage.readerSetting

static

Definition at line 19 of file BaseModPackage.cs.

◆ tags

string [] BaseModPackage.tags

Definition at line 33 of file BaseModPackage.cs.

Referenced by Steam.CreateItemData(), LayerMod.ShowInfo(), and UpdateMeta().

◆ title

string BaseModPackage.title

Definition at line 21 of file BaseModPackage.cs.

Referenced by Activate(), ModManager.ActivatePackageList(), Steam.CreateItemData(), LayerPickPCC.GetPartProviderString(), ModManager.Halt(), ModManager.InitPackagesMeta(), LayerMod.ShowInfo(), ModManager.UnmetDependency(), and UpdateMeta().

◆ version

string BaseModPackage.version

Definition at line 25 of file BaseModPackage.cs.

Referenced by IsValidVersion(), LayerMod.ShowInfo(), and UpdateMeta().

◆ visibility

string BaseModPackage.visibility

Definition at line 31 of file BaseModPackage.cs.

Referenced by Steam.CreateItemData(), and UpdateMeta().

◆ willActivate

bool BaseModPackage.willActivate = true

Definition at line 47 of file BaseModPackage.cs.

Referenced by LayerMod.SetGroupRow(), and LayerMod.ShowInfo().

◆ xmlReader

XmlReader BaseModPackage.xmlReader

static

Definition at line 17 of file BaseModPackage.cs.

Property Documentation

◆ CanActivate

bool BaseModPackage.CanActivate

get

Definition at line 87 of file BaseModPackage.cs.

    {
        get
        {
            if (!hasPublishedPackage && installed)
            {
                DirectoryInfo directoryInfo = dirInfo;
                if (directoryInfo != null && directoryInfo.Exists)
                {
                    return willActivate;
                }
            }
            return false;
        }
    }

Referenced by Activate(), and ModManager.RefreshMods().

The documentation for this class was generated from the following file:

Elin/Plugins.basecore/BaseModPackage.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Static Private Attributes

Detailed Description

Member Function Documentation

◆ Activate()

◆ Init()

◆ IsBuiltinDir()

◆ IsBuiltinPackage()

◆ IsValidVersion()

◆ NormalizeId()

◆ Parse()

◆ UpdateMeta()

Member Data Documentation

◆ activated

◆ author

◆ banned

◆ blockedBy

◆ builtin

◆ builtinPackages

◆ defaultLoadPriority

◆ dependency

◆ description

◆ dirInfo

◆ downloadStarted

◆ duplicateOf

◆ group

◆ hasPublishedPackage

◆ id

◆ incompatible

◆ installed

◆ isInPackages

◆ item

◆ langDepError

◆ loadAfter

◆ loadBefore

◆ loadPriority

◆ maxLoadPriority

◆ minLoadPriority

◆ orderIndex

◆ parseError

◆ progressText

◆ readerSetting

◆ tags

◆ title

◆ version

◆ visibility

◆ willActivate

◆ xmlReader

Property Documentation

◆ CanActivate