GetPluginName
Script function

world.GetPluginName

DOC_scripting Read about scripting

Type

Method

Summary

Returns the name of the current plugin

Prototype

BSTR GetPluginName();

DOC_data_types View list of data type meanings

Description

Returns the name of the currently-executing plugin. If no plugin is executing an empty string will be returned.

VBscript example

world.Note world.GetPluginName


Jscript example

world.Note (world.GetPluginName ());


PerlScript example

$world->Note ($world->GetPluginName ());


Python example

world.Note (world.GetPluginName )


Lua example

Note (GetPluginName ())


Return value

The name of the current plugin, or an empty string if no plugin is running.



See Also ...

Topics

DOC_aliases Aliases
DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_timers Timers
DOC_triggers Triggers
DOC_variables Variables

Functions

FNC_BroadcastPlugin BroadcastPlugin (Broadcasts a message to all installed plugins)
FNC_CallPlugin CallPlugin (Calls a routine in a plugin)
FNC_EnablePlugin EnablePlugin (Enables or disables the specified plugin)
FNC_GetPluginID GetPluginID (Returns the 24-character ID of the current plugin)
FNC_GetPluginInfo GetPluginInfo (Gets details about a specified plugin)
FNC_GetPluginList GetPluginList (Gets a list of installed plugins.)
FNC_GetPluginTimerInfo GetPluginTimerInfo (Gets details about a named timer for a specified plugin)
FNC_GetPluginTimerList GetPluginTimerList (Gets the list of timers in a specified plugin)
FNC_GetPluginVariable GetPluginVariable (Gets the contents of a variable belonging to a plugin)
FNC_GetPluginVariableList GetPluginVariableList (Gets the list of variables in a specified plugin)
FNC_IsPluginInstalled IsPluginInstalled (Checks to see if a particular plugin is installed)
FNC_LoadPlugin LoadPlugin (Loads a plugin from disk)
FNC_PluginSupports PluginSupports (Checks if a plugin supports a particular routine)
FNC_ReloadPlugin ReloadPlugin (Reloads an installed plugin)
FNC_SaveState SaveState (Saves the state of the current plugin)

(Help topic: function=GetPluginName)

DOC_contents Documentation contents page