Skip to content

Interface IStardewAccessApi

Definition

Namespace: StardewUI.ModIntegration
Assembly: StardewUI.dll

stardew access API

public interface IStardewAccessApi

Members

Methods

Name Description
SayMenuElement(IScreenReadable, Boolean) Speaks the content of the given element while using the menu query to prevent speaking multiple times in the menu.
Translate(string, Object, string, Boolean) Translate some text using Stardew Access translations

Details

Methods

SayMenuElement(IScreenReadable, bool)

Speaks the content of the given element while using the menu query to prevent speaking multiple times in the menu.

bool SayMenuElement(StardewValley.Menus.IScreenReadable element, bool interrupt);
Parameters

element   IScreenReadable
The element to be spoken.

interrupt   Boolean
Whether to skip the currently speaking text or not.

Returns

Boolean

true if the element was spoken otherwise false.


Translate(string, Object, string, bool)

Translate some text using Stardew Access translations

string Translate(string translationKey, System.Object tokens, string translationCategory, bool disableWarning);
Parameters

translationKey   string

tokens   Object

translationCategory   string

disableWarning   Boolean

Returns

string