hsproject

Documentation

Overview

Package hsproject contains Hellspawner's Project implementation

Index

• type Project
  • func CreateNew(fileName string) (*Project, error)
  • func LoadFromFile(fileName string) (*Project, error)
  • func (p *Project) CreateNewFile(fileType hsfiletypes.FileType, path *hscommon.PathEntry) (err error)
  • func (p *Project) CreateNewFolder(path *hscommon.PathEntry) (err error)
  • func (p *Project) FindPathEntry(path string) *hscommon.PathEntry
  • func (p *Project) GetFileStructure() (*hscommon.PathEntry, error)
  • func (p *Project) GetMPQFileNodes(mpq d2interface.Archive, config *hsconfig.Config) *hscommon.PathEntry
  • func (p *Project) GetProjectFileContentPath() string
  • func (p *Project) GetProjectFilePath() string
  • func (p *Project) InvalidateFileStructure()
  • func (p *Project) ReloadAuxiliaryMPQs(config *hsconfig.Config) (err error)
  • func (p *Project) RenameFile(path string)
  • func (p *Project) Save() error
  • func (p *Project) ValidateAuxiliaryMPQs(config *hsconfig.Config) error

Types

type Project

type Project struct {
	ProjectName   string
	Description   string
	Author        string
	AuxiliaryMPQs []string
	// contains filtered or unexported fields
}

Project represents HellSpawner's project

func CreateNew

func CreateNew(fileName string) (*Project, error)

CreateNew creates new project

func LoadFromFile

func LoadFromFile(fileName string) (*Project, error)

LoadFromFile loads projects file

func (*Project) CreateNewFile

func (p *Project) CreateNewFile(fileType hsfiletypes.FileType, path *hscommon.PathEntry) (err error)

CreateNewFile creates a new file

func (*Project) CreateNewFolder

func (p *Project) CreateNewFolder(path *hscommon.PathEntry) (err error)

CreateNewFolder creates a new directory

func (*Project) FindPathEntry

func (p *Project) FindPathEntry(path string) *hscommon.PathEntry

FindPathEntry search for path entry in project's cahe

func (*Project) GetFileStructure

func (p *Project) GetFileStructure() (*hscommon.PathEntry, error)

GetFileStructure returns project's file structure

func (*Project) GetMPQFileNodes

func (p *Project) GetMPQFileNodes(mpq d2interface.Archive, config *hsconfig.Config) *hscommon.PathEntry

GetMPQFileNodes returns mpq's node

func (*Project) GetProjectFileContentPath

func (p *Project) GetProjectFileContentPath() string

GetProjectFileContentPath returns path to project's content

func (*Project) GetProjectFilePath

func (p *Project) GetProjectFilePath() string

GetProjectFilePath returns project's file path

func (*Project) InvalidateFileStructure

func (p *Project) InvalidateFileStructure()

InvalidateFileStructure cleans project's files structure

func (*Project) ReloadAuxiliaryMPQs

func (p *Project) ReloadAuxiliaryMPQs(config *hsconfig.Config) (err error)

ReloadAuxiliaryMPQs reloads auxiliary MPQs

func (*Project) RenameFile

func (p *Project) RenameFile(path string)

RenameFile renames project's file

func (*Project) Save

func (p *Project) Save() error

Save saves project

func (*Project) ValidateAuxiliaryMPQs

func (p *Project) ValidateAuxiliaryMPQs(config *hsconfig.Config) error

ValidateAuxiliaryMPQs creates auxiliary mpq's list