rs3-api-core 0.0.0-stage → 0.1.0
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.
- package/LICENSE +21 -0
- package/README.md +39 -2
- package/data/permissions.json +27 -0
- package/index.d.ts +13 -0
- package/package.json +36 -4
- package/types/config/AchievementTypeProxy.d.ts +31 -0
- package/types/config/AssetID.d.ts +3 -0
- package/types/config/AssetIdLookup.d.ts +7 -0
- package/types/config/BASTypeProxy.d.ts +5 -0
- package/types/config/Config.d.ts +58 -0
- package/types/config/ConfigTypeProxy.d.ts +7 -0
- package/types/config/CursorTypeProxy.d.ts +7 -0
- package/types/config/DBRowTypeProxy.d.ts +9 -0
- package/types/config/DBTableTypeProxy.d.ts +9 -0
- package/types/config/EnumTypeProxy.d.ts +11 -0
- package/types/config/FontConfigProxy.d.ts +15 -0
- package/types/config/HeadbarTypeProxy.d.ts +5 -0
- package/types/config/HitmarkTypeProxy.d.ts +5 -0
- package/types/config/Id.d.ts +38 -0
- package/types/config/InvConfigProxy.d.ts +6 -0
- package/types/config/LocTypeProxy.d.ts +28 -0
- package/types/config/MapElementTypeProxy.d.ts +28 -0
- package/types/config/NPCTypeProxy.d.ts +44 -0
- package/types/config/ObjTypeProxy.d.ts +20 -0
- package/types/config/ParamHolder.d.ts +8 -0
- package/types/config/ParamTypeProxy.d.ts +6 -0
- package/types/config/QuestTypeProxy.d.ts +24 -0
- package/types/config/SeqTypeProxy.d.ts +13 -0
- package/types/config/StructTypeProxy.d.ts +3 -0
- package/types/config/VarApi.d.ts +9 -0
- package/types/config/VarLookup.d.ts +6 -0
- package/types/config/VarProxy.d.ts +8 -0
- package/types/config/index.d.ts +27 -0
- package/types/entities/EntityFilter.d.ts +11 -0
- package/types/entities/LocEntityProxy.d.ts +8 -0
- package/types/entities/LocList.d.ts +12 -0
- package/types/entities/LocSectionEntityProxy.d.ts +5 -0
- package/types/entities/NPCEntityProxy.d.ts +16 -0
- package/types/entities/NPCList.d.ts +13 -0
- package/types/entities/ObjStackEntityProxy.d.ts +9 -0
- package/types/entities/ObjStackEntry.d.ts +6 -0
- package/types/entities/ObjStackList.d.ts +10 -0
- package/types/entities/PlayerEntityProxy.d.ts +10 -0
- package/types/entities/PlayerList.d.ts +10 -0
- package/types/entities/index.d.ts +11 -0
- package/types/enums/AchievementDescriptionType.d.ts +13 -0
- package/types/enums/AchievementHiddenType.d.ts +10 -0
- package/types/enums/AchievementProgressType.d.ts +12 -0
- package/types/enums/AnimationDuplicateBehaviour.d.ts +10 -0
- package/types/enums/BoxCornerType.d.ts +15 -0
- package/types/enums/ChatType.d.ts +76 -0
- package/types/enums/EntityType.d.ts +14 -0
- package/types/enums/GameKey.d.ts +90 -0
- package/types/enums/GameState.d.ts +17 -0
- package/types/enums/GrandExchangeOfferStage.d.ts +13 -0
- package/types/enums/GrandExchangeOfferType.d.ts +9 -0
- package/types/enums/HeightOffsetType.d.ts +10 -0
- package/types/enums/LocShapeType.d.ts +32 -0
- package/types/enums/MapElementHorizontalAlign.d.ts +10 -0
- package/types/enums/MapElementTextSize.d.ts +10 -0
- package/types/enums/MapElementVerticalAlign.d.ts +10 -0
- package/types/enums/MiniMenuActionType.d.ts +72 -0
- package/types/enums/MiniMenuActionVerbType.d.ts +11 -0
- package/types/enums/MiniMenuEntryType.d.ts +18 -0
- package/types/enums/ModifierKey.d.ts +13 -0
- package/types/enums/ObjStackType.d.ts +10 -0
- package/types/enums/PersistentDBType.d.ts +9 -0
- package/types/enums/PluginResourceLoadResult.d.ts +12 -0
- package/types/enums/PostAnimMove.d.ts +11 -0
- package/types/enums/PreAnimMove.d.ts +12 -0
- package/types/enums/QuestDifficulty.d.ts +13 -0
- package/types/enums/QuestType.d.ts +10 -0
- package/types/enums/RotationType.d.ts +11 -0
- package/types/enums/ShapeEntityAlignType.d.ts +7 -0
- package/types/enums/SkillType.d.ts +36 -0
- package/types/enums/SystemKey.d.ts +92 -0
- package/types/enums/ValueType.d.ts +48 -0
- package/types/enums/index.d.ts +32 -0
- package/types/events/ChatMessageEvent.d.ts +6 -0
- package/types/events/ConsumableEventSource.d.ts +7 -0
- package/types/events/CustomAPIEvent.d.ts +5 -0
- package/types/events/EntityDrawEvent.d.ts +6 -0
- package/types/events/Event.d.ts +47 -0
- package/types/events/EventSource.d.ts +7 -0
- package/types/events/GameStateChangedEvent.d.ts +6 -0
- package/types/events/GrandExchangeOfferUpdatedEvent.d.ts +5 -0
- package/types/events/InventoryAddedRemovedEvent.d.ts +6 -0
- package/types/events/InventoryUpdatedEvent.d.ts +6 -0
- package/types/events/KeyTypedEvent.d.ts +5 -0
- package/types/events/KeyUpDownEvent.d.ts +8 -0
- package/types/events/LocAddedEvent.d.ts +3 -0
- package/types/events/LocAnimationEvent.d.ts +6 -0
- package/types/events/LocCustomisedEvent.d.ts +7 -0
- package/types/events/LocEvent.d.ts +12 -0
- package/types/events/LocRemovedEvent.d.ts +3 -0
- package/types/events/MainDrawEvent.d.ts +5 -0
- package/types/events/MainLogicEvent.d.ts +5 -0
- package/types/events/MiniMenuEntryEvent.d.ts +6 -0
- package/types/events/MiniMenuOpenedClosedEvent.d.ts +5 -0
- package/types/events/NPCEntityProxyEvent.d.ts +6 -0
- package/types/events/ObjStackEntityAddedRemovedEvent.d.ts +9 -0
- package/types/events/ObjStackEntityChangedEvent.d.ts +8 -0
- package/types/events/OptionalDependencyChangedEvent.d.ts +6 -0
- package/types/events/OptionalPermissionChangedEvent.d.ts +5 -0
- package/types/events/PlayerEntityProxyEvent.d.ts +6 -0
- package/types/events/RegionCreatedEvent.d.ts +7 -0
- package/types/events/RunEnergyTransmitEvent.d.ts +6 -0
- package/types/events/RunWeightTransmitEvent.d.ts +6 -0
- package/types/events/SkillTransmitEvent.d.ts +9 -0
- package/types/events/VarTransmitEvent.d.ts +8 -0
- package/types/events/WindowFocusChangedEvent.d.ts +5 -0
- package/types/events/WindowSizeChangedEvent.d.ts +8 -0
- package/types/events/WorldCreatedEvent.d.ts +8 -0
- package/types/events/index.d.ts +35 -0
- package/types/game/Camera.d.ts +7 -0
- package/types/game/Chat.d.ts +5 -0
- package/types/game/ChatLine.d.ts +11 -0
- package/types/game/Game.d.ts +5 -0
- package/types/game/GameOptions.d.ts +48 -0
- package/types/game/GrandExchange.d.ts +6 -0
- package/types/game/GrandExchangeOffer.d.ts +11 -0
- package/types/game/HintArrowOptions.d.ts +12 -0
- package/types/game/HintList.d.ts +13 -0
- package/types/game/HintPolygonOptions.d.ts +11 -0
- package/types/game/HintTrailOptions.d.ts +8 -0
- package/types/game/Keyboard.d.ts +12 -0
- package/types/game/MiniMenu.d.ts +5 -0
- package/types/game/MiniMenuEntry.d.ts +23 -0
- package/types/game/MiniMenuEntryDataComponent.d.ts +5 -0
- package/types/game/MiniMenuEntryDataGround.d.ts +5 -0
- package/types/game/MiniMenuEntryDataLoc.d.ts +6 -0
- package/types/game/MiniMenuEntryDataMapElement.d.ts +5 -0
- package/types/game/MiniMenuEntryDataNPC.d.ts +6 -0
- package/types/game/MiniMenuEntryDataObj.d.ts +6 -0
- package/types/game/MiniMenuEntryDataPlayer.d.ts +5 -0
- package/types/game/MiniMenuHandle.d.ts +7 -0
- package/types/game/Mouse.d.ts +8 -0
- package/types/game/OptionProxy.d.ts +14 -0
- package/types/game/Player.d.ts +15 -0
- package/types/game/ScreenConvert.d.ts +9 -0
- package/types/game/ShapeDrawOptions.d.ts +10 -0
- package/types/game/ShapeEntityProxy.d.ts +5 -0
- package/types/game/ShapeInstanceProxy.d.ts +14 -0
- package/types/game/ShapeList.d.ts +14 -0
- package/types/game/World.d.ts +17 -0
- package/types/game/audio/Audio.d.ts +7 -0
- package/types/game/audio/AudioBus.d.ts +25 -0
- package/types/game/audio/EmitterShape.d.ts +14 -0
- package/types/game/audio/SoundInstanceProxy.d.ts +10 -0
- package/types/game/audio/SoundPlaybackParams.d.ts +16 -0
- package/types/game/audio/SoundType.d.ts +23 -0
- package/types/game/audio/index.d.ts +6 -0
- package/types/game/index.d.ts +32 -0
- package/types/http/HTTPRequest.d.ts +24 -0
- package/types/http/index.d.ts +1 -0
- package/types/inventory/Inventory.d.ts +5 -0
- package/types/inventory/InventoryProxy.d.ts +12 -0
- package/types/inventory/InventorySlot.d.ts +7 -0
- package/types/inventory/index.d.ts +3 -0
- package/types/math/AABB.d.ts +33 -0
- package/types/math/CoordFine.d.ts +9 -0
- package/types/math/CoordGrid.d.ts +12 -0
- package/types/math/Matrix33.d.ts +6 -0
- package/types/math/Quaternion.d.ts +13 -0
- package/types/math/Rect.d.ts +21 -0
- package/types/math/Vector2.d.ts +22 -0
- package/types/math/Vector3.d.ts +24 -0
- package/types/math/Vector4.d.ts +17 -0
- package/types/math/index.d.ts +9 -0
- package/types/plugin/Functions.d.ts +9 -0
- package/types/plugin/Lifecycle.d.ts +6 -0
- package/types/plugin/Plugin.d.ts +10 -0
- package/types/plugin/PluginImageResource.d.ts +6 -0
- package/types/plugin/PluginPermission.d.ts +3 -0
- package/types/plugin/PluginPermissions.d.ts +7 -0
- package/types/plugin/PluginResource.d.ts +6 -0
- package/types/plugin/PluginSoundResource.d.ts +3 -0
- package/types/plugin/Utils.d.ts +5 -0
- package/types/plugin/index.d.ts +9 -0
- package/types/storage/PersistentDB.d.ts +3 -0
- package/types/storage/PersistentDBApi.d.ts +21 -0
- package/types/storage/index.d.ts +2 -0
- package/types/ui/Component.d.ts +32 -0
- package/types/ui/Hook.d.ts +60 -0
- package/types/ui/Interface.d.ts +5 -0
- package/types/ui/InterfaceManager.d.ts +7 -0
- package/types/ui/Margin.d.ts +10 -0
- package/types/ui/Pos.d.ts +8 -0
- package/types/ui/Size.d.ts +8 -0
- package/types/ui/StyleSheetRegistry.d.ts +6 -0
- package/types/ui/Ui.d.ts +7 -0
- package/types/ui/components/Button.d.ts +3 -0
- package/types/ui/components/Canvas.d.ts +12 -0
- package/types/ui/components/Carousel.d.ts +3 -0
- package/types/ui/components/Check.d.ts +3 -0
- package/types/ui/components/ComboField.d.ts +3 -0
- package/types/ui/components/Grid.d.ts +3 -0
- package/types/ui/components/GroupBox.d.ts +3 -0
- package/types/ui/components/InputField.d.ts +3 -0
- package/types/ui/components/Layer.d.ts +3 -0
- package/types/ui/components/Line.d.ts +3 -0
- package/types/ui/components/List.d.ts +3 -0
- package/types/ui/components/ModelGroup.d.ts +13 -0
- package/types/ui/components/PagedCarousel.d.ts +3 -0
- package/types/ui/components/PagedLayer.d.ts +3 -0
- package/types/ui/components/PagedLayerHeader.d.ts +3 -0
- package/types/ui/components/Panel.d.ts +3 -0
- package/types/ui/components/RadialProgressOverlay.d.ts +3 -0
- package/types/ui/components/RadioGroup.d.ts +3 -0
- package/types/ui/components/Rectangle.d.ts +3 -0
- package/types/ui/components/ScrollBar.d.ts +3 -0
- package/types/ui/components/Slider.d.ts +3 -0
- package/types/ui/components/Sprite.d.ts +3 -0
- package/types/ui/components/Text.d.ts +3 -0
- package/types/ui/components/index.d.ts +23 -0
- package/types/ui/enums/AlignMode.d.ts +13 -0
- package/types/ui/enums/AspectRatioMode.d.ts +9 -0
- package/types/ui/enums/CarouselButtonDisplayMode.d.ts +10 -0
- package/types/ui/enums/CheckAlignMode.d.ts +13 -0
- package/types/ui/enums/ComponentType.d.ts +33 -0
- package/types/ui/enums/CutscenePlaybackEndReason.d.ts +10 -0
- package/types/ui/enums/DragRenderBehaviour.d.ts +13 -0
- package/types/ui/enums/GroupBoxHeaderAlignMode.d.ts +12 -0
- package/types/ui/enums/InputFieldActionResult.d.ts +15 -0
- package/types/ui/enums/InputFieldFilterMode.d.ts +14 -0
- package/types/ui/enums/InputFieldKeyHandlingMode.d.ts +11 -0
- package/types/ui/enums/ModelCameraTransition.d.ts +12 -0
- package/types/ui/enums/ModelType.d.ts +19 -0
- package/types/ui/enums/ObjectQuantityDisplayMode.d.ts +12 -0
- package/types/ui/enums/PinchAxisBit.d.ts +11 -0
- package/types/ui/enums/PlayerOpType.d.ts +16 -0
- package/types/ui/enums/RadialProgressOverlayFlag.d.ts +13 -0
- package/types/ui/enums/SelectionChangeEvent.d.ts +10 -0
- package/types/ui/enums/SwipeDirectionBit.d.ts +13 -0
- package/types/ui/enums/TextContentVisibilityMode.d.ts +12 -0
- package/types/ui/enums/TriggerMode.d.ts +13 -0
- package/types/ui/enums/index.d.ts +21 -0
- package/types/ui/index.d.ts +11 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Mark7625
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,40 @@
|
|
|
1
|
-
#
|
|
1
|
+
# rs3-api-core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
TypeScript declarations for the standard Jagex RuneScape 3 plugin API.
|
|
4
|
+
|
|
5
|
+
Everything in this package describes the API the game client itself provides to plugins: `Event`, `Player`, `World`, `Inventory`, `config`, `HTTPRequest`, `PersistentDB`, `ui` and the rest, along with the enums and the lifecycle entry points. Nothing here is an invention of this project, and nothing here is a wrapper. If you have written a plugin in Lua, these are the same globals you already use, with types attached.
|
|
6
|
+
|
|
7
|
+
The package is types only. It has no runtime and contributes nothing to your plugin's output. For helpers built on top of this API, see `rs3-api-extended`.
|
|
8
|
+
|
|
9
|
+
## Use
|
|
10
|
+
|
|
11
|
+
```json
|
|
12
|
+
{ "compilerOptions": { "types": ["rs3-api-core"] } }
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Projects created by `rs3-plugin init` already extend a config that does this. The declarations bring in the Lua 5.4 standard library types and the TypeScriptToLua language extensions themselves, so there is nothing else to add.
|
|
16
|
+
|
|
17
|
+
Everything is global, so there are no imports to write:
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
Event.SkillTransmit.Subscribe((e) => {
|
|
21
|
+
print(`${e.skill} reached level ${e.newGameplayLevel}`);
|
|
22
|
+
});
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Conventions
|
|
26
|
+
|
|
27
|
+
API tables are dot calls and userdata objects are colon calls. The declarations encode which is which, so you write ordinary TypeScript and the compiler emits the right form:
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
Event.GameStateChanged.Subscribe(handler); // Event.GameStateChanged.Subscribe(handler)
|
|
31
|
+
PersistentDB.SetInt("key", 1); // PersistentDB:SetInt("key", 1)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Enum members compile to table lookups such as `SkillType.ATTACK`, never to bare numbers, so a plugin keeps working if the underlying values ever move.
|
|
35
|
+
|
|
36
|
+
The Lua global `var` is a reserved word in TypeScript and cannot be declared. `rs3-api-extended` exports it as `vars`.
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
[MIT](https://github.com/Mark7625/rs3-api-ts/blob/main/LICENSE)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$comment": "Permissions the RuneScape client accepts in plugin.json",
|
|
3
|
+
"clientBuild": "950",
|
|
4
|
+
"permissions": [
|
|
5
|
+
{
|
|
6
|
+
"name": "httpAccess",
|
|
7
|
+
"description": "Outbound HTTP(S) through HTTPRequest, limited to hosts listed under \"urls\"",
|
|
8
|
+
"gates": ["\\bHTTPRequest\\b"],
|
|
9
|
+
"gateLabel": "HTTPRequest",
|
|
10
|
+
"needsUrls": true
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"name": "chatAccess",
|
|
14
|
+
"description": "Write to the chat box through Chat.AddMessage",
|
|
15
|
+
"gates": ["\\bChat\\.AddMessage\\b"],
|
|
16
|
+
"gateLabel": "Chat.AddMessage",
|
|
17
|
+
"needsUrls": false
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"name": "trackingAccess",
|
|
21
|
+
"description": "Read the account's tracking id through Player.GetTrackingID",
|
|
22
|
+
"gates": ["\\bPlayer\\.GetTrackingID\\b"],
|
|
23
|
+
"gateLabel": "Player.GetTrackingID",
|
|
24
|
+
"needsUrls": false
|
|
25
|
+
}
|
|
26
|
+
]
|
|
27
|
+
}
|
package/index.d.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/// <reference types="lua-types/5.4" />
|
|
2
|
+
/// <reference types="@typescript-to-lua/language-extensions" />
|
|
3
|
+
/// <reference path="./types/plugin/index.d.ts" />
|
|
4
|
+
/// <reference path="./types/enums/index.d.ts" />
|
|
5
|
+
/// <reference path="./types/math/index.d.ts" />
|
|
6
|
+
/// <reference path="./types/config/index.d.ts" />
|
|
7
|
+
/// <reference path="./types/entities/index.d.ts" />
|
|
8
|
+
/// <reference path="./types/inventory/index.d.ts" />
|
|
9
|
+
/// <reference path="./types/game/index.d.ts" />
|
|
10
|
+
/// <reference path="./types/events/index.d.ts" />
|
|
11
|
+
/// <reference path="./types/http/index.d.ts" />
|
|
12
|
+
/// <reference path="./types/storage/index.d.ts" />
|
|
13
|
+
/// <reference path="./types/ui/index.d.ts" />
|
package/package.json
CHANGED
|
@@ -1,6 +1,38 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rs3-api-core",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "TypeScript declarations for the RuneScape 3 (NXT) Lua plugin API, plus the client facts (permissions) tooling needs. Types only, no runtime.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "Mark7625",
|
|
7
|
+
"homepage": "https://github.com/Mark7625/rs3-api-ts/tree/main/packages/core#readme",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/Mark7625/rs3-api-ts.git",
|
|
11
|
+
"directory": "packages/core"
|
|
12
|
+
},
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/Mark7625/rs3-api-ts/issues"
|
|
15
|
+
},
|
|
16
|
+
"keywords": [
|
|
17
|
+
"runescape",
|
|
18
|
+
"rs3",
|
|
19
|
+
"plugin",
|
|
20
|
+
"lua",
|
|
21
|
+
"types"
|
|
22
|
+
],
|
|
23
|
+
"types": "./index.d.ts",
|
|
24
|
+
"files": [
|
|
25
|
+
"index.d.ts",
|
|
26
|
+
"types",
|
|
27
|
+
"data",
|
|
28
|
+
"README.md",
|
|
29
|
+
"LICENSE"
|
|
30
|
+
],
|
|
31
|
+
"publishConfig": {
|
|
32
|
+
"access": "public"
|
|
33
|
+
},
|
|
34
|
+
"dependencies": {
|
|
35
|
+
"@typescript-to-lua/language-extensions": "^1.19.0",
|
|
36
|
+
"lua-types": "^2.14.1"
|
|
37
|
+
}
|
|
38
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface AchievementTypeProxy extends ConfigTypeProxy {
|
|
4
|
+
readonly name: string;
|
|
5
|
+
readonly progress: AchievementProgressType;
|
|
6
|
+
readonly hiddenType: AchievementHiddenType;
|
|
7
|
+
readonly isMembers: boolean;
|
|
8
|
+
readonly category: number;
|
|
9
|
+
readonly subCategory: number;
|
|
10
|
+
readonly runeScore: number;
|
|
11
|
+
readonly spriteID: number;
|
|
12
|
+
readonly reward: unknown;
|
|
13
|
+
readonly descriptions: unknown;
|
|
14
|
+
readonly hasRequirementDescriptions: boolean;
|
|
15
|
+
readonly requirements: unknown;
|
|
16
|
+
readonly requirementGroupCount: number;
|
|
17
|
+
readonly totalRequirementCount: number;
|
|
18
|
+
readonly completionCountForRequirementGroups: unknown;
|
|
19
|
+
readonly prereqs: unknown;
|
|
20
|
+
readonly prereqsComplete: boolean;
|
|
21
|
+
readonly prereqGroupCount: number;
|
|
22
|
+
readonly totalPrereqCount: number;
|
|
23
|
+
readonly completionCountForPrereqGroups: unknown;
|
|
24
|
+
readonly tallyProgress: number;
|
|
25
|
+
readonly tallyTarget: number;
|
|
26
|
+
readonly graceExpiryRunedate: number;
|
|
27
|
+
readonly dbRowConfig: DBRowTypeProxy | undefined;
|
|
28
|
+
GetPrereqGroupComplete(group: number): boolean;
|
|
29
|
+
GetSubItemCompletionCountForPrereqGroup(group: number): number;
|
|
30
|
+
GetSubItemCompletionCountForRequirementGroup(group: number): number;
|
|
31
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
declare namespace config {
|
|
4
|
+
namespace Achievement {
|
|
5
|
+
function FromID(id: number): AchievementTypeProxy | undefined;
|
|
6
|
+
}
|
|
7
|
+
namespace BaseAnimSet {
|
|
8
|
+
function FromID(id: number): BASTypeProxy | undefined;
|
|
9
|
+
}
|
|
10
|
+
namespace Cursor {
|
|
11
|
+
function FromID(id: number): CursorTypeProxy | undefined;
|
|
12
|
+
}
|
|
13
|
+
namespace DBRow {
|
|
14
|
+
function FromID(id: number): DBRowTypeProxy | undefined;
|
|
15
|
+
}
|
|
16
|
+
namespace DBTable {
|
|
17
|
+
function FromID(id: number): DBTableTypeProxy | undefined;
|
|
18
|
+
}
|
|
19
|
+
namespace Enum {
|
|
20
|
+
function FromID(id: number): EnumTypeProxy | undefined;
|
|
21
|
+
}
|
|
22
|
+
namespace Font {
|
|
23
|
+
function FromID(id: number): FontConfigProxy | undefined;
|
|
24
|
+
}
|
|
25
|
+
namespace Headbar {
|
|
26
|
+
function FromID(id: number): HeadbarTypeProxy | undefined;
|
|
27
|
+
}
|
|
28
|
+
namespace Hitmark {
|
|
29
|
+
function FromID(id: number): HitmarkTypeProxy | undefined;
|
|
30
|
+
}
|
|
31
|
+
namespace Inv {
|
|
32
|
+
function FromID(id: number): InvConfigProxy | undefined;
|
|
33
|
+
}
|
|
34
|
+
namespace Loc {
|
|
35
|
+
function FromID(id: number): LocTypeProxy | undefined;
|
|
36
|
+
}
|
|
37
|
+
namespace MapElement {
|
|
38
|
+
function FromID(id: number): MapElementTypeProxy | undefined;
|
|
39
|
+
}
|
|
40
|
+
namespace NPC {
|
|
41
|
+
function FromID(id: number): NPCTypeProxy | undefined;
|
|
42
|
+
}
|
|
43
|
+
namespace Obj {
|
|
44
|
+
function FromID(id: number): ObjTypeProxy | undefined;
|
|
45
|
+
}
|
|
46
|
+
namespace Param {
|
|
47
|
+
function FromID(id: number): ParamTypeProxy | undefined;
|
|
48
|
+
}
|
|
49
|
+
namespace Quest {
|
|
50
|
+
function FromID(id: number): QuestTypeProxy | undefined;
|
|
51
|
+
}
|
|
52
|
+
namespace Seq {
|
|
53
|
+
function FromID(id: number): SeqTypeProxy | undefined;
|
|
54
|
+
}
|
|
55
|
+
namespace Struct {
|
|
56
|
+
function FromID(id: number): StructTypeProxy | undefined;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface DBRowTypeProxy extends ConfigTypeProxy {
|
|
4
|
+
readonly columnCount: number;
|
|
5
|
+
readonly ownerDBTable: number;
|
|
6
|
+
GetColumnValueCount(column: number): number;
|
|
7
|
+
GetColumnValueTypes(column: number): ValueType[];
|
|
8
|
+
GetColumnValues(column: number): unknown[];
|
|
9
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface DBTableTypeProxy extends ConfigTypeProxy {
|
|
4
|
+
readonly columnCount: number;
|
|
5
|
+
GetColumnValueCount(column: number): number;
|
|
6
|
+
GetColumnValueTypes(column: number): ValueType[];
|
|
7
|
+
GetColumnDefaultValues(column: number): unknown[];
|
|
8
|
+
GetColumnHasDefaultValues(column: number): boolean;
|
|
9
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface EnumTypeProxy extends ConfigTypeProxy {
|
|
4
|
+
readonly inputValueType: ValueType;
|
|
5
|
+
readonly outputValueType: ValueType;
|
|
6
|
+
readonly valueCount: number;
|
|
7
|
+
readonly values: unknown;
|
|
8
|
+
GetInputValues(): unknown[];
|
|
9
|
+
GetOutputValue(input: number): number | string | undefined;
|
|
10
|
+
HasOutputValue(input: number): boolean;
|
|
11
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface FontConfigProxy extends ConfigTypeProxy {
|
|
4
|
+
readonly baseline: number;
|
|
5
|
+
readonly maxAscent: number;
|
|
6
|
+
readonly maxDescent: number;
|
|
7
|
+
readonly upperCaseAscent: number;
|
|
8
|
+
readonly lowerCaseAscent: number;
|
|
9
|
+
GetStringWidth(text: string): number;
|
|
10
|
+
GetStringWidthMultiline(text: string, width: number): number;
|
|
11
|
+
GetStringLineCount(text: string, width: number): number;
|
|
12
|
+
GetStringHeightAndLineCount(text: string, width: number): LuaMultiReturn<[number, number]>;
|
|
13
|
+
SplitString(text: string, width: number): string[];
|
|
14
|
+
GetSplitStringLine(text: string, width: number, line: number): string;
|
|
15
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
declare namespace id {
|
|
4
|
+
const Achievement: AssetIdLookup<"Achievement">;
|
|
5
|
+
const BaseAnimSet: AssetIdLookup<"BaseAnimSet">;
|
|
6
|
+
const Category: AssetIdLookup<"Category">;
|
|
7
|
+
const Component: AssetIdLookup<"Component">;
|
|
8
|
+
const Cursor: AssetIdLookup<"Cursor">;
|
|
9
|
+
const DBRow: AssetIdLookup<"DBRow">;
|
|
10
|
+
const DBTable: AssetIdLookup<"DBTable">;
|
|
11
|
+
const Enum: AssetIdLookup<"Enum">;
|
|
12
|
+
const Font: AssetIdLookup<"Font">;
|
|
13
|
+
const Headbar: AssetIdLookup<"Headbar">;
|
|
14
|
+
const Hitmark: AssetIdLookup<"Hitmark">;
|
|
15
|
+
const Interface: AssetIdLookup<"Interface">;
|
|
16
|
+
const Inv: AssetIdLookup<"Inv">;
|
|
17
|
+
const Loc: AssetIdLookup<"Loc">;
|
|
18
|
+
const MapElement: AssetIdLookup<"MapElement">;
|
|
19
|
+
const Material: AssetIdLookup<"Material">;
|
|
20
|
+
const Model: AssetIdLookup<"Model">;
|
|
21
|
+
const Music: AssetIdLookup<"Music">;
|
|
22
|
+
const NPC: AssetIdLookup<"NPC">;
|
|
23
|
+
const Obj: AssetIdLookup<"Obj">;
|
|
24
|
+
const Param: AssetIdLookup<"Param">;
|
|
25
|
+
const Quest: AssetIdLookup<"Quest">;
|
|
26
|
+
const Seq: AssetIdLookup<"Seq">;
|
|
27
|
+
const Sound: AssetIdLookup<"Sound">;
|
|
28
|
+
const Sprite: AssetIdLookup<"Sprite">;
|
|
29
|
+
const Struct: AssetIdLookup<"Struct">;
|
|
30
|
+
const StyleSheet: AssetIdLookup<"StyleSheet">;
|
|
31
|
+
const UIAnim: AssetIdLookup<"UIAnim">;
|
|
32
|
+
const UIAnimCurve: AssetIdLookup<"UIAnimCurve">;
|
|
33
|
+
const VarClan: AssetIdLookup<"VarClan">;
|
|
34
|
+
const VarClanSetting: AssetIdLookup<"VarClanSetting">;
|
|
35
|
+
const VarClient: AssetIdLookup<"VarClient">;
|
|
36
|
+
const VarPlayer: AssetIdLookup<"VarPlayer">;
|
|
37
|
+
const VarPlayerGroup: AssetIdLookup<"VarPlayerGroup">;
|
|
38
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface LocTypeProxy extends ConfigTypeProxy, ParamHolder {
|
|
4
|
+
readonly name: string;
|
|
5
|
+
readonly width: number;
|
|
6
|
+
readonly length: number;
|
|
7
|
+
readonly isActive: boolean;
|
|
8
|
+
readonly isMultiLoc: boolean;
|
|
9
|
+
readonly isExamineOnly: boolean;
|
|
10
|
+
readonly blockWalk: number;
|
|
11
|
+
readonly multiVar: number;
|
|
12
|
+
readonly mapElement: number;
|
|
13
|
+
readonly opNames: string[];
|
|
14
|
+
readonly locShapeTypes: LocShapeType[];
|
|
15
|
+
readonly animations: unknown;
|
|
16
|
+
readonly defaultAnimation: number;
|
|
17
|
+
readonly useRandomAnimationFrame: boolean;
|
|
18
|
+
readonly modelOffset: Vector3;
|
|
19
|
+
readonly modelPostOffset: Vector3;
|
|
20
|
+
readonly modelScale: Vector3;
|
|
21
|
+
readonly groundDecorOffset: number;
|
|
22
|
+
readonly customBounding: unknown;
|
|
23
|
+
readonly hasCustomBounding: boolean;
|
|
24
|
+
readonly fastPicking: boolean;
|
|
25
|
+
readonly quests: unknown;
|
|
26
|
+
GetModelIDs(): number[];
|
|
27
|
+
GetOpCursor(op: number): number;
|
|
28
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface MapElementTypeProxy extends ConfigTypeProxy, ParamHolder {
|
|
4
|
+
readonly text: string;
|
|
5
|
+
readonly subjectText: string;
|
|
6
|
+
readonly spriteID: number;
|
|
7
|
+
readonly spriteMouseOverID: number;
|
|
8
|
+
readonly flashSpriteID: number;
|
|
9
|
+
readonly category: number;
|
|
10
|
+
readonly listable: boolean;
|
|
11
|
+
readonly isMulitiMapElement: boolean;
|
|
12
|
+
readonly showOnMiniMap: boolean;
|
|
13
|
+
readonly showOnWorldMap: boolean;
|
|
14
|
+
readonly minimapIconScale: number;
|
|
15
|
+
readonly alignHorizontal: MapElementHorizontalAlign;
|
|
16
|
+
readonly alignVertical: MapElementVerticalAlign;
|
|
17
|
+
readonly textSize: MapElementTextSize;
|
|
18
|
+
readonly textColour: number;
|
|
19
|
+
readonly textRGBA: number;
|
|
20
|
+
readonly textMouseOverColour: number;
|
|
21
|
+
readonly textMouseOverRGBA: number;
|
|
22
|
+
readonly textOffsetX: number;
|
|
23
|
+
readonly textOffsetZ: number;
|
|
24
|
+
readonly textBGFill: boolean;
|
|
25
|
+
readonly textBGFillRGBA: number;
|
|
26
|
+
readonly textBGOutline: boolean;
|
|
27
|
+
readonly textBGOutlineRGBA: number;
|
|
28
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface NPCTypeProxy extends ConfigTypeProxy, ParamHolder {
|
|
4
|
+
readonly name: string;
|
|
5
|
+
readonly visibleCombatLevel: number;
|
|
6
|
+
readonly isActive: boolean;
|
|
7
|
+
readonly isFamiliar: boolean;
|
|
8
|
+
readonly isMultiNPC: boolean;
|
|
9
|
+
readonly isOnMiniMap: boolean;
|
|
10
|
+
readonly isExamineOnly: boolean;
|
|
11
|
+
readonly isAlwaysOnTop: boolean;
|
|
12
|
+
readonly isAlwaysOnBottom: boolean;
|
|
13
|
+
readonly gridSize: number;
|
|
14
|
+
readonly maxRange: number;
|
|
15
|
+
readonly wanderRange: number;
|
|
16
|
+
readonly multiVar: number;
|
|
17
|
+
readonly mapElement: number;
|
|
18
|
+
readonly bas: number;
|
|
19
|
+
readonly castsShadows: boolean;
|
|
20
|
+
readonly customBounding: unknown;
|
|
21
|
+
readonly hasCustomBounding: boolean;
|
|
22
|
+
readonly roughBounding: unknown;
|
|
23
|
+
readonly resize: number;
|
|
24
|
+
readonly turnSpeed: number;
|
|
25
|
+
readonly walkSmoothing: number;
|
|
26
|
+
readonly priorityOffset: number;
|
|
27
|
+
readonly overlayHeight: number;
|
|
28
|
+
readonly fastPicking: boolean;
|
|
29
|
+
readonly hasBackgroundSound: boolean;
|
|
30
|
+
readonly backgroundSoundReady: number;
|
|
31
|
+
readonly backgroundSoundWalk: number;
|
|
32
|
+
readonly backgroundSoundRun: number;
|
|
33
|
+
readonly backgroundSoundCrawl: number;
|
|
34
|
+
readonly backgroundSoundVolume: number;
|
|
35
|
+
readonly backgroundSoundRange: number;
|
|
36
|
+
readonly backgroundSoundDropoffRange: number;
|
|
37
|
+
readonly opNames: string[];
|
|
38
|
+
readonly attackOpIndex: number;
|
|
39
|
+
readonly attackOpHasPriority: boolean;
|
|
40
|
+
readonly examineOpIndex: number;
|
|
41
|
+
readonly firstUniqueOpIndex: number;
|
|
42
|
+
readonly quests: unknown;
|
|
43
|
+
GetOpCursor(op: number): number;
|
|
44
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface ObjTypeProxy extends ConfigTypeProxy, ParamHolder {
|
|
4
|
+
readonly isValid: boolean;
|
|
5
|
+
readonly name: string;
|
|
6
|
+
readonly cost: number | undefined;
|
|
7
|
+
readonly isMembers: boolean;
|
|
8
|
+
readonly isStockmarket: boolean;
|
|
9
|
+
readonly isTradeable: boolean;
|
|
10
|
+
readonly stackType: ObjStackType;
|
|
11
|
+
readonly stackCountAltObjs: unknown;
|
|
12
|
+
readonly stockmarketBuyLimit: number;
|
|
13
|
+
readonly category: number;
|
|
14
|
+
readonly teamID: number;
|
|
15
|
+
readonly quests: unknown;
|
|
16
|
+
readonly groundOpNames: string[];
|
|
17
|
+
readonly interfaceOpNames: string[];
|
|
18
|
+
GetGroundOpCursor(op: number): number;
|
|
19
|
+
GetInterfaceOpCursor(op: number): number;
|
|
20
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface QuestTypeProxy extends ConfigTypeProxy, ParamHolder {
|
|
4
|
+
readonly name: string;
|
|
5
|
+
readonly sortName: string;
|
|
6
|
+
readonly deprecated: boolean;
|
|
7
|
+
readonly hasStartedQuest: boolean;
|
|
8
|
+
readonly hasFinishedQuest: boolean;
|
|
9
|
+
readonly canStartQuest: boolean;
|
|
10
|
+
readonly difficulty: QuestDifficulty;
|
|
11
|
+
readonly type: QuestType;
|
|
12
|
+
readonly isMembers: boolean;
|
|
13
|
+
readonly questPoints: number;
|
|
14
|
+
readonly iconID: number;
|
|
15
|
+
readonly preReqQuests: unknown;
|
|
16
|
+
readonly preReqSkills: unknown;
|
|
17
|
+
readonly preReqQuestPoints: number;
|
|
18
|
+
readonly completedPreReqQuests: unknown;
|
|
19
|
+
readonly completedPreReqSkills: unknown;
|
|
20
|
+
readonly completedPreReqQuestPoints: number;
|
|
21
|
+
readonly masterQuestVars: unknown;
|
|
22
|
+
readonly startCoordGrids: CoordGrid[];
|
|
23
|
+
readonly viaCoordGrid: CoordGrid | undefined;
|
|
24
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/** @noSelfInFile */
|
|
2
|
+
|
|
3
|
+
interface SeqTypeProxy extends ConfigTypeProxy, ParamHolder {
|
|
4
|
+
readonly length: number;
|
|
5
|
+
readonly loop: number;
|
|
6
|
+
readonly maxLoop: number;
|
|
7
|
+
readonly priority: number;
|
|
8
|
+
readonly preAnimMove: PreAnimMove;
|
|
9
|
+
readonly postAnimMove: PostAnimMove;
|
|
10
|
+
readonly animDuplicateBehaviour: AnimationDuplicateBehaviour;
|
|
11
|
+
readonly replaceHeldLeft: number;
|
|
12
|
+
readonly replaceHeldRight: number;
|
|
13
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/// <reference path="./ConfigTypeProxy.d.ts" />
|
|
2
|
+
/// <reference path="./ParamHolder.d.ts" />
|
|
3
|
+
/// <reference path="./ObjTypeProxy.d.ts" />
|
|
4
|
+
/// <reference path="./NPCTypeProxy.d.ts" />
|
|
5
|
+
/// <reference path="./LocTypeProxy.d.ts" />
|
|
6
|
+
/// <reference path="./QuestTypeProxy.d.ts" />
|
|
7
|
+
/// <reference path="./AchievementTypeProxy.d.ts" />
|
|
8
|
+
/// <reference path="./SeqTypeProxy.d.ts" />
|
|
9
|
+
/// <reference path="./StructTypeProxy.d.ts" />
|
|
10
|
+
/// <reference path="./EnumTypeProxy.d.ts" />
|
|
11
|
+
/// <reference path="./InvConfigProxy.d.ts" />
|
|
12
|
+
/// <reference path="./ParamTypeProxy.d.ts" />
|
|
13
|
+
/// <reference path="./DBRowTypeProxy.d.ts" />
|
|
14
|
+
/// <reference path="./DBTableTypeProxy.d.ts" />
|
|
15
|
+
/// <reference path="./FontConfigProxy.d.ts" />
|
|
16
|
+
/// <reference path="./CursorTypeProxy.d.ts" />
|
|
17
|
+
/// <reference path="./HeadbarTypeProxy.d.ts" />
|
|
18
|
+
/// <reference path="./HitmarkTypeProxy.d.ts" />
|
|
19
|
+
/// <reference path="./BASTypeProxy.d.ts" />
|
|
20
|
+
/// <reference path="./MapElementTypeProxy.d.ts" />
|
|
21
|
+
/// <reference path="./Config.d.ts" />
|
|
22
|
+
/// <reference path="./VarProxy.d.ts" />
|
|
23
|
+
/// <reference path="./VarLookup.d.ts" />
|
|
24
|
+
/// <reference path="./VarApi.d.ts" />
|
|
25
|
+
/// <reference path="./AssetID.d.ts" />
|
|
26
|
+
/// <reference path="./AssetIdLookup.d.ts" />
|
|
27
|
+
/// <reference path="./Id.d.ts" />
|