Skip to content
πŸ“ TypeScript types for the scripting API
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_automatic-broken
namespaces
.gitignore
LICENSE
README.md
hifi.d.ts

README.md

High Fidelity: Scripting API Types

πŸ“ TypeScript types for the scripting API

Overview

This is not complete yet but I'm working on it.

Here is the official html docs: https://apidocs.highfidelity.com

Installation

  • Enter the folder where you will be working
git clone https://github.com/makitsune/hifi-types
  • Optionally, create a new file tsconfig.json
{
	"compilerOptions": {
		"pretty": true,
		"removeComments": false,
		"strict": true,
		"target": "es3",
		"lib": ["es5"]
	}
}
  • To compile on file changes tsc -w

There are other ways you can use these types too:

  • Add this repo as a submodule to an existing repo
  • Clone this repo elsewhere and link it to your project folder
    • Windows: mklink /J types D:\Git\hifi-types
    • Linux: ln -s ~/git/hifi-types types

Examples

Examples will appear in the repository eventually. For now, take a look at https://github.com/makitsune/hifi-things

Checklist

Namespaces

  • Audio
  • Controller
  • Entities
  • Mat4
  • MyAvatar
  • Quat
  • Render
  • Script
  • ScriptDiscoveryService
  • Settings
  • SoundCache
  • Tablet
  • Vec3
  • Window
You can’t perform that action at this time.