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

MUSHclient scripting

Description of MUSHclient world function: world.ChangeDir


Name ChangeDir
Type Method
Summary Changes the MUSHclient working directory
Prototype long ChangeDir(BSTR Path);

View list of data type meanings

Description

This lets you change the current working directory used by MUSHclient. This is useful for situations (like plugins) where you want to load files relative to the plugin location but are unsure if the working directory is at the plugin location. eg.

ChangeDir (GetInfo (66)) --> ensure directory is MUSHclient.exe directory

Note that some actions (like opening world files) may change the directory (eg. to the world file directory) as a side-effect.


Note: Available in version 3.80 onwards.


VBscript example
ChangeDir GetInfo (66)
Lua example
ChangeDir (GetInfo (66))
Returns 0 - Did not change directory
1 - Did it OK
Introduced in version 3.80

See also ...

Function Description
GetInfo Gets information about the current world

Search for script function

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.

Search for:   

Leave blank to show all functions.


Return codes

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

You can view a list of the return codes


Function prototypes

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

You can view a list of the data types used in function prototypes


View all functions

[Back]

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]