Fortify - Add onDeployStop event for cancelling before confirming

[DartRuffian]

When merged this pull request will:

• Add a ace_fortify_onDeployStop local event for when deploying is cancelled before confirming
  • I.e. is called when right clicking after the menu appears
  • Is also called when ace_fortify_deployCanceled is

IMPORTANT

• If the contribution affects the documentation, please include your changes in this pull request so the documentation will appear on the website.
• Development Guidelines are read, understood and applied.
• Title of this PR uses our standard template Component - Add|Fix|Improve|Change|Make|Remove {changes}.

[DartRuffian]

Title could probably be changed, feels a bit wordy but couldn't think of a good way to phrase it.

[johnb432]

Why not use ace_fortify_deployCanceled, instead of creating a new event?

[DartRuffian]

Why not use ace_fortify_deployCanceled, instead of creating a new event?

Different parameters, I made it match the acex_fortify_onDeployStart event, subbing out the object itself with the type of object.

[johnb432]

Different parameters, I made it match the acex_fortify_onDeployStart event, subbing out the object itself with the type of object.

deployCanceled contains the same parameters (and more) as your current implementation of ace_fortify_onDeployStop, so imo not a good enough reason to add.

I'm guessing you want a listenable event when the player stops deploying?

[DartRuffian]

Different parameters, I made it match the acex_fortify_onDeployStart event, subbing out the object itself with the type of object.

deployCanceled contains the same parameters (and more) as your current implementation of ace_fortify_onDeployStop, so imo not a good enough reason to add.

I'm guessing you want a listenable event when the player stops deploying?

I could give it the same params, just figured it would make more sense to have a matching event instead of the deployCanceled. Could just update it to use the other event as well.

[DartRuffian]

Updated it to use deployCanceled instead of a new event

[johnb432]

Updated it to use deployCanceled instead of a new event

You misunderstood me and my intentions.

deployCanceled does not work in this context, because we refund the cost of placing something down if you cancel it (see XEH_postInit.sqf).

deployCanceled contains the same parameters (and more) as your current implementation of ace_fortify_onDeployStop, so imo not a good enough reason to add.

There might be a good reason to add a new event, however the one you gave isn't good enough.

So I ask again: I'm guessing you want a listenable event when the player stops deploying?
If yes, then, given how the component is structured, we should add a listenable event.

[DartRuffian]

There might be a good reason to add a new event, however the one you gave isn't good enough.

So I ask again: I'm guessing you want a listenable event when the player stops deploying? If yes, then, given how the component is structured, we should add a listenable event.

Yes.
Currently, onDeployCanceled is only emitted after the player initially starts building an object. If you have code that runs on acex_fortify_onDeployStart and is supposed to stop running if a player stops building an object, there is no (easy) way to detect if a player stops building before starting to construct an object.

[johnb432]

@DartRuffian I've added your initial suggestion back partially. However, this event won't be thrown when you cancel.
If you want to know when it's cancelled, use the cancel event. I see no reason why to mix stop and cancel in the stop event. It would make it worse imo: You couldn't tell the difference between when something has been cancelled or stopped, when there might be cases where you'd want to.

[DartRuffian]

@DartRuffian I've added your initial suggestion back partially. However, this event won't be thrown when you cancel. If you want to know when it's cancelled, use the cancel event. I see no reason why to mix stop and cancel in the stop event. It would make it worse imo: You couldn't tell the difference between when something has been cancelled or stopped, when there might be cases where you'd want to.

I think I had both events originally there as a placeholder, can't remember an actual good reason for it being there

[LinkIsGrim]

LGTM