DSB/Exposed functions - Revision history

Kaypy: /* Interacting with Insts */

2024-09-03T12:51:58Z

Interacting with Insts

← Older revision		Revision as of 12:51, 3 September 2024
Line 438:		Line 438:
	:Returns true if the instance exists, false if it doesn't but the id is valid, and nil if it is not a valid instance id.		:Returns true if the instance exists, false if it doesn't but the id is valid, and nil if it is not a valid instance id.

	;<b>clone_arch</b>(~~object_arch~~) = new arch		;<b>clone_arch</b>(base_arch, changes) = new arch
	:Creates a new arch type. See a simple [http://www.dungeon-master.com/forum/viewtopic.php?f=53&t=28613&p=111165#p111165 example].		:Creates a new arch type. See a simple [http://www.dungeon-master.com/forum/viewtopic.php?f=53&t=28613&p=111165#p111165 example].
			:The new arch will be the original arch, but with changes applied from a list of key/value pairs
			:Note that this cannot clear a key from the original arch - any removals would need to be applied manually to the new arch

	==Monsters==		==Monsters==

Kaypy: results of an experiment spamming the dungeon with insts until things broke

2024-01-06T09:10:52Z

results of an experiment spamming the dungeon with insts until things broke

← Older revision		Revision as of 09:10, 6 January 2024
Line 356:		Line 356:
	:Spawns a new instance at the specified coordinates and returns its id.		:Spawns a new instance at the specified coordinates and returns its id.
	Note that if "level" is negative, various [[DSB/Special Values\|Special Values]] can be used.		Note that if "level" is negative, various [[DSB/Special Values\|Special Values]] can be used.

			The ID will be a value between 1 and 32767. If there are more than 32767 insts at a time then the system will crash. Insts that are removed from the dungeon will free up IDs for new insts. Since inst IDs can be thus recycled, it may not always be safe to assume a stored ID will always point to inst it started as.

	;<b>dsb_move</b>(id, level, x, y, tile_location)		;<b>dsb_move</b>(id, level, x, y, tile_location)

Kaypy: add note on MULTILINE and dsb_textformat use

2024-01-06T02:00:12Z

add note on MULTILINE and dsb_textformat use

← Older revision		Revision as of 02:00, 6 January 2024
Line 58:		Line 58:

	;<b>dsb_bitmap_textout</b>(bitmap, font, string, x, y, alignment, color) = integer		;<b>dsb_bitmap_textout</b>(bitmap, font, string, x, y, alignment, color) = integer
	:Renders text onto a bitmap in the specified font and color, with the specified alignment: (LEFT, RIGHT, CENTER, or MULTILINE). Returns the number of lines printed.		:Renders text onto a bitmap in the specified font and color, with the specified alignment: (LEFT, RIGHT, CENTER, or MULTILINE). Returns the number of lines printed. If you use the MULTILINE version, call <b>dsb_textformat()</b> first to set the line length and height. The textformat settings are global so if you don't know what code may run between the <b>dsb_textformat</b> call and the <b>dsb_bitmap_textout</b> call, then you don't really know what format it will draw in.

	;<b>dsb_dungeon_view</b>(lev, x, y, dir, light) = bitmap		;<b>dsb_dungeon_view</b>(lev, x, y, dir, light) = bitmap

Gambit37: /* Global Data, Utility Functions, and Misc. */

2022-02-02T17:16:25Z

Global Data, Utility Functions, and Misc.

← Older revision		Revision as of 17:16, 2 February 2022
Line 568:		Line 568:
	;dsb_mouse_state() = x, y, button1, button2		;dsb_mouse_state() = x, y, button1, button2
	:Gets the current state of the mouse: its current x,y position relative to the entire game screen, and '''true''' or '''false''' for button1 or button2 currently being pressed (left mouse button and right mouse button respectively).		:Gets the current state of the mouse: its current x,y position relative to the entire game screen, and '''true''' or '''false''' for button1 or button2 currently being pressed (left mouse button and right mouse button respectively).

			;dsb_mouse_override(bmp)
			:Overrides the current mouse cursor image with a new image. Pass '''nil''' or '''false''' to cancel the override.

	;<b>dsb_lock_game</b>(~[flag])		;<b>dsb_lock_game</b>(~[flag])

Gambit37: /* Multiple Parties */

2022-01-19T15:42:26Z

Multiple Parties

Gambit37: /* Introduction */

2022-01-19T13:00:56Z

Introduction

← Older revision		Revision as of 13:00, 19 January 2022
Line 1:		Line 1:
	==Introduction==		==Introduction==
	Functions are given in the form:		Functions are given in the form:
	;~~<b>~~function~~</b>~~(arguments, ~[optional arguments]) = return value		;function(arguments, ~[optional arguments]) = return value
	:If the terminology doesn't make sense, check [[DSB/Basic DSB Terminology]].		:If the terminology doesn't make sense, check [[DSB/Basic DSB Terminology]].
	Functions without a dsb_ prefix are part of [[DSB/Base Code\|base/]], not the core engine.		Functions without a dsb_ prefix are part of [[DSB/Base Code\|base/]], not the core engine.

Gambit37: /* Fullscreen */

2022-01-11T16:40:18Z

Fullscreen

← Older revision		Revision as of 16:40, 11 January 2022
Line 528:		Line 528:

	==Fullscreen==		==Fullscreen==
	;<b>dsb_fullscreen~~</b>~~(bitmap_or_func, click_func, update_func, mouse, { fade = true, game_draw = true })		;dsb_fullscreen(bitmap_or_func, click_func, update_func, mouse, { fade = true, game_draw = true }) (DSB < v0.76)
			;dsb_fullscreen(bitmap_or_func, click_func, update_func, mouse, { fade = true, game_draw = true, keep_viewmode = true }) (DSB v0.76+)
	:This engages the full-screen renderer, and is used for cut scenes or other interludes. If the first parameter passed is a bitmap, that bitmap will be displayed. If the first parameter is instead a function, that function will be executed every frame. The draw function will be passed the bitmap to draw to, the mouse's x location, and the mouse's y location, in the form: <code><b>draw_function</b>(bitmap, mouse_x, mouse_y)</code>		:This engages the full-screen renderer, and is used for cut scenes or other interludes. If the first parameter passed is a bitmap, that bitmap will be displayed. If the first parameter is instead a function, that function will be executed every frame. The draw function will be passed the bitmap to draw to, the mouse's x location, and the mouse's y location, in the form: <code><b>draw_function</b>(bitmap, mouse_x, mouse_y)</code>

	:The click_func, if provided, will be executed every time the mouse is clicked. It is of the form: <code><b>click_func</b>(mouse_x, mouse_y, mouse_buttons)</code>		:The click_func, if provided, will be executed every time the mouse is clicked. It is of the form: <code><b>click_func</b>(mouse_x, mouse_y, mouse_buttons)</code>

	:Update_func, if provided, will be executed every game tick. It takes no parameters.		:Update_func, if provided, will be executed every game tick. It takes no parameters.

	:If mouse is nil or false, no mouse pointer will be drawn. If it is true, the standard "yellow arrow" mouse pointer will be drawn. If it is a bitmap, that bitmap will be drawn as the mouse pointer.		:If mouse is nil or false, no mouse pointer will be drawn. If it is true, the standard "yellow arrow" mouse pointer will be drawn. If it is a bitmap, that bitmap will be drawn as the mouse pointer.
	:There is an optional 5th parameter (a table of booleans) ~~that allows a~~ fade in/fade ~~out. The~~ <b>game_draw</b> allows you to have the game view drawn in the background. So, for example, for a fullscreen view that fades in and draws the game view.
			:There is an optional 5th parameter (a table of booleans):
			::<code><b>fade</b></code> will quickly fade the fullscreen bitmap in from a black screen
			::<code><b>game_draw</b></code> allows you to have the game view drawn in the background. So, for example, for a fullscreen view that fades in and draws the game view.
			::<code><b>keep_viewmode</b></code> which will draw the inventory view if the renderer is invoked from an inventory (DSB v0.76+)

	:The full-screen renderer will run until any of its associated functions returns something other than false or nil, and the game logic does not advance while in <b>dsb_fullscreen</b>.		:The full-screen renderer will run until any of its associated functions returns something other than false or nil, and the game logic does not advance while in <b>dsb_fullscreen</b>.

Kaypy: /* Levels and Wallsets */

2021-06-18T13:09:03Z

Levels and Wallsets

← Older revision		Revision as of 13:09, 18 June 2021
Line 169:		Line 169:

	;<b>dsb_get_cell</b>(level, x, y) = boolean		;<b>dsb_get_cell</b>(level, x, y) = boolean
	:Returns a boolean specifying whether or not the given cell in the dungeon is a wall. Use <b>dsb_fetch</b> to find out anything else about what's there.		:Returns a boolean specifying whether or not the given cell in the dungeon is a wall. Use <b>dsb_fetch</b> to find out anything else about what's there. Note that an out of bounds cell is not considered a wall.

	;<b>dsb_set_cell</b>(level, x, y, value)		;<b>dsb_set_cell</b>(level, x, y, value)

Gambit37: /* Levels and Wallsets */

2020-11-26T19:22:47Z

Levels and Wallsets

← Older revision		Revision as of 19:22, 26 November 2020
Line 137:		Line 137:

	;<b>dsb_make_wallset_ext</b>(floor, roof, pers0, pers0alt, pers1, pers1alt, pers2, pers2alt, pers3, persl3alt, farwall3, farwall3alt, front1, front2, front3, left1, left1alt, left2, left2alt, left3, left3alt, patch1, patch2, patch3, patchside, window) = wallset		;<b>dsb_make_wallset_ext</b>(floor, roof, pers0, pers0alt, pers1, pers1alt, pers2, pers2alt, pers3, persl3alt, farwall3, farwall3alt, front1, front2, front3, left1, left1alt, left2, left2alt, left3, left3alt, patch1, patch2, patch3, patchside, window) = wallset
	:Creates a wallset from the specified bitmaps. This command takes 6 more arguments: 6 "left side" bitmaps. If you're using a converted DM2, [[DSB/DSB for RTC users\|DSB for RTC users]], or WHACK wallset, you'll find this command useful.		:Creates a wallset from the specified bitmaps. This command takes 6 more arguments: 6 "left side" bitmaps. If you're using a converted DM2, [[DSB/DSB for RTC users\|DSB for RTC users]], or WHACK wallset, you'll find this command useful. From DSB 0.70 onwards, the window bitmap can be a table containing two different bitmaps: one for the hole part, and one for the magic glow, eg: {gfx.default_window_hole, gfx.window_glow_wall}

	;<b>dsb_level_wallset</b>(level, wallset)		;<b>dsb_level_wallset</b>(level, wallset)

Gambit37: /* Levels and Wallsets */

2020-11-25T14:46:33Z

Levels and Wallsets

← Older revision		Revision as of 14:46, 25 November 2020
Line 124:		Line 124:

	==Levels and Wallsets==		==Levels and Wallsets==
	<b>dsb_bottomlevel()</b> ~~From~~ DSB 0.71+		<b>dsb_bottomlevel()</b> DSB 0.71+
	:Returns the deepest level of the dungeon, counting from 0 -- so a 10 level dungeon will return 9.		:Returns the deepest level of the dungeon, counting from 0 -- so a 10 level dungeon will return 9.

← Older revision		Revision as of 15:42, 19 January 2022
Line 336:		Line 336:

	==Multiple Parties==		==Multiple Parties==
	;<b>dsb_get_mpartyflag</b>(flag) = value		<b>dsb_get_mpartyflag</b>(flag) = value
	<b>dsb_set_mpartyflag</b>(flag)		<b>dsb_set_mpartyflag</b>(flag)
	<b>dsb_clear_mpartyflag</b>(flag)		<b>dsb_clear_mpartyflag</b>(flag)
Line 342:		Line 342:
	:Gets, sets, clears, or toggles the value of a [[DSB/Multiple Parties\|Multiple Parties]] flag.		:Gets, sets, clears, or toggles the value of a [[DSB/Multiple Parties\|Multiple Parties]] flag.

	;<b>dsb_set_exviewinst</b>(char, monster_id)		<b>dsb_set_exviewinst</b>(char, monster_id)
	:This will associate a given monster inst with a character. The monster must be in LIMBO. From then on, whenever that character is seen from a 3rd person perspective, that monster will be drawn to represent that character. Don't kill this monster or bad things will happen.		:This will associate a given monster inst with a character. The monster must be in LIMBO. From then on, whenever that character is seen from a 3rd person perspective, that monster will be drawn to represent that character. Don't kill this monster or bad things will happen.

	;<b>dsb_party_apush</b>(party)		<b>dsb_party_apush</b>(party)
	<b>dsb_party_apop</b>(party)		<b>dsb_party_apop</b>(party)
	:The game uses a "party stack" to keep track of which sub-party the various party-related commands affect. The currently viewed party is always at the bottom. When a party steps on a trigger, it is pushed onto the stack before the trigger is processed. This means things like <b>dsb_party_coords</b> will generally affect the "right" party. You can directly manipulate the stack with these commands, but be careful. If you're not sure what to do with these commands, you probably don't need them.		:The game uses a "party stack" to keep track of which sub-party the various party-related commands affect. The currently viewed party is always at the bottom. When a party steps on a trigger, it is pushed onto the stack before the trigger is processed. This means things like <b>dsb_party_coords</b> will generally affect the "right" party. You can directly manipulate the stack with these commands, but be careful. If you're not sure what to do with these commands, you probably don't need them.

	;<b>dsb_party_contains</b>(ppos) = party_id		<b>dsb_party_contains</b>(ppos) = party_id
	:Returns the party containing a given character ppos		:Returns the party containing a given character ppos