@paulbarmstrong/js-to-sqf 0.1.3-alpha → 0.1.4-alpha

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.
Files changed (2) hide show
  1. package/index.d.ts +65 -12
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -5076,18 +5076,6 @@ export function ctrlText(idc: number): string
5076
5076
  */
5077
5077
  export function ctrlTextV2(controlName: Control): string
5078
5078
 
5079
- /**
5080
- * Limit the speed of an AI-driven vehicle or AI person to given value. It has
5081
- * continuous effect and AI will not break through the speed limitation until one
5082
- * is contacted, engaged or regrouped.
5083
- *
5084
- * @param speed - in km/h; By default, it's 2 * maxSpeed of the vehicle/unit (which is defined in
5085
- * config)
5086
- * @see {@link https://community.bistudio.com/wiki/limitSpeed}
5087
- * @sqfsyntaxtype binary
5088
- */
5089
- export function limitSpeed(objectName: GameObject, speed: number | boolean): void
5090
-
5091
5079
  /**
5092
5080
  * Adds a row of strings.
5093
5081
  *
@@ -5216,6 +5204,62 @@ export function lnbSetTextV2(ctrl: Control, cell: [number, number], data: string
5216
5204
  */
5217
5205
  export function parseNumber(value: string | boolean | any): number
5218
5206
 
5207
+ /**
5208
+ * Return a UniqueID of the given unit (player). The returned string is the
5209
+ * player's steamID64: private _steamProfileUrl =
5210
+ * "http://steamcommunity.com/profiles/" + (getPlayerUID player); ⚠Prior to Arma 2:
5211
+ * Operation Arrowhead v1.60, the result always consisted of a stringified number
5212
+ * (see getPlayerUIDOld), but always had to be considered and processed as a
5213
+ * String. Converting it to a Number could cause precision problems, as Number
5214
+ * cannot accurately represent integers above 16777216 (224). Moreover, games since
5215
+ * Arma 2: Operation Arrowhead v1.61 provide a value that is not all-numeric.
5216
+ * ⓘPrior to Arma 3 v2.02, in some cases the identity of certain player units could
5217
+ * fail to propagate to other clients and the server, which caused isPlayer and
5218
+ * getPlayerUID to incorrectly return false and "" respectively, where the affected
5219
+ * units were not local. See this bug report (GitHub) for more info. This was
5220
+ * supposedly fixed, but you should remain vigilant toward false negatives
5221
+ * nonetheless.
5222
+ *
5223
+ * @returns can be "_SP_AI_" or "_SP_PLAYER_" in SP, "" or UID in MP
5224
+ * @see {@link https://community.bistudio.com/wiki/getPlayerUID}
5225
+ * @sqfsyntaxtype unary
5226
+ */
5227
+ export function getPlayerUID(unit: GameObject): string
5228
+
5229
+ /**
5230
+ * Returns true if the machine executing the command is the server in a multiplayer
5231
+ * game or is running single player. It will return true for both dedicated and
5232
+ * player-hosted server. See also Multiplayer Scripting/machines.
5233
+ *
5234
+ * @returns boolean
5235
+ * @see {@link https://community.bistudio.com/wiki/isServer}
5236
+ * @sqfsyntaxtype nullary
5237
+ */
5238
+ export function isServer(): boolean
5239
+
5240
+ /**
5241
+ * Returns the machine network ID of the client that initiated Remote Execution.
5242
+ * ⚠Running this command
5243
+ * • in a Single Player environment
5244
+ * • outside of a remote-executed context
5245
+ * • in a remote-executed context received from a Headless Client will return 0 by
5246
+ * design. To check if the context is remote executed, use isRemoteExecuted or
5247
+ * isRemoteExecutedJIP.
5248
+ *
5249
+ * @returns returns zero in the specific cases listed in the Description
5250
+ * @see {@link https://community.bistudio.com/wiki/remoteExecutedOwner}
5251
+ * @sqfsyntaxtype nullary
5252
+ */
5253
+ export function remoteExecutedOwner(): number
5254
+
5255
+ /**
5256
+ * Sets the position of a location.
5257
+ *
5258
+ * @see {@link https://community.bistudio.com/wiki/setPosition}
5259
+ * @sqfsyntaxtype binary
5260
+ */
5261
+ export function setPosition(location: Location, pos: PositionAGL): void
5262
+
5219
5263
 
5220
5264
  export namespace bis {
5221
5265
  /**
@@ -5393,4 +5437,13 @@ export function stringToMarker(data: string): string
5393
5437
  */
5394
5438
  export function triggerToMarker(trigger: GameObject, markerName: string): GameObject
5395
5439
 
5440
+ /**
5441
+ * Example (Click to enlarge) Display a text in the "mission" GUI area with some
5442
+ * effects. Good for the beginning of a mission.
5443
+ *
5444
+ * @see {@link https://community.bistudio.com/wiki/BIS_fnc_infoText}
5445
+ * @sqfsyntaxtype unary
5446
+ */
5447
+ export function infoText(Array of Strings: any): void
5448
+
5396
5449
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@paulbarmstrong/js-to-sqf",
3
- "version": "0.1.3-alpha",
3
+ "version": "0.1.4-alpha",
4
4
  "type": "module",
5
5
  "publishConfig": {
6
6
  "access": "public"