Allow TextBoxComponent to skip

[livtanong]

Problem to solve

It is a fairly common feature for a game to "type out" dialogue within a TextBoxComponent (as the behavior would be if timePerChar > 0, but also allow the user to skip that type-out effect, and display the dialogue in its entirety (as the behavior would be if timePerChar == 0).

Proposal

One way to implement this would be to add a setter for boxConfig (currently it does not have one) such that it can be replaced with a new boxConfig wherein boxConfig.timePerChar = 0.

If there are reservations for adding that setter, a method void skip() that does this internally would also work.

More information

No response

Other

• Are you interested in working on a PR for this?

[spydon]

Sounds like a good idea, I'll assign you to the issue since you've marked that you're interested in working on it. :)

[livtanong]

Hello @spydon I may need a bit of help. The functionality is basically done, but...
I'm trying to follow the guidelines here, specifically melos run test.
https://github.com/flame-engine/flame/blob/main/CONTRIBUTING.md#requirements

And the tests fail. A large number of the error messages follow this form:

ERROR: ERROR: ERROR: package:trex_game has uses-material-design: true set but the primary pubspec contains uses-material-design: false. If the application needs material icons, then uses-material-design must be set to true.

Resulting in:

melos run test
└> melos run test:select --no-select
└> FAILED
ScriptException: The script test failed to execute.

These are not related to my changes. Indeed, even when I run melos run test on the current main branch, the result is similar. I am unsure how to proceed.

[spydon]

That is not related to your changes, it is due to the pre-release version of Melos that we're using.
You can just push up the PR and the tests should run properly in the pipeline. :)

[spydon]

If you use the pre-release version of Melos I think you should be able to get it to run locally too:

dart pub global activate melos 7.0.0-dev.7