group `globalFunctions` {#group__globalFunctions}

Summary

Members	Descriptions
`public` `Unit` `getUnit(int` `type,String name,uint32_t mode,uint32_t nUnitId)`	Get a unit by type, name, mode and nUnitId.
`public` `Unit` `getUnit(int` `type,uint32_t classId,uint32_t mode,uint32_t nUnitId)`	Get a unit by type, classId, mode and nUnitId.
`public object[]` `getPath(uint32_t Area,uint32_t srcX,uint32_t srcY,uint32_t dstX,int` `dstY,uint32_t reductionType,uint32_t Radius)`	Creates a path (walking or teleporting) from the source to the destination.
`public object[]` `getPath(uint32_t Area,uint32_t srcX,uint32_t srcY,uint32_t dstX,intdstY,uint32_t reductionType,uint32_t Radius,bool()(int32_t x, int32_t y) reject,bool()(object curPt,int` i, object[] pts) `reduce,int32_t(*)(int32_t x, int32_t y) mutate)`	Creates a path (walking or teleporting) from the source to the destination.
`public unsigned short` `getCollision(uint32_t nLevelId,int32_t nX,int32_t nY)`	Get the collision flags at a given point in a given area.
`public` `int` `getMercHP()`	Get the health points of the controlled unit's merc.
`public` `int` `getCursorType()`	Get the cursor type from p_D2CLIENT_RegularCursorType.
`public` `int` `getCursorType(int` `nType)`	Get the cursor type from p_D2CLIENT_RegularCursorType if nType != 1, from p_D2CLIENT_ShopCursorType if nType == 1.
`public` `int` `getSkillByName(String skillName)`	Get skill ID by name.
`public String` `getSkillById(int` `skillId)`	Get skill name by ID.
`public String` `getLocaleString(uint16_t localeId)`	Get the String in the current locale that corresponds to the given id.
`public` `int` `getTextSize(String string,int` `font,bool asObject)`	Get the width and height of the given text in the given font.
`public` `int` `getThreadPriority()`	Get the priority of the current thread.
`public bool` `getUIFlag(int` `nUIId)`	Get whether or not a UI flag is set.
`public` `int` `getTradeInfo(int` `nMode)`	Get the TradeFlag or RecentTradeId.
`public bool` `getWaypoint(int` `nWaypointId)`	Get whether the controlled unit has the given waypoint.
`public` `D2BSScript` `getScript(bool currentScript)`	Get the current or first context.
`public` `D2BSScript` `getScript(int` `threadId)`	Get a script by thread id.
`public` `D2BSScript` `getScript(String name)`	Get a script by filename.
`public` `D2BSScript` `getScript()`	Get the first script.
`public` `Room` `getRoom(uint32_t levelId)`	Get the first room in area given by level id.
`public` `Room` `getRoom(uint32_t levelId,int` `x,int` `y)`	Get the room that the given point is in from the given level id.
`public` `Room` `getRoom(int` `x,int` `y)`	Get the room that the given point is in.
`public` `Room` `getRoom()`	Get the first room in the current area.
`public` `Party` `getParty()`	Get the first party.
`public` `Party` `getParty(String name)`	Get the party line for the player with the given name.
`public` `Party` `getParty(uint32_t playerId)`	Get the party line for the player with the given player id.
`public` `Party` `getParty(Unit` `player)`	Get the party line that corresponds to the given unit.
`public` `PresetUnit` `getPresetUnit(uint32_t levelId,int` `nType,int` `nClassId)`	Get the first PresetUnit of the given type and class id.
`public` `PresetUnit` `getPresetUnits(uint32_t levelId,int` `nType,int` `nClassId)`	Get an array of PresetUnit s of the given type and class id.
`public` `Area` `getArea()`	Get the Area where the controlled unit currently resides.
`public` `Area` `getArea(int32_t nArea)`	Get the Area for area ID nArea.
`public String` `getBaseStat(String szTableName,int32_t nClassId,String szStatName)`	Get the base stat from the given table with the given class ID and stat name.
`public String` `getBaseStat(int32_t nBaseStat,int32_t nClassId,String szStatName)`	Get the base stat from the given table with the given class ID and stat name.
`public String` `getBaseStat(String szTableName,int32_t nClassId,int32_t nStat)`	Get the base stat from the given table with the given class ID and stat ID.
`public String` `getBaseStat(int32_t nBaseStat,int32_t nClassId,int32_t nStat)`	Get the base stat from the given table with the given class ID and stat ID.
`public` `Control` `getControl(int32_t nType,int32_t nX,int32_t nY,int32_t nXSize,int32_t nYSize)`	Get the control specified by type, location and size.
`public bool` `getPlayerFlag(int` `nFirstUnitId,int` `nSecondUnitId,int` `nFlag)`	Get the relation between two units.
`public` `int` `getTickCount()`	Get the tick count.
`public` `Unit` `getInteractedNPC()`	Get the Unit that the controlled Unit is currently interacting with.
`public void` `print(...)`	Print the String representation of the arguments to the console.
`public void` `delay(uint32_t nDelay)`	Delay for nDelay milliseconds.
`public` `D2BSScript` `load(String file,...)`	Load file and create a thread with it's main function.
`public bool` `isIncluded(String file)`	Determine whether a file has been included yet or not.
`public bool` `include(String file)`	Include file from the scriptDir\libs directory.
`public void` `stop(int` `stop)`	Conditionally stop current script.
`public void` `stop(bool stop)`	Conditionnaly stop current script.
`public` `int` `rand(int32_t low,int32_t high)`	Return a random number between low and high.
`public void` `copy(String txt)`	Copy txt to clipboard.
`public` `int` `sendCopyData(String windowClassName,String windowName,int32_t nModeId,String data)`	Send data to another window by means of the WM_COPYDATA message.
`public` `int` `sendCopyData(HWND hWnd,String dummy,int32_t nModeId,String data)`	Send data to another window by means of the WM_COPYDATA message.
`public String` `sendDDE(int32_t mode,String pszDDEServer,String pszTopic,String pszItem)`	Send data to a DDE server by means of DdeClientTransaction.
`public bool` `keystate(int` `vKey)`	Get whether or not a key is pressed.
`public void` `addEventListener(String event,Function eventHandler)`	Add an event handler to the list of listeners for the given event.
`public void` `removeEventListener(String event,Function eventHandler)`	Removes a previously added event from the listener list.
`public void` `clearEvent(String event)`	Clear the event handler list for given event.
`public void` `clearAllEvents()`	Clear all event handlers (from all events).
`public bool` `js_strict()`	Get whether or not the JSOPTION_STRICT flag is set.
`public void` `js_strict(bool setStrictFlag)`	Set or clear the JSOPTION_STRICT flag.
`public String` `version()`	Get the D2BS version string.
`public void` `version(int` `a)`	Print the D2BS version string.
`public void` `scriptBroadcast(...)`	Broadcast a message to all other scripts.
`public String` `sqlite_version()`	Get the sqlite version string (from sqlite3_version).
`public double` `sqlite_memusage()`	Return the sqlite memory usage.
`public` `Folder` `dopen(String name)`	Get the Folder object for the directory scriptPath\name.
`public void` `debugLog(...)`	Log the String representation of the arguments.
`public void` `showConsole()`	Show the console.
`public void` `hideConsole()`	Hide the console.
`public void` `login()`	Loads the default (either from config or copydata or DDE) profile from d2bs.ini and gets to the lobby (for battle.net chars) or into a game (for single player characters).
`public void` `login(String profile)`	Loads the profile from d2bs.ini and gets to the lobby (for battle.net chars) or into a game (for single player characters).
`public bool` `selectCharacter(String profile)`	Select the character from the given profile.
`public void` `createGame(String name,String pass,int32_t diff)`	Create a game with the given name and password in the given difficulty.
`public void` `joinGame(String name,String pass)`	Join a game with the given name and password.
`public void` `addProfile(String profile,String mode,String gateway,String username,String password,String charname,int` `spDifficulty)`	Create a profile with the given profile name, mode, gateway, username, password, character name and single player difficulty.
`public` `int` `getLocation()`	Get the current OOG location.
`public void` `loadMpq(String path)`	Load an mpq file.
`public bool` `submitItem()`	Submit the item on the cursor to the open screen (like the add sockets screen).
`public` `int` `getMouseCoords(bool nFlag,bool nReturn)`	Get the mouse coordinates (in screen or map space) and return as an array.
`public` `Unit` `copyUnit(Unit` `other)`	Copy the cached data associated with given unit.
`public bool` `clickMap(uint16_t nClickType,uint16_t nShift,Unit` `toClick)`	Click on the map with the given click type and possibly shift at the given unit.
`public bool` `clickMap(uint16_t nClickType,bool nShift,Unit` `toClick)`	Click on the map with the given click type and possibly shift at the given unit.
`public bool` `clickMap(uint16_t nClickType,uint16_t nShift,uint16_t nX,uint16_t nY)`	Click on the map with the given click type and possibly shift at the given point.
`public bool` `clickMap(uint16_t nClickType,bool nShift,uint16_t nX,uint16_t nY)`	Click on the map with the given click type and possibly shift at the given point.
`public bool` `acceptTrade(int` `action)`	Get or do something to do with accepting trade.
`public bool` `acceptTrade()`	Accept a trade if not already accepted, cancel a trade if already accepted.
`public void` `tradeOk()`	Hit the OK button to open the trade window.
`public object[]` `getDialogLines()`	Get the lines of dialog of whatever you're talking to.
`public void` `beep(int` `nBeepId)`	Beep with beep ID nBeepId.
`public void` `clickItem(Unit` `item)`	Click an item.
`public void` `clickItem(int` `nClickType,int` `nBodyLoc)`	Click on a body location with a certain click type.
`public void` `clickItem(int` `nClickType,Unit` `item)`	Click on a given item with the given click type.
`public void` `clickItem(int` `nClickType,int` `nX,int` `nY,int` `nLoc)`	Click an item location with the given click type.
`public double` `getDistance(Unit` `a)`	Get the euclidean distance from me to a.
`public double` `getDistance(Unit` `a,Unit` `b)`	Get the euclidean distance from a to b.
`public double` `getDistance(Unit` `a,int32_t bx,int32_t by)`	Get the euclidean distance from a to b.
`public double` `getDistance(int32_t ax,int32_t ay)`	Get the euclidean distance from me to a.
`public double` `getDistance(int32_t ax,int32_t ay,Unit` `b)`	Get the euclidean distance from a to b.
`public double` `getDistance(int32_t ax,int32_t ay,int32_t bx,int32_t by)`	Get the euclidean distance from a to b.
`public void` `gold(int` `nGold,int` `nMode)`	Do something with some gold.
`public` `int` `checkCollision(Unit` `a,Unit` `b,int` `nBitMask)`	Check if two units collide.
`public bool` `playSound(int` `nSoundId)`	Play d2 sound by id.
`public void` `quit()`	Quit the game.
`public void` `quitGame()`	Quit Diablo II.
`public bool` `say(...)`	Say the string equivalent of the each of the arguments.
`public bool` `clickParty(Party` `player,int` `nMode)`	Click one of the buttons in the party screen for the given player.
`public` `int` `weaponSwitch(int32_t dummy)`	Get which weapon switch is being used.
`public void` `transmute()`	Hit the transmute button.
`public void` `useStatPoint(uint16_t statType,uint32_t count)`	Use a stat point.
`public void` `useSkillPoint(uint16_t skill,uint32_t count)`	Use a skill point.
`public void` `takeScreenshot()`	Take a screenshot.
`public Object` `screenToAutomap(Object arg)`	Convert a point from screen coordinates to automap coordinates.
`public Object` `screenToAutomap(int` `ix,int` `iy)`	Convert a point from screen coordinates to automap coordinates.
`public Object` `automapToScreen(Object arg)`	Convert a point from automap coordinates to screen coordinates.
`public Object` `automapToScreen(int` `ix,int` `iy)`	Convert a point from automap coordinates to screen coordinates.
`public String` `md5(String str)`	Takes the md5 hash.
`public String` `sha1(String str)`	Takes the sha1 hash.
`public String` `sha256(String str)`	Takes the sha256 hash.
`public String` `sha384(String str)`	Takes the sha384 hash.
`public String` `sha512(String str)`	Takes the sha512 hash.
`public String` `md5_file(String file)`	Take the md5 hash of a file.
`public String` `sha1_file(String file)`	Take the sha1 hash of a file.
`public String` `sha256_file(String file)`	Take the sha256 hash of a file.
`public String` `sha384_file(String file)`	Take the sha384 hash of a file.
`public String` `sha512_file(String file)`	Take the sha512 hash of a file.

Members

`public` `Unit` `getUnit(int` `type,String name,uint32_t mode,uint32_t nUnitId)` {#group__globalFunctions_1gab92645722228c1b850c56a97a331e64e}

Get a unit by type, name, mode and nUnitId.

Parameters

type The type of the unit. Set to -1 to get any unit. 100 gets the cursor item, 101 gets the selected unit.
name The name of the unit to look for.
mode Either the mode being searched for, or a bitmask with bit 29 set and bits 0-28 corresponding to modes of units being searched for.
nUnitId The unique id of the unit.

Returns

The first unit found that matches the description.

`public` `Unit` `getUnit(int` `type,uint32_t classId,uint32_t mode,uint32_t nUnitId)` {#group__globalFunctions_1ga00d41e69e334872da0d57a9406de86df}

Get a unit by type, classId, mode and nUnitId.

Parameters

type The type of the unit. Set to -1 to get any unit. 100 gets the cursor item, 101 gets the selected unit.
classId The class id of the unit.
mode Either the mode being searched for, or a bitmask with bit 29 set and bits 0-28 corresponding to modes of units being searched for.
nUnitId The unique id of the unit.

Returns

The first unit found that matches the description.

`public object[]` `getPath(uint32_t Area,uint32_t srcX,uint32_t srcY,uint32_t dstX,int` `dstY,uint32_t reductionType,uint32_t Radius)` {#group__globalFunctions_1ga7913f6338480cc180c015198b6c18024}

Creates a path (walking or teleporting) from the source to the destination.

Returns an array of points that form a path from the source to the destination. Takes Area ID(s), source and destination points, walking or teleporting and range as parameters.

Parameters

[Area](api-undefined.md#classArea) The Area ID to path through.
srcX The source X coordinate.
srcY The source Y coordinate.
dstX The destination X coordinate.
dstY The destination Y coordinate.
reductionType The type of reduction: {0 - walking, 1 - teleport, 2 - none}
Radius The distance between each point.

Returns

The path as an array of objects with x and y properties.

`public object[]` `getPath(uint32_t Area,uint32_t srcX,uint32_t srcY,uint32_t dstX,intdstY,uint32_t reductionType,uint32_t Radius,bool()(int32_t x, int32_t y) reject,bool()(object curPt,int` i, object[] pts) `reduce,int32_t(*)(int32_t x, int32_t y) mutate)` {#group__globalFunctions_1ga051897c1e76c0ceeccd946dbedc6ea54}

Creates a path (walking or teleporting) from the source to the destination.

Returns an array of points that form a path from the source to the destination. Takes Area ID, source and destination points, walking or teleporting, range and reduction or not as parameters.

Parameters

[Area](api-undefined.md#classArea) The Area ID to path through.
srcX The source X coordinate.
srcY The source Y coordinate.
dstX The destination X coordinate.
dstY The destination Y coordinate.
reductionType The type of reduction: {0 - walking, 1 - teleport, 2 - none, 3 - user specified}
Radius The distance between each point.
reject Called on start and end to determine if point is valid.
reduce Function to determine whether to keep point. Returns true if point should be kept, false if point should be eliminated.
mutate Called on the start/end if it isn't/is rejected respectively. This is done before path generation.

Returns

The path as an array of objects with x and y properties.

`public unsigned short` `getCollision(uint32_t nLevelId,int32_t nX,int32_t nY)` {#group__globalFunctions_1gac3a89f2d8c4940ae49dce43fbe2f626b}

Get the collision flags at a given point in a given area.

Parameters

nLevelId The level id of the area in question.
nX The x coordinate of the point in question.
nY The y coordinate of the point in question.

Returns

The collision flags. For details see: http://forums.d2botnet.org/viewtopic.php?f=18&t=1212 .

`public` `int` `getMercHP()` {#group__globalFunctions_1gac4217ed30da8eb07d8addca4cdb51a9d}

Get the health points of the controlled unit's merc.

Returns

The health points.

`public` `int` `getCursorType()` {#group__globalFunctions_1gaa0bc4f7877d6992600202b8dce442787}

Get the cursor type from p_D2CLIENT_RegularCursorType.

Returns

The regular cursor type.

`public` `int` `getCursorType(int` `nType)` {#group__globalFunctions_1ga9b3530843295a8ee8fa59a3130ae7409}

Get the cursor type from p_D2CLIENT_RegularCursorType if nType != 1, from p_D2CLIENT_ShopCursorType if nType == 1.

Parameters

nType What type of cursor to get. 1 - ShopCursorType, other - RegularCursorType.

Returns

The cursor type.

`public` `int` `getSkillByName(String skillName)` {#group__globalFunctions_1gaee860cd7482aff8e89519314a0f86955}

Get skill ID by name.

Parameters

skillName The skill name.

Returns

The skill ID.

`public String` `getSkillById(int` `skillId)` {#group__globalFunctions_1ga14cda78dea3cf554c8ebeeb0834039c9}

Get skill name by ID.

Parameters

skillId The skill ID.

Returns

The skill name.

`public String` `getLocaleString(uint16_t localeId)` {#group__globalFunctions_1gaf2065d798cd6a0337fb94f7bae718283}

Get the String in the current locale that corresponds to the given id.

Parameters

localeId The id of the String.

Returns

The String in the current locale.

`public` `int` `getTextSize(String string,int` `font,bool asObject)` {#group__globalFunctions_1ga19d918388535584b388c00c57d76ab47}

Get the width and height of the given text in the given font.

Parameters

string The string to get the size of.
font The font to use.
asObject False to return as an array.

Returns

The width and height of the text. 0 - width, 1 - height.

Parameters

string The string to get the size of.
font The font to use.
asObject True to return as an object.

Returns

The width and height of the text. Has properties .width and .height.

`public` `int` `getThreadPriority()` {#group__globalFunctions_1ga6ab5869695c97ce6e4fbc6899e16a75d}

Get the priority of the current thread.

Returns

The priority.

`public bool` `getUIFlag(int` `nUIId)` {#group__globalFunctions_1gac259c30bc648650e021f45f1c020e412}

Get whether or not a UI flag is set.

Parameters

nUIId The ID of the UI in question.

Returns

Whether or not the flag is set.

`public` `int` `getTradeInfo(int` `nMode)` {#group__globalFunctions_1gaedebe009d3f6c0afeab5cb544f430767}

Get the TradeFlag or RecentTradeId.

Get the RecentTradeName.

Parameters

nMode What to return. 0 - TradeFlag, 2 - RecentTradeId.

Returns

The TradeFlag or RecentTradeId.

Currently broken, returns null.

Parameters

nMode What to return. 1 - RecentTradeName.

Returns

The RecentTradeName.

`public bool` `getWaypoint(int` `nWaypointId)` {#group__globalFunctions_1ga4561d06e77835b04e0794758844bd987}

Get whether the controlled unit has the given waypoint.

Parameters

nWaypointId The area id of the waypoint in question.

Returns

Whether or not the controlled unit has the waypoint.

`public` `D2BSScript` `getScript(bool currentScript)` {#group__globalFunctions_1ga8340268c49de1e5f34588c01b0cf971d}

Get the current or first context.

Parameters

currentScript Whether to get the current script (true) or the first (false).

Returns

A D2BSScript object for the request script.

`public` `D2BSScript` `getScript(int` `threadId)` {#group__globalFunctions_1ga02ad0d69faff60c7061a98a3e8a2b53b}

Get a script by thread id.

Parameters

threadId The thread id of the script to get.

Returns

A D2BSScript object for the script from the given thread.

`public` `D2BSScript` `getScript(String name)` {#group__globalFunctions_1gac202e144c149fa59378fd01585e6a2bd}

Get a script by filename.

Parameters

name The filename of the script to find.

Returns

A D2BSScript object for the script.

`public` `D2BSScript` `getScript()` {#group__globalFunctions_1ga822bdc4cbce00ca342a05bc29ffae76e}

Get the first script.

Returns

A D2BSScript representing the first script in the runtime.

`public` `Room` `getRoom(uint32_t levelId)` {#group__globalFunctions_1ga0ec5e4d9e09bf924c1f96ce417290417}

Get the first room in area given by level id.

Parameters

levelId The id of the area to get the room from, or 0 to get the room the controlled unit is in.

Returns

The first room in the area.

`public` `Room` `getRoom(uint32_t levelId,int` `x,int` `y)` {#group__globalFunctions_1ga6c10567ae9eac427ef0770edb2ab8c21}

Get the room that the given point is in from the given level id.

Parameters

levelId The level id to look in.
x The x coordinate to find a room for.
y The y coordinate to find a room for.

Returns

The room at the given point.

`public` `Room` `getRoom(int` `x,int` `y)` {#group__globalFunctions_1gacc763e01907b73ca5c405469cc58cf12}

Get the room that the given point is in.

Parameters

x The x coordinate to find a room for.
y The y coordinate to find a room for.

Returns

The room at the given point.

`public` `Room` `getRoom()` {#group__globalFunctions_1gafc051829ad79986ed98043fd46bd9a2c}

Get the first room in the current area.

Returns

The first room in the current area.

`public` `Party` `getParty()` {#group__globalFunctions_1gae1a5223caa888f3cc2429fad719fc7eb}

Get the first party.

Returns

The first party.

`public` `Party` `getParty(String name)` {#group__globalFunctions_1ga6a0dc4f8e9bd582b1c8c4fc4da5e2f47}

Get the party line for the player with the given name.

Parameters

name The name of the player to search for

Returns

The party line

`public` `Party` `getParty(uint32_t playerId)` {#group__globalFunctions_1ga3fa567c623c83fe382918a7c6fb49978}

Get the party line for the player with the given player id.

Parameters

playerId

Returns

The party line

`public` `Party` `getParty(Unit` `player)` {#group__globalFunctions_1gab98faccffab8b30337ba357504c145c3}

Get the party line that corresponds to the given unit.

Parameters

player Unit

Returns

The party line

`public` `PresetUnit` `getPresetUnit(uint32_t levelId,int` `nType,int` `nClassId)` {#group__globalFunctions_1ga6bf8c5a903fcf00dcd2504e8f4dc4ff7}

Get the first PresetUnit of the given type and class id.

Parameters

levelId The area id of the level to look for a PresetUnit in.
nType The type of the PresetUnit. See getUnit for type codes.
nClassId The class id to find. See: http://forums.d2botnet.org/viewtopic.php?f=18&t=986 and http://forums.d2botnet.org/viewtopic.php?f=18&t=985 .

Returns

The first PresetUnit found of type nType and class ID nClassId.

`public` `PresetUnit` `getPresetUnits(uint32_t levelId,int` `nType,int` `nClassId)` {#group__globalFunctions_1gaf77d2fb8bcab572d328c5764155be78d}

Get an array of PresetUnit s of the given type and class id.

Parameters

levelId The area id of the level to look for PresetUnit s in.
nType The type of the PresetUnit. See getUnit for type codes.
nClassId The class id to find. See: http://forums.d2botnet.org/viewtopic.php?f=18&t=986 and http://forums.d2botnet.org/viewtopic.php?f=18&t=985 .

Returns

An array of PresetUnit s found of type nType and class ID nClassId.

`public` `Area` `getArea()` {#group__globalFunctions_1ga096676595eb6e9e2361dffe28acd8397}

Get the Area where the controlled unit currently resides.

Returns

An Area object for the current object.

`public` `Area` `getArea(int32_t nArea)` {#group__globalFunctions_1gae59e910620c20fb4fae45fc06d7cc351}

Get the Area for area ID nArea.

Parameters

nArea The area ID.

Returns

An Area object.

`public String` `getBaseStat(String szTableName,int32_t nClassId,String szStatName)` {#group__globalFunctions_1gab4ebba6bce777cb9705e199af1d08bc8}

Get the base stat from the given table with the given class ID and stat name.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

`public String` `getBaseStat(int32_t nBaseStat,int32_t nClassId,String szStatName)` {#group__globalFunctions_1ga79338ba3a14fe002f38d987fed2809b3}

Get the base stat from the given table with the given class ID and stat name.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
szStatName The stat name.

Returns

The stat.

`public String` `getBaseStat(String szTableName,int32_t nClassId,int32_t nStat)` {#group__globalFunctions_1gac86c8437c691e21b5593552ab9def9ba}

Get the base stat from the given table with the given class ID and stat ID.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

Parameters

szTableName The name of the table to look in.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

`public String` `getBaseStat(int32_t nBaseStat,int32_t nClassId,int32_t nStat)` {#group__globalFunctions_1gafcfdd2f8d3eb3a2c30436ddfc4add78b}

Get the base stat from the given table with the given class ID and stat ID.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

Parameters

nBaseStat The stat to look up.
nClassId The class ID of the ...
nStat The stat ID.

Returns

The stat.

`public` `Control` `getControl(int32_t nType,int32_t nX,int32_t nY,int32_t nXSize,int32_t nYSize)` {#group__globalFunctions_1gaad0e54fb02bc1ce440b96204167da80f}

Get the control specified by type, location and size.

-1 indicates parameter not to be matched against.

Parameters

nType The type of control (button, text box, etc.)
nX The x coordinate of the control of the control to find.
nY The y coordinate of the control of the control to find.
nXSize The width of the control.
nYSize The height of the control.

Returns

A Control object representing the Control found.

`public bool` `getPlayerFlag(int` `nFirstUnitId,int` `nSecondUnitId,int` `nFlag)` {#group__globalFunctions_1gaa18d78f3e5bb312f53b602247ec66fd3}

Get the relation between two units.

Parameters

nFirstUnitId The unit id for the unit making the relationship.
nSecondUnitId The unit id for the unit receiving the relationship.
nFlag The relationship.

Returns

Whether or not the relationship is of the type specified.

`public` `int` `getTickCount()` {#group__globalFunctions_1gad6eff12ded45cc505954f4763a71eae3}

Get the tick count.

Returns GetTickCount().

Returns

The tick count.

`public` `Unit` `getInteractedNPC()` {#group__globalFunctions_1ga3338c7af7db3773f41edb61bf9c5873c}

Get the Unit that the controlled Unit is currently interacting with.

Returns

The Unit currently being interacted with.

`public void` `print(...)` {#group__globalFunctions_1ga428513e838de3670e09b242cde1f0f6b}

Print the String representation of the arguments to the console.

`public void` `delay(uint32_t nDelay)` {#group__globalFunctions_1ga95cd2552eeef0300ab5bae0ee284f82d}

Delay for nDelay milliseconds.

This is done by suspending the context, sleeping, then resuming the context for short (<50 ms) delays. For longer delays the context is suspended, 50ms are slept away, the context is resumed, sequence repeats until time slept is greater then nDelay ms.

Parameters

nDelay Milliseconds to sleep.

`public` `D2BSScript` `load(String file,...)` {#group__globalFunctions_1gabb55e1126cb1e7626356bd529f6bc965}

Load file and create a thread with it's main function.

File taken from scriptDir\file. All remaining parameters are passed to the script.

Parameters

file The filename of the script.

Returns

If successful returns the new script object representing the thread of the thread. Otherwise it returns null.

`public bool` `isIncluded(String file)` {#group__globalFunctions_1gae9d2eb16bc4dc333da24e3d968897f67}

Determine whether a file has been included yet or not.

File taken from scriptDir\libs\file

Parameters

file Filename of the file that might have been included.

Returns

Whether or not the file has been included.

`public bool` `include(String file)` {#group__globalFunctions_1ga41df84bb09ce63ef47fd30ddf980294b}

Include file from the scriptDir\libs directory.

Parameters

file Filename of the file to include.

Returns

Whether the inclusion was successful.

`public void` `stop(int` `stop)` {#group__globalFunctions_1ga8c8dfb6d9bcdee82b208da3033068b81}

Conditionally stop current script.

Parameters

stop 1 if current script should be stopped.

`public void` `stop(bool stop)` {#group__globalFunctions_1gaaff9311fc25289798786b3c364291a28}

Conditionnaly stop current script.

Parameters

stop True if current script should be stopped.

`public` `int` `rand(int32_t low,int32_t high)` {#group__globalFunctions_1ga6cbf7046bc4629083c0d50f6c5ce8843}

Return a random number between low and high.

Uses C rand() when out of game, and D2GAME_D2Rand with the game seed while in game.

Parameters

low The lowest possible integer to return.
high The highest possible integer to return.

Returns

A random integer in the range [low,high].

`public void` `copy(String txt)` {#group__globalFunctions_1gaca5b8f5b2f8d97182bab3979920352e4}

Copy txt to clipboard.

Parameters

txt Text to copy to the clipboard.

`public` `int` `sendCopyData(String windowClassName,String windowName,int32_t nModeId,String data)` {#group__globalFunctions_1gad4e03d1abafaa3beab0e1cbb90ca8e37}

Send data to another window by means of the WM_COPYDATA message.

Uses FindWindow to get the HWND and SendMessage to send the message.

Parameters

windowClassName The class name of the receiving window.
windowName The window name of the receiving window.
nModeId Data to be sent as the dwData member of the copy data.
data Data to be send as the lpData member of the copy data.

Returns

The result of SendMessage.

`public` `int` `sendCopyData(HWND hWnd,String dummy,int32_t nModeId,String data)` {#group__globalFunctions_1ga3dc20441410e40f237213140436a68d3}

Send data to another window by means of the WM_COPYDATA message.

Uses SendMessage to send the message to hWnd.

Parameters

hWnd The handle to the receiving window.
dummy Ignored.
nModeId Data to be sent as the dwData member of the copy data.
data Data to be send as the lpData member of the copy data.

Returns

The result of SendMessage.

`public String` `sendDDE(int32_t mode,String pszDDEServer,String pszTopic,String pszItem)` {#group__globalFunctions_1ga1b7c45afc2b2302e309c1376d3ecf83f}

Send data to a DDE server by means of DdeClientTransaction.

Parameters

mode The mode of transaction to use.

0 - Do command given by pszItem with an XTYP_REQUEST and get the resulting data.

1 - Do command given by pszItem with an XTYP_POKE sending ""

2 - Do command with an XTYP_EXECUTE sending ""

Parameters

pszDDEServer The service name of the DDE server to connect to.
pszTopic The topic with which to start the connection.
pszItem Data to be sent.

Returns

Result data if mode was 0.

`public bool` `keystate(int` `vKey)` {#group__globalFunctions_1ga8758a45d0a7e6bb5c42258ea99e7da07}

Get whether or not a key is pressed.

Returns the value of GetAsyncKeyState.

Parameters

vKey The virtual key code for the key in question. See: http://msdn.microsoft.com/en-us/library/dd375731%28v=VS.85%29.aspx

Returns

Whether not the key is pressed.

`public void` `addEventListener(String event,Function eventHandler)` {#group__globalFunctions_1gaef5f2e6f72ff80cc13fd4ab84ab34810}

Add an event handler to the list of listeners for the given event.

Parameters

event The name of the event. Can be:

melife (uint32_t dwLife)

memana (uint32_t dwMana)

keyup (uint32_t key)

keydown (uint32_t key)

bool keyupblock (uint32_t key) - Returns true to block event from Diablo II

bool keydownblock (uint32_t key) - Returns true to block event from Diablo II

playerassign (uint32_t unitId)

mouseclick (uint32_t button, uint32_t x, uint32_t y, bool bUp)

mousemove (uint32_t x, uint32_t y)

scriptmsg (...)

golddrop (uint32_t gId, uint32_t Mode)

chatmsg (String lpszNick, String lpszMsg)

bool chatmsgblocker (String lpszNick, String lpszMsg) - Returns true to block event from Diablo II

whispermsg (String lpszNick, String lpszMsg)

bool whispermsgblocker (String lpszNick, String lpszMsg) - Returns true to block event from Diablo II

copydata (int32_t dwMode, String lpszMsg)

itemaction (uint32_t gId, uint32_t mode, String code, Bool global)

gameevent (BYTE mode, DWORD param1, DWORD param2, String name1, String name2)

From http://www.blizzhackers.cc/viewtopic.php?t=392307 Dark_Mage-

mode:

0x00 - "%Name1(%Name2) dropped due to time out." 0x01 - "%Name1(%Name2) dropped due to errors." 0x02 - "%Name1(%Name2) joined our world. Diablo's minions grow stronger." 0x03 - "%Name1(%Name2) left our world. Diablo's minions weaken." 0x04 - "%Name1 is not in the game." 0x05 - "%Name1 is not logged in."

0x06 - "%Name1 was Slain by %Name2" BYTE Param2 = Unit Type of Slayer (0x00 = Player, 0x01 = NPC) if Type = Player, Name2 = Slayer Character Name & DWORD Param1 = Slayer Character Type if Type = NPC, DWORD Param1 = Monster Id Code from MPQ (points to string for Name2) if Type = NPC & Monster is Unique, Name2 = Unique Monster Id

0x07 - Player Relations (Bottom Left Text) DWORD Param1 = Player Id Player Id = Pointer to Character Name BYTE Param2 = Action Taken Actions: 0x01 - "%Player permits you to loot his corpse." 0x02 - "%Player permits you to loot her corpse." 0x03 - "%Player has declared hostility towards you." 0x04 - "%Player is no longer hostile towards you." 0x05 - "%Player invites you to ally against the forces of evil." 0x06 - "%Player has canceled party invite." 0x07 - "%Player has joined your party to fight the forces of evil." 0x08 - "You are now allied with %Player." 0x09 - "%Player has left your party." 0x0a - "%Player no longer allows you to access his corpse." 0x0b - "%Player no longer allows you to access her corpse."

0x08 - "%Name1 is busy." 0x09 - "You must wait a short time to trade with that player."

0x0a - "%Name1 has items in his box." if Name1 = 0x00, "You have items in your box."

0x0b - 0x0c - 0x0d - "%Name1 is not listening to you." 0x0e - Received on 'Not enough mana' speech. 0x0f - "Realm going down in %Param1 minutes." 0x10 - "You must wait a short time to declare hostility with that player." 0x11 - "%Param1 Stones of Jordan Sold to Merchants" 0x12 - "Diablo Walks the Earth"

Parameters

eventHandler A function with the signature listed above that handles the event.

`public void` `removeEventListener(String event,Function eventHandler)` {#group__globalFunctions_1gaee02cb255ac39d16c7035fb1b58c70ed}

Removes a previously added event from the listener list.

Parameters

event The event name (the one used to add the event).
eventHandler The handler to remove.

`public void` `clearEvent(String event)` {#group__globalFunctions_1ga185f0dafe7fd58fd565b8ce3b460541b}

Clear the event handler list for given event.

Parameters

event The name of the event to clear the handler list for.

`public void` `clearAllEvents()` {#group__globalFunctions_1ga229f0f1b263c13dc1a2c5bdcb51a5320}

Clear all event handlers (from all events).

`public bool` `js_strict()` {#group__globalFunctions_1ga7b204d249e4e2d8274bec860070f1be3}

Get whether or not the JSOPTION_STRICT flag is set.

Returns

Whether or not the strict flag is set.

`public void` `js_strict(bool setStrictFlag)` {#group__globalFunctions_1gae9bcfbfe5b3392c7533b960c25720b4f}

Set or clear the JSOPTION_STRICT flag.

Parameters

setStrictFlag The new JSOPTION_STRICT state.

`public String` `version()` {#group__globalFunctions_1ga8972d7cb64b90764c110de40e134cfbc}

Get the D2BS version string.

Returns

The D2BS version string.

`public void` `version(int` `a)` {#group__globalFunctions_1ga8e60448ae3ce3cd28e7f438cfa9e11eb}

Print the D2BS version string.

`public void` `scriptBroadcast(...)` {#group__globalFunctions_1ga2dea3ce2441ba8f7a7e4c5bdf1be7bba}

Broadcast a message to all other scripts.

D2BS calls each scripts scriptmsg event listeners with the messages passed in.

`public String` `sqlite_version()` {#group__globalFunctions_1ga182b9023c5495a885298b7f981ee8919}

Get the sqlite version string (from sqlite3_version).

Returns

The sqlite version string.

`public double` `sqlite_memusage()` {#group__globalFunctions_1gae497b684eaeacd9196d73700e4d57d52}

Return the sqlite memory usage.

`public` `Folder` `dopen(String name)` {#group__globalFunctions_1ga9a23806a759b9bace15e57adbdb90f91}

Get the Folder object for the directory scriptPath\name.

Parameters

name The name of the Folder to open.

Returns

A Folder object representing the Folder name.

`public void` `debugLog(...)` {#group__globalFunctions_1gacab2f81ca665988be5ca4ceb60503073}

Log the String representation of the arguments.

`public void` `showConsole()` {#group__globalFunctions_1ga084bae5a15c2ac3f27ea93f3a03ca0ce}

Show the console.

`public void` `hideConsole()` {#group__globalFunctions_1gaaaafa71c8fdd6db81a134ae4aaa355db}

Hide the console.

`public void` `login()` {#group__globalFunctions_1gaf76b7b46958dabf5e4ee9a492f0ec3fa}

Loads the default (either from config or copydata or DDE) profile from d2bs.ini and gets to the lobby (for battle.net chars) or into a game (for single player characters).

Exceptions

String May throw one of the following:

"invalid character name" - If it fails to select the character.

"Failed to click the Single button?" - If it fails to click the single player button.

"Failed to click the 'Battle.net' button?" - If it fails to click the battle.net button.

"Failed to click the 'Other Multiplayer' button?" - If it fails to click the Other Multiplayer button.

"Failed to click the 'Open Battle.net' button?" - If it fails to click the Open battle.net button.

"Failed to click the 'TCP/IP' button?" - If it fails to click the TCP/IP button.

"Failed to click the 'Host Game' button?" - If it fails to click the Host Game (TCP/IP) button.

"Failed to click the 'Join Game' button?" - If it fails to click the Join Game (TCP/IP) button.

"Failed to click the OK button" - If it fails to click the OK button (TCP/IP enter IP address).

"Failed to find the 'Host IP Address' text-edit box." - If it can't find the host IP address (TCP/IP) text box.

"Could not get the IP address from the profile in the d2bs.ini file." - If the user failed to specify the IP address in the d2bs.ini file.

"Failed to click the exit button?" - If it is login and fails to click the exit button.

"Failed to set the 'Username' text-edit box.' - If it can't find the username control.

"Failed to set the 'Password' text-edit box." - If it can't find the password control.

"Failed to click the 'Log in' button?" - If it can't click the login button.

"Failed to click the 'Normal Difficulty' button?" - If it can't click the normal button in single player game creation.

"Failed to click the 'Nightmare Difficulty' button?" - If it can't click the nightmare button in single player game creation.

"Failed to click the 'Hell Difficulty' button?" - If it can't click the hell button in single player game creation.

"Invalid single player difficulty level specified!" - If the difficulty level is invalid.

"Unable to connect" - If the unable to connect screen is shown.

"CD-Key in use" - If the cdkey in use screen is shown.

"Bad account or password" - If the username/password wrong screen is shown.

"Realm Down" - If the realm down message is shown.

"Unhandled login location" - If the game is in an unsupported location.

`public void` `login(String profile)` {#group__globalFunctions_1gad9588235f179db8af822d1356337b021}

Loads the profile from d2bs.ini and gets to the lobby (for battle.net chars) or into a game (for single player characters).

Parameters

profile The profile to load.

Exceptions

String May throw one of the following: