gear::xsi::plugin Namespace Reference

Functions
def	pluginExists
	Check if given plugin name exists.
def	getPluginPath
	Return the path of given plugin name.
def	getPluginFullPath
	Return the full path (including filename) of given plugin name.

---

Detailed Description

    This file is part of GEAR.

    GEAR is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/lgpl.html>.

    Author:     Jeremie Passerin      geerem@hotmail.com
    Company:    Studio Nest (TM)
    Date:       2010 / 11 / 15

Author:

Jeremie Passerin

---

Function Documentation

def gear::xsi::plugin::pluginExists	(		names,
			all = True
	)

Check if given plugin name exists.

Parameters:

name

String - Plugin Name.

Returns:

Boolean - True if plugin exists

def gear::xsi::plugin::getPluginPath

(

name

)

Return the path of given plugin name.

Parameters:

name

String - Plugin Name.

Returns:

String - plugin path. False if plugin wasn't found.

def gear::xsi::plugin::getPluginFullPath

(

name

)

Return the full path (including filename) of given plugin name.

Parameters:

name

String - Plugin Name.

Returns:

String - plugin full path. False if plugin wasn't found.