Skip to content

Commit ee191ea

Browse files
committed
docs: remove old key feature
1 parent 9bd26e5 commit ee191ea

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616

1717
- Navigraph DFD Format: Leverage specialized support for Navigraph's DFD format, based on SQLite, which includes an SQL interface on the commbus for efficient data handling.
1818
- Javascript and WASM support: The navdata interface is accessible from both Javascript (Coherent) and WASM, providing flexibility for developers.
19-
- Supports updating of custom data formats.
2019
- Xbox compatibility: Works on PC and Xbox.
2120
- Persistence: All data is persisted in the `work` folder of the aircraft.
2221

@@ -46,18 +45,19 @@ Here's an overview on the structure of this repository, which is designed to be
4645
```
4746

4847
- Note that if you already have a `VCockpit` with `NO_TEXTURE` you can just add another `htmlgauge` to it, while making sure to increase the index
48+
4949
4. **Optional**: Create a `Navigraph/config.json` file to assist with Sentry reports. This info will be reported to us should any error occur in the library. We will use this to directly reach out to you (the developer) for these errors.
5050

51-
- The file must look like
51+
- The file must look like
5252

53-
```json
54-
{
55-
"addon": {
56-
"developer": "Navigraph",
57-
"product": "Sample Aircraft"
58-
}
59-
}
60-
```
53+
```json
54+
{
55+
"addon": {
56+
"developer": "Navigraph",
57+
"product": "Sample Aircraft"
58+
}
59+
}
60+
```
6161

6262
## Dealing with Bundled Navigation Data
6363

@@ -101,30 +101,30 @@ The gauge communicates using the following event names (all types referenced can
101101
Below is an example of communicating with the interface in JS. (We provide a JS wrapper, the code below is just a basic example to show how it works). Please read the CommBus documentation to determine how to interface with CommBus in your chosen language. `src/js` contains our JS wrapper, it is also a useful example for implementing a fully fleshed out wrapper.
102102

103103
```js
104-
const queue = []
104+
const queue = [];
105105

106106
const listener = RegisterCommBusListener(() => {
107107
listener.on("NAVIGRAPH_FunctionResult", jsonArgs => {
108-
const args = JSON.parse(jsonArgs)
108+
const args = JSON.parse(jsonArgs);
109109

110110
// When a FunctionResult is received, find the item in queue which matches the id, and resolve or reject it
111-
const queueItem = queue.find(m => m.id === args.id)
111+
const queueItem = queue.find(m => m.id === args.id);
112112

113113
if (queueItem) {
114-
queue.splice(queue.indexOf(queueItem), 1)
115-
const data = args.data
114+
queue.splice(queue.indexOf(queueItem), 1);
115+
const data = args.data;
116116

117117
if (args.status === FunctionResultStatus.Success) {
118-
queueItem.resolve(data)
118+
queueItem.resolve(data);
119119
} else {
120-
queueItem.reject(new Error(typeof data === "string" ? data : "Unknown error"))
120+
queueItem.reject(new Error(typeof data === "string" ? data : "Unknown error"));
121121
}
122122
}
123-
})
124-
}) // RegisterCommBusListener is a function provided by sim
123+
});
124+
}); // RegisterCommBusListener is a function provided by sim
125125

126126
function getAirport(ident) {
127-
const id = Utils.generateGUID() // Utils is a class provided by sim
127+
const id = Utils.generateGUID(); // Utils is a class provided by sim
128128

129129
const args = {
130130
function: "GetAirport", // The name of the function being called
@@ -133,21 +133,21 @@ function getAirport(ident) {
133133
// The parameters of the function
134134
ident,
135135
},
136-
}
136+
};
137137

138-
listener.callWasm("NAVIGRAPH_CallFunction", JSON.stringify(args))
138+
listener.callWasm("NAVIGRAPH_CallFunction", JSON.stringify(args));
139139

140140
return new Promise((resolve, reject) => {
141141
queue.push({
142142
id,
143143
resolve: response => resolve(response),
144144
reject: error => reject(error),
145-
})
146-
})
145+
});
146+
});
147147
}
148148

149149
function executeSql(sql, params) {
150-
const id = Utils.generateGUID() // Utils is a class provided by sim
150+
const id = Utils.generateGUID(); // Utils is a class provided by sim
151151

152152
const args = {
153153
function: "ExecuteSQLQuery", // The name of the function being called
@@ -157,16 +157,16 @@ function executeSql(sql, params) {
157157
sql,
158158
params,
159159
},
160-
}
160+
};
161161

162-
listener.callWasm("NAVIGRAPH_CallFunction", JSON.stringify(args))
162+
listener.callWasm("NAVIGRAPH_CallFunction", JSON.stringify(args));
163163

164164
return new Promise((resolve, reject) => {
165165
queue.push({
166166
id,
167167
resolve: response => resolve(response),
168168
reject: error => reject(error),
169-
})
170-
})
169+
});
170+
});
171171
}
172172
```

0 commit comments

Comments
 (0)