DeleteGroup
Script function

world.DeleteGroup

DOC_scripting Read about scripting

Type

Method

Summary

Deletes a group of triggers, aliases and timers

Prototype

long DeleteGroup(BSTR GroupName);

DOC_data_types View list of data type meanings

Description

Triggers, aliases and timers can be placed in "groups" where a group is a bunch of related items. Groups have names, there is no restriction on the name of a group. Ungrouped items have blank (empty) names.

To delete an entire group of triggers, aliases and timers do this:

world.DeleteGroup "groupname"

For debugging purposes the function returns a count of the number of members deleted. eg.

dim mycount
mycount = world.DeleteGroup ("groupname")

If you are using plugins only the members of the current plugin (if any) are deleted. If the call is made outside a plugin only the members of the group that are not in a plugin are deleted.

VBscript example

world.DeleteGroup "groupname"


Jscript example

world.DeleteGroup ("groupname");


PerlScript example

$world->DeleteGroup ("groupname");


Python example

world.DeleteGroup ("groupname")


Lua example

DeleteGroup ("groupname")


Return value

A count of the number of items deleted.



See Also ...

Topics

DOC_aliases Aliases
DOC_group Groups
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_DeleteAliasGroup DeleteAliasGroup (Deletes a group of aliases)
FNC_DeleteTimerGroup DeleteTimerGroup (Deletes a group of timers)
FNC_DeleteTriggerGroup DeleteTriggerGroup (Deletes a group of triggers)
FNC_EnableAliasGroup EnableAliasGroup (Enables/disables a group of aliases)
FNC_EnableGroup EnableGroup (Enables/disables a group of triggers, aliases and timers)
FNC_EnableTimerGroup EnableTimerGroup (Enables/disables a group of timers)
FNC_EnableTriggerGroup EnableTriggerGroup (Enables/disables a group of triggers)
FNC_GetAliasInfo GetAliasInfo (Gets details about an alias)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTriggerInfo GetTriggerInfo (Gets details about a named trigger)

(Help topic: function=DeleteGroup)

DOC_contents Documentation contents page