[Home] [Downloads] [Search] [Help/forum]

DeleteVariable

Script function

world.DeleteVariable

Read about scripting

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


Return value

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

View list of return code meanings

See Also ...

Topics

Arrays
Plugins
Scripting
Variables

Functions

(GetVariable) Gets the contents of a variable
(GetVariableList) Gets the list of variables
(SetVariable) Sets the value of a variable

(Help topic: function=DeleteVariable)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]