Changing the method name from "triggerMessage" to "displayActionMessage".

Generally speaking, I like to call the message at the bottom an "action message".
And things can "trigger" it, but in the case of a method that actually proactively displays the message, I find "displayActionMessage" to be a better name.

Also, removing package-lock files and improving code style
This commit is contained in:
David Négrier 2021-08-04 19:31:17 +02:00
parent 82832b7055
commit d1e5d57459
12 changed files with 81 additions and 9020 deletions

View file

@ -92,20 +92,38 @@ WA.ui.registerMenuCommand("test", () => {
### Awaiting User Confirmation (with space bar)
```typescript
triggerMessage(message: string, callback: ()=>void): TriggerMessage
```
WA.ui.displayActionMessage(message: string, callback: () => void): ActionMessage
```
Displays a message at the bottom of the screen (that will disappear when space bar is pressed).
<div class="col">
<img src="https://workadventu.re/img/docs/trigger_message.png" class="figure-img img-fluid rounded" alt="" />
</div>
Example:
```javascript
const triggerMessage = WA.ui.triggerMessage("press 'space' to confirm",()=>{
WA.chat.sendChatMessage("confirmed", "trigger message logic")
const triggerMessage = WA.ui.displayActionMessage("press 'space' to confirm", () => {
WA.chat.sendChatMessage("confirmed", "trigger message logic")
});
setTimeout(()=>{
// later
triggerMessage.remove();
},1000)
```
setTimeout(() => {
// later
triggerMessage.remove();
}, 1000)
```
Please note that `displayActionMessage` returns an object of the `ActionMessage` class.
The `ActionMessage` class contains a single method: `remove(): Promise<void>`. This will obviously remove the message when called.
```javascript
class ActionMessage {
/**
* Hides the message
*/
remove() {};
}
```