world.DeleteVariable

MUSHclient script function (Method)

Deletes a variable

Prototype

long DeleteVariable(BSTR VariableName);

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")

Return value

eInvalidObjectLabel: The alias name is not valid
eVariableNotFound: The variable does not exist
eOK: deleted OK

Return code meanings

Related topic

Variables

See also