Update API docs: remove EntropiaNexus references, use generic Item Database API
This commit is contained in:
parent
c017f2fb2e
commit
c08b30e52d
|
|
@ -52,17 +52,17 @@ const loot = await api.readLogFiltered('Loot:');
|
||||||
### Window Manager
|
### Window Manager
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Get EU window info
|
// Get game window info
|
||||||
const window = await api.getEUWindow();
|
const window = await api.getGameWindow();
|
||||||
|
|
||||||
// Check focus
|
// Check focus
|
||||||
const focused = await api.isEUFocused();
|
const focused = await api.isGameFocused();
|
||||||
|
|
||||||
// Bring to front
|
// Bring to front
|
||||||
await api.bringEUToFront();
|
await api.bringGameToFront();
|
||||||
|
|
||||||
// Capture screenshot
|
// Capture screenshot
|
||||||
const screenshot = await api.captureEUWindow();
|
const screenshot = await api.captureGameWindow();
|
||||||
```
|
```
|
||||||
|
|
||||||
**WindowInfo:**
|
**WindowInfo:**
|
||||||
|
|
@ -97,13 +97,13 @@ const text = await api.recognizeText({
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### Nexus API
|
### Item Database API
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Search items
|
// Search items
|
||||||
const results = await api.searchNexus({
|
const results = await api.searchItems({
|
||||||
query: 'omegaton',
|
query: 'weapon',
|
||||||
entityType: 'weapons',
|
category: 'equipment',
|
||||||
limit: 10
|
limit: 10
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
@ -113,7 +113,7 @@ const details = await api.getItemDetails('12345');
|
||||||
|
|
||||||
**SearchResult:**
|
**SearchResult:**
|
||||||
```typescript
|
```typescript
|
||||||
interface NexusItem {
|
interface Item {
|
||||||
id: string;
|
id: string;
|
||||||
name: string;
|
name: string;
|
||||||
type: string;
|
type: string;
|
||||||
|
|
@ -260,17 +260,17 @@ interface PluginAPI {
|
||||||
readLogFiltered(pattern: string): Promise<string[]>;
|
readLogFiltered(pattern: string): Promise<string[]>;
|
||||||
|
|
||||||
// Window
|
// Window
|
||||||
getEUWindow(): Promise<WindowInfo | null>;
|
getGameWindow(): Promise<WindowInfo | null>;
|
||||||
isEUFocused(): Promise<boolean>;
|
isGameFocused(): Promise<boolean>;
|
||||||
bringEUToFront(): Promise<void>;
|
bringGameToFront(): Promise<void>;
|
||||||
captureEUWindow(): Promise<string>; // base64
|
captureGameWindow(): Promise<string>; // base64
|
||||||
|
|
||||||
// OCR
|
// OCR
|
||||||
ocrAvailable(): Promise<boolean>;
|
ocrAvailable(): Promise<boolean>;
|
||||||
recognizeText(region: Region): Promise<string>;
|
recognizeText(region: Region): Promise<string>;
|
||||||
|
|
||||||
// Nexus
|
// Item Database
|
||||||
searchNexus(params: SearchParams): Promise<NexusItem[]>;
|
searchItems(params: SearchParams): Promise<Item[]>;
|
||||||
getItemDetails(itemId: string): Promise<any>;
|
getItemDetails(itemId: string): Promise<any>;
|
||||||
|
|
||||||
// HTTP
|
// HTTP
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue