PluginDescription Class Reference

Public Member Functions
	__construct ($yamlString)
	getFullName ()
	getCompatibleApis ()
	getCompatibleGeniApis ()
	getAuthors ()
	getPrefix ()
	getCommands ()
	getDepend ()
	getDescription ()
	getLoadBefore ()
	getMain ()
	getName ()
	getOrder ()
	getPermissions ()
	getSoftDepend ()
	getVersion ()
	getWebsite ()

Constructor & Destructor Documentation

__construct()

__construct

(

$yamlString

)

Parameters

string | array

$yamlString

                                            {
        $this->loadMap(!is_array($yamlString) ? \yaml_parse($yamlString) : $yamlString);
    }

Member Function Documentation

getAuthors()

getAuthors

(

)

Returns

array

                                {
        return $this->authors;
    }

getCommands()

getCommands

(

)

Returns

array

                                 {
        return $this->commands;
    }

getCompatibleApis()

getCompatibleApis

(

)

Returns

array

                                       {
        return $this->api;
    }

getCompatibleGeniApis()

getCompatibleGeniApis

(

)

Returns

array

                                           {
        return $this->geniapi;
    }

getDepend()

getDepend

(

)

Returns

array

                               {
        return $this->depend;
    }

getDescription()

getDescription

(

)

Returns

string

                                    {
        return $this->description;
    }

getFullName()

getFullName

(

)

Returns

string

                                 {
        return $this->name . " v" . $this->version;
    }

getLoadBefore()

getLoadBefore

(

)

Returns

array

                                   {
        return $this->loadBefore;
    }

getMain()

getMain

(

)

Returns

string

                             {
        return $this->main;
    }

getName()

getName

(

)

Returns

string

                              : string{
        return $this->name;
    }

getOrder()

getOrder

(

)

Returns

int

                              {
        return $this->order;
    }

getPermissions()

getPermissions

(

)

Returns

Permission[]

                                    {
        return $this->permissions;
    }

getPrefix()

getPrefix

(

)

Returns

string

                               {
        return $this->prefix;
    }

getSoftDepend()

getSoftDepend

(

)

Returns

array

                                   {
        return $this->softDepend;
    }

getVersion()

getVersion

(

)

Returns

string

                                {
        return $this->version;
    }

getWebsite()

getWebsite

(

)

Returns

string

                                {
        return $this->website;
    }

---

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

• src/pocketmine/plugin/PluginDescription.php