rl-loadout-lib
Version:
Load Rocket League assets into three.js
83 lines • 2.28 kB
TypeScript
import { GLTFLoader } from 'three/examples/jsm/loaders/GLTFLoader';
import { LoadingManager } from 'three';
/**
* Configuration class that affects how rl-loadout-lib behaves.
*/
export declare class RocketConfig {
/**
* The host of the API used for retrieving item information. Default: https://rocket-loadout.com
*/
backendHost: string;
/**
* The Google Cloud Storage bucket that contains the assets. Default : https://storage.googleapis.com/rl-loadout
*/
assetHost: string;
/**
* Loader used for loading GLTF files. This needs to be provided, because draco decompressing files must be served separately.
*/
gltfLoader: GLTFLoader;
/**
* Loading manager used by all loaders inside rl-loadout-lib.
*/
loadingManager: LoadingManager;
/**
* Quality of textures to be loaded.
* @see {@link TextureQuality}
*/
textureQuality: TextureQuality;
/**
* Format of textures to be loaded.
* @see {@link TextureFormat}
*/
textureFormat: TextureFormat;
/**
* Quality of models to be loaded. This is currently unused.
* @see {@link ModelQuality}
*/
modelQuality: ModelQuality;
/**
* Whether draco compressed models should be loaded.
*/
useCompressedModels: boolean;
constructor(init?: Partial<RocketConfig>);
}
/**
* Quality of textures, when downloading them.
*/
export declare enum TextureQuality {
/**
* Load textures in half the size (half width and height).
*/
LOW = 0,
/**
* Load textures in original sizes.
*/
HIGH = 1
}
/**
* Format of textures, when downloading them.
*/
export declare enum TextureFormat {
/**
* Load textures in PNG format with lossy compression.
*/
PNG = 0,
/**
* Load textures in TGA format with lossless LRE compression.
*/
TGA = 1
}
/**
* Quality of models, when downloading them. Not currently used by the library.
*/
export declare enum ModelQuality {
/**
* Download models with less faces/vertices. These models have the decimate modifier applied to them with blender.
*/
LOW = 0,
/**
* Download models with original quality.
*/
HIGH = 1
}
//# sourceMappingURL=rocket-config.d.ts.map