StrataPlugin
strata-game-library/capacitor / StrataPlugin
Interface: StrataPlugin
Defined in: definitions.ts:179
Methods
addListener()
Call Signature
addListener(
eventName,callback):Promise<{remove: () =>Promise<void>; }>
Defined in: definitions.ts:296
Parameters
eventName
"deviceChange"
callback
(profile) => void
Returns
Promise<{ remove: () => Promise<void>; }>
Call Signature
addListener(
eventName,callback):Promise<{remove: () =>Promise<void>; }>
Defined in: definitions.ts:300
Parameters
eventName
"inputChange"
callback
(snapshot) => void
Returns
Promise<{ remove: () => Promise<void>; }>
Call Signature
addListener(
eventName,callback):Promise<{remove: () =>Promise<void>; }>
Defined in: definitions.ts:304
Parameters
eventName
"gamepadConnected"
callback
(info) => void
Returns
Promise<{ remove: () => Promise<void>; }>
Call Signature
addListener(
eventName,callback):Promise<{remove: () =>Promise<void>; }>
Defined in: definitions.ts:308
Parameters
eventName
"gamepadDisconnected"
callback
(info) => void
Returns
Promise<{ remove: () => Promise<void>; }>
clear()
clear(
options?):Promise<void>
Defined in: definitions.ts:266
Clear all storage (within the namespace if specified).
Parameters
options?
Optional storage configuration
Returns
Promise<void>
configureTouchHandling()
configureTouchHandling(
options):Promise<void>
Defined in: definitions.ts:221
Configure touch handling for games (e.g. prevent scrolling/zooming).
Parameters
options
Returns
Promise<void>
getConnectedControllers()
getConnectedControllers():
Promise<{controllers:object[];selectedIndex:number; }>
Defined in: definitions.ts:286
Get list of all connected game controllers (iOS only).
Returns
Promise<{ controllers: object[]; selectedIndex: number; }>
Object with array of controllers and selected index
getControlHints()
getControlHints():
Promise<ControlHints>
Defined in: definitions.ts:181
Returns
Promise<ControlHints>
getDeviceInfo()
getDeviceInfo():
Promise<DeviceInfo>
Defined in: definitions.ts:205
Get device information relevant to Strata 3D.
Returns
Promise<DeviceInfo>
getDeviceProfile()
getDeviceProfile():
Promise<DeviceProfile>
Defined in: definitions.ts:180
Returns
Promise<DeviceProfile>
getInputSnapshot()
getInputSnapshot():
Promise<InputSnapshot>
Defined in: definitions.ts:182
Returns
Promise<InputSnapshot>
getItem()
getItem<
T>(key,options?):Promise<StorageResult<T>>
Defined in: definitions.ts:243
Retrieve game data from persistent storage.
Type Parameters
T
T = unknown
Parameters
key
string
The key to retrieve
options?
Optional storage configuration
Returns
Promise<StorageResult<T>>
The stored value or null if not found
getPerformanceMode()
getPerformanceMode():
Promise<PerformanceMode>
Defined in: definitions.ts:217
Check if performance mode is enabled or suggest it.
Returns
Promise<PerformanceMode>
getSafeAreaInsets()
getSafeAreaInsets():
Promise<SafeAreaInsets>
Defined in: definitions.ts:213
Get safe area insets for the device.
Returns
Promise<SafeAreaInsets>
haptics()
haptics(
options):Promise<void>
Defined in: definitions.ts:201
Legacy haptics method for backward compatibility.
Parameters
options
Returns
Promise<void>
keys()
keys(
options?):Promise<StorageKeysResult>
Defined in: definitions.ts:259
List all keys in storage (within the namespace if specified).
Parameters
options?
Optional storage configuration
Returns
Promise<StorageKeysResult>
Array of keys
removeItem()
removeItem(
key,options?):Promise<void>
Defined in: definitions.ts:251
Remove a specific key from storage.
Parameters
key
string
The key to remove
options?
Optional storage configuration
Returns
Promise<void>
selectController()
selectController(
options):Promise<{controllerId?:string;error?:string;selectedIndex?:number;success:boolean; }>
Defined in: definitions.ts:275
Select which controller to use for input (iOS only, 0-based index). Use getConnectedControllers() to see available controllers.
Parameters
options
Object with index property
index
number
Returns
Promise<{ controllerId?: string; error?: string; selectedIndex?: number; success: boolean; }>
Object with success status and selected controller info
setInputMapping()
setInputMapping(
mapping):Promise<void>
Defined in: definitions.ts:183
Parameters
mapping
Partial<InputMapping>
Returns
Promise<void>
setItem()
setItem<
T>(key,value,options?):Promise<void>
Defined in: definitions.ts:234
Save game data to persistent storage. On web: Uses localStorage with optional namespace prefix. On native: Uses native platform storage.
Type Parameters
T
T = unknown
Parameters
key
string
The key to store data under
value
T
The value to store (will be JSON serialized)
options?
Optional storage configuration
Returns
Promise<void>
setScreenOrientation()
setScreenOrientation(
options):Promise<void>
Defined in: definitions.ts:209
Lock or unlock screen orientation.
Parameters
options
Returns
Promise<void>
triggerHaptics()
triggerHaptics(
options):Promise<void>
Defined in: definitions.ts:190
Triggers haptic feedback with unified API.
Parameters
options
Haptics configuration
Returns
Promise<void>
Promise that resolves when haptic is triggered
vibrate()
vibrate(
options?):Promise<void>
Defined in: definitions.ts:197
Simple vibration method for basic haptic feedback.
Parameters
options?
Optional duration configuration
duration?
number
Returns
Promise<void>
Promise that resolves when vibration is triggered
