Update the special node edit dialog with a bunch of new pickers #655

CelticMinstrel · 2025-02-23T01:17:45Z

The primary goal of this pull request is to add a Choose button (or similar) to as many fields of the Special Node edit dialog as possible. It also reworks the format of the picker dictionary (as per #607) in order to more easily expand its capabilities.

NQNStudios · 2025-02-23T02:29:50Z

I'm really excited about this one for when I get to actually make a scenario.

NQNStudios · 2025-02-23T02:31:06Z

Today I noticed that damage type pickers use boom graphics in the picker, but some booms appear multiple times, I think one didn't have a boom and it didn't really make perfect sense. Maybe worth looking at if you haven't.

CelticMinstrel · 2025-02-23T03:44:00Z

Today I noticed that damage type pickers use boom graphics in the picker, but some booms appear multiple times, I think one didn't have a boom and it didn't really make perfect sense. Maybe worth looking at if you haven't.

The damage type picker is one of the ones that uses an "augmented" graphic picker. When you select one of the options, a string appears at the bottom left saying what it is. By doing this in the damage picker, you can see that one of the "magic" booms is magic and the other is unblockable. Similarly, the extra two "blood" booms are demon and undead damage.

I can't deny that there could be a better way of doing it, but it functions.

CelticMinstrel · 2025-02-28T06:32:13Z

I think the last big thing I plan to add here is an SDF picker. It would sort of combine aspects of the location picker and the editable string picker.

CelticMinstrel · 2025-03-02T05:51:55Z

Basically what that means is that the magic characters are only parsed at startup – the scenario editor code doesn't need to understand them, instead using an enum. This is part of the work for #607

Though this creates the framework, the actual help strings have not been filled in yet.

These are mostly errors that were already wrong in the old dictionary. It's possible that some are things missed in the refactor though.

…nnotate those into the button dictionary. This commit doesn't implement any new pickers, only adds the data for later use.

Use it for the MSG_PAIR picker and the PIC_NONE picker.

This also adds partial support for a custom vehicle graphic.

NQNStudios

The scope of the changes is huge and I think this is taking the scenario editor in a very good direction overall. I still need to look at the actual refactor of the node dictionary.

doc/editor/Specials.html

NQNStudios · 2025-03-02T19:14:57Z

src/fileio/fileio_scen.cpp

+						if(type == "name") {
+							vehicle->GetText(&list[i].name);
+						} else if(type == "pic") {
+							vehicle->GetText(&list[i].pic);


Is this addressing #299? Do existing scenarios need to be updated to specify vehicle graphics / is there a way to edit a vehicle's graphic in the editor yet, or is that another thing for the TODO list?

It only adds the storage space for that information in the scenario format – it's not yet used for anything. So yes, it's related to #299.

src/doxy/mainpage.md

NQNStudios · 2025-03-02T19:37:58Z

src/dialogxml/widgets/control.hpp

 	virtual ~cControl();
 	/// Draw the control into its parent window.
 	virtual void draw() = 0;
 	cControl& operator=(cControl& other) = delete;
 	cControl(cControl& other) = delete;
+	/// Sets the positioning method of this control.
+	/// Note: this only has an effect when called from another control's parse function.
+	void setPositioning(const std::string& anchor_id, ePosition h, ePosition v) {


Is there any way this could break/change existing dialogs with relative positioning?

I don't think so? First of all, nothing could be broken unless this is actually called. Currently, it's only called from the new tilemap widget. I don't think the usage in the tilemap widget can break anything. The tilemap widget fiddles with the names of its nested elements, so essentially all it does is correct the anchor of the nested elements to refer to the adjusted name instead of the name from the XML.

src/dialogxml/widgets/control.hpp

src/dialogxml/widgets/control.cpp

NQNStudios · 2025-03-02T20:03:40Z

rsrc/dialogs/edit-quest.xml

-	<led name='inbank' top='285' left='330'>Include in a job bank:</led>
-	<field name='bank1' top='306' left='344' width='110' height='16'/>
-	<field name='bank2' top='332' left='344' width='110' height='16'/>
+	<led name='rel' wrap='true' top='208' left='345'>Deadline is relative to start day</led>


This could either mean the scenario start day, or quest start day. I'm not sure which it means.

NQNStudios · 2025-03-02T20:12:54Z

rsrc/strings/specials-text-general.txt

@@ -185,10 +196,11 @@ Unused
 0 - allow, 1 - prevent
 Unused
 Unused
-0 - don't force, 1 - force if blocked
+Force allow if blocked?


Kind of confused on the meaning here.

It's something like "if the other field is set to 'allow', override the terrain's blockage". I think it only applies when the action being prevented is movement, but not quite sure.

Better suggestions for the wording are welcome.

src/dialogxml/dialogs/strchoice.cpp

NQNStudios · 2025-03-02T20:31:20Z

src/dialogxml/widgets/stack.cpp

@@ -55,25 +55,25 @@ void cStack::draw() {
 	for(auto& p : controls) {
 		p.second->draw();
 	}
-	if(drawFramed) drawFrame(2, frameStyle);
+	drawFrame(2, frameStyle);


Did you figure out the bug you mentioned with the white lines appearing?

I did not. I strongly suspect that this is the cause but I didn't get around to investigating in detail.

NQNStudios · 2025-03-02T21:14:51Z

When an LED is placed next to ex2a, if the value in the field is -1, it should change to 0, right? Currently you have to click it once to turn it on (1) and again to turn it off (0). Maybe the code already handles -1 as false for those bool flags, but it'd put me more at ease if the value snapped to a known valid one.

NQNStudios · 2025-03-02T21:17:31Z

Some special nodes are showing as "error" in the One-Time category.

NQNStudios · 2025-03-02T21:35:16Z

When you scroll away from your selected SDF in the SDF picker, then scroll back returning it into view, it makes a sound when that LED becomes selected again. Ideally it should change state silently because it wasn't clicked again.

NQNStudios · 2025-03-02T21:42:39Z

I think the SDF picker button is kind of missable where it is.

If the framed labels were narrowed you could fit it as a regular size button with a label on it, to the left of the Part A label. The Part A label is already wider than the Part B one, dunno if there's a reason for that.

CelticMinstrel · 2025-03-02T22:35:04Z

When an LED is placed next to ex2a, if the value in the field is -1, it should change to 0, right? Currently you have to click it once to turn it on (1) and again to turn it off (0). Maybe the code already handles -1 as false for those bool flags, but it'd put me more at ease if the value snapped to a known valid one.

I checked a lot of them in boe.specials.cpp – most of them just do a "greater than zero" check to delineate true from false. It might make sense to warp it to 0, but I decided that was a bit beyond the scope of what I was doing. It's probably something that would make sense for other things besides just toggle… though I'm not convinced it's a good idea in general, as it makes "selecting a different type" perform a possibly lossy change.

Some special nodes are showing as "error" in the One-Time category.

Yes. They were originally "Unused", but I'd need to add an explicit node button dictionary entry to preserve that. I think in practice the solution is to squish them down so that there isn't a gap.

I'm pretty sure changing the internal number of a special node won't actually affect anything at all (feel free to correct me if I'm wrong) – the file references them by opcode name, and everything in the code uses the enum. As for legacy importing, it uses the original integer as the source node and the enum for the target, so it too wouldn't be affected. All I need to do is make sure that the squish happens in both the enum and the file with the list of all the opcode names, and it should be fine.

The other possibility is explicitly declaring them in the button dictionary. That would make them display as "Unused" like they used to.

When you scroll away from your selected SDF in the SDF picker, then scroll back returning it into view, it makes a sound when that LED becomes selected again. Ideally it should change state silently because it wasn't clicked again.

Agreed. I'll see what I can do about that. Do you get the same in the editable string picker or is it only the SDF picker that does this?

I think the SDF picker button is kind of missable where it is.

Well, this isn't new (it's already the case for rectangle nodes that already had pickers before I did this).

…t each of the strings inline and even add new ones. This just implements the guts of the dialog, without using it for anything yet. It also fixes a bug that caused a blank page to appear in the string picker if the total number of strings was an exact multiple of 40. Closes #563

…cker. It's used not only in special node editing (for Event Happens and If Event Happened?) but also in the Townperson Advanced, Talk Node, and Quest editors.

…ring picker. Used in special node editing and also item editing.

These are all cases where similar items stack but these ones for some reason didn't. Gemstones/Ores: Ruby, Crystal, Rough Diamond Powders: Dust of Hiding and Choking Missiles: Poison Darts; Arrows of Life and Light; Burning and Exploding Arrows Reagents: Asp Fangs

…rid. Use it for the Edit Terrain Object dialog.

Fix #629

…widget

…ector. It's currently used in special node editing and in advanced town details.

All controls now store a reference to their direct parent, whether it be the dialog itself or a container control. Every dialog control now has a guaranteed parent, which abstracts away the three possible types of parents (dialog, container, and plain window). The control name is now stored in the control from the moment it is parsed from the XML. This means that it's set before the parseContent function, though after parseAttribute.

…he screen Note: This could make certain larger dialogs always crash with a high enough pixel scale. Needs testing.

…irectly in parse

…ng it a name. In effect, this is a combination of two of the previous pickers: the location picker, and the editable string picker. This required quite a significant rework of how the tilemap places its children. Currently it's only used in special node editing. I plan to add its use in many other places too though.

NQNStudios added enhancement scenedit Affects the scenario editor game Affects the game, as opposed to the editors labels Feb 23, 2025

CelticMinstrel force-pushed the tilemap_and_stuff branch from 78ba2af to 0468dab Compare February 28, 2025 06:29

CelticMinstrel marked this pull request as ready for review March 2, 2025 05:43

CelticMinstrel removed the game Affects the game, as opposed to the editors label Mar 2, 2025

CelticMinstrel added 14 commits March 2, 2025 10:21

Refactor special node properties struct to isolate the magic characters.

8b0df1c

Basically what that means is that the magic characters are only parsed at startup – the scenario editor code doesn't need to understand them, instead using an enum. This is part of the work for #607

Implement the inline special node help button

a09c653

Though this creates the framework, the actual help strings have not been filled in yet.

Rework the special node button dictionary (#607)

1c180d0

Fix some missing annotations in the button dictionary.

357b007

These are mostly errors that were already wrong in the old dictionary. It's possible that some are things missed in the refactor though.

Sketch out what pickers and string lists should probably exist, and a…

1a627d9

…nnotate those into the button dictionary. This commit doesn't implement any new pickers, only adds the data for later use.

Implement the new string types

83643db

Implement a toggle picker for special node fields

c22a854

Implement a mechanism for a special node picker to affect two fields

4289574

Use it for the MSG_PAIR picker and the PIC_NONE picker.

Implement a picker to select a sector in Relocate Outdoors

95e21ea

Convert the edit vehicle dialog to relative positioning

9335f8b

Add a user-defined name to vehicle definitions.

b6adbcc

This also adds partial support for a custom vehicle graphic.

Implement a picker to select a boat or horse when editing a special node

cc65091

Reformat cStringChoice constructors

36485c2

Templatize cStringChoice iterator constructor

c40efa8

CelticMinstrel force-pushed the tilemap_and_stuff branch 2 times, most recently from 48003fc to e976e9a Compare March 2, 2025 15:35

NQNStudios reviewed Mar 2, 2025

View reviewed changes

CelticMinstrel added 17 commits March 2, 2025 18:12

Implement a picker for major events, using the new editable string pi…

91ba391

…cker. It's used not only in special node editing (for Event Happens and If Event Happened?) but also in the Townperson Advanced, Talk Node, and Quest editors.

Implement a picker for selecting an item class, using the editable st…

8192695

…ring picker. Used in special node editing and also item editing.

Use the editable string picker for item type flags in the item editor.

b653494

BoEB: Add item type flag strings

f8e8063

Add a new tilemap control that replicates its children into a fixed g…

b85b4b5

…rid. Use it for the Edit Terrain Object dialog.

Fix a confused error message

185efef

Fix stacks not drawing a frame even if requested

4ccd316

Add a 'filled' option to dialogxml pict and use it in get-items

cb0ad80

Fix #629

Fix an infinite loop when using a container as an anchor for another …

a02f083

…widget

Add a location picker for selecting a location in a town or outdoor s…

0b1eba8

…ector. It's currently used in special node editing and in advanced town details.

Crash early before trying to create a window many times larger than t…

c86b132

…he screen Note: This could make certain larger dialogs always crash with a high enough pixel scale. Needs testing.

Fix findControl() not recursing into children of children

f19706c

Parse name and bounding box attributes in parseAttribute instead of d…

f3ebadb

…irectly in parse

CelticMinstrel force-pushed the tilemap_and_stuff branch from e976e9a to e3b81b6 Compare March 2, 2025 23:14

CelticMinstrel merged commit 3d48cb1 into master Mar 3, 2025
10 of 12 checks passed

CelticMinstrel mentioned this pull request Mar 3, 2025

Rework special node button dictionary #607

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the special node edit dialog with a bunch of new pickers #655

Update the special node edit dialog with a bunch of new pickers #655

CelticMinstrel commented Feb 23, 2025

NQNStudios commented Feb 23, 2025

NQNStudios commented Feb 23, 2025

CelticMinstrel commented Feb 23, 2025 •

edited

Loading

CelticMinstrel commented Feb 28, 2025

CelticMinstrel commented Mar 2, 2025 •

edited

Loading

NQNStudios left a comment

NQNStudios Mar 2, 2025

CelticMinstrel Mar 2, 2025

NQNStudios Mar 2, 2025

CelticMinstrel Mar 2, 2025

NQNStudios Mar 2, 2025

NQNStudios Mar 2, 2025

CelticMinstrel Mar 2, 2025

NQNStudios Mar 2, 2025

CelticMinstrel Mar 2, 2025

NQNStudios commented Mar 2, 2025

NQNStudios commented Mar 2, 2025

NQNStudios commented Mar 2, 2025

NQNStudios commented Mar 2, 2025

CelticMinstrel commented Mar 2, 2025

Update the special node edit dialog with a bunch of new pickers #655

Update the special node edit dialog with a bunch of new pickers #655

Conversation

CelticMinstrel commented Feb 23, 2025

NQNStudios commented Feb 23, 2025

NQNStudios commented Feb 23, 2025

CelticMinstrel commented Feb 23, 2025 • edited Loading

CelticMinstrel commented Feb 28, 2025

CelticMinstrel commented Mar 2, 2025 • edited Loading

NQNStudios left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NQNStudios commented Mar 2, 2025

NQNStudios commented Mar 2, 2025

NQNStudios commented Mar 2, 2025

NQNStudios commented Mar 2, 2025

CelticMinstrel commented Mar 2, 2025

CelticMinstrel commented Feb 23, 2025 •

edited

Loading

CelticMinstrel commented Mar 2, 2025 •

edited

Loading