@wayward/types 2.13.3-beta.dev.20230618.4 → 2.13.3-beta.dev.20230619.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -189,7 +189,7 @@ export declare enum ActionDisplayLevel {
|
|
|
189
189
|
export interface IActionUsable {
|
|
190
190
|
usable: true;
|
|
191
191
|
/**
|
|
192
|
-
* Whether this action is currently usable with the "use
|
|
192
|
+
* Whether this action is currently usable with the "auto-use" feature. Defaults to `true`
|
|
193
193
|
*/
|
|
194
194
|
usableOnMove?: boolean;
|
|
195
195
|
displayLevel?: ActionDisplayLevel;
|
|
@@ -216,19 +216,19 @@ export interface IUsableActionDefinitionBase<REQUIREMENTS extends IUsableActionR
|
|
|
216
216
|
* as internal actions are called on all sides, rather than only clientside*.
|
|
217
217
|
*
|
|
218
218
|
* ***Warning:** While usable actions appear to only ever be client-side, they're *not always.*
|
|
219
|
-
* The "use
|
|
220
|
-
* **If you try to perform a client-side UI function here, such as showing a prompt, and a player puts the action in a "use
|
|
219
|
+
* The "auto-use" feature for action slots results in actions being executed *only* on the server's side.
|
|
220
|
+
* **If you try to perform a client-side UI function here, such as showing a prompt, and a player puts the action in a "auto-use" action slot,
|
|
221
221
|
* the host will receive the prompt instead!**
|
|
222
222
|
*
|
|
223
223
|
* If you'd like to execute some things on clientside, you can check if the player is the local player by checking `if (player.asLocalPlayer)`,
|
|
224
|
-
* or ensure that this action is only executed clientside by setting `clientSide: true`, which disables support for the "use
|
|
224
|
+
* or ensure that this action is only executed clientside by setting `clientSide: true`, which disables support for the "auto-use" feature.
|
|
225
225
|
* @param player The player executing this action. This isn't always the local player!
|
|
226
226
|
* @param using What the player is using — items, doodads, etc.
|
|
227
227
|
* @param context Context to do with this action execution — where it's executed from, etc.
|
|
228
228
|
*/
|
|
229
229
|
execute?(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: UsableActionExecutionContext | IUsableActionExecutionContext): any;
|
|
230
230
|
/**
|
|
231
|
-
* Marks this usable action as only executable client-side. This disables support for "use
|
|
231
|
+
* Marks this usable action as only executable client-side. This disables support for "auto-use" in action slots.
|
|
232
232
|
*/
|
|
233
233
|
clientSide?: true;
|
|
234
234
|
/**
|
package/package.json
CHANGED