MUSHclient scripting

Description of MUSHclient world function: world.DeleteVariable

Name	DeleteVariable
Type	Method
Summary	Deletes a variable
Prototype	`long DeleteVariable(BSTR VariableName);` View list of data type meanings
Description	Deletes the named variable.
VBscript example	`world.DeleteVariable "myvariable"`
Jscript example	`world.DeleteVariable("myvariable");`
PerlScript example	`$world->DeleteVariable("myvariable");`
Python example	`world.DeleteVariable("myvariable")`
Lua example	`DeleteVariable("myvariable")`
Returns	`eInvalidObjectLabel: The alias name is not valid eVariableNotFound: The variable does not exist eOK: deleted OK` View list of return code meanings

See also ...

Function	Description
GetVariable	Gets the contents of a variable
GetVariableList	Gets the list of variables
SetVariable	Sets the value of a variable

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.