roavatar-renderer
    Preparing search index...

    Variable FLAGSConst

    FLAGS: {
        ALWAYS_SHOW_ATTACHMENTS: boolean;
        ANIMATE_SKELETON: boolean;
        API_DOMAIN: string;
        API_REQUEST_PREFIX: string;
        API_REQUEST_RETRY: boolean;
        ASSET_REQUEST_PRIORITY: RequestPriority | undefined;
        ASSETDELIVERY_V2: boolean;
        ASSETS_PATH: string;
        AUDIO_ENABLED: boolean;
        AUTO_RESTORE_CONTEXT: boolean;
        AUTO_SKIN_EVERYTHING: boolean;
        AVATAR_JOINT_UPGRADE: boolean;
        BODYCOLOR3: boolean;
        CACHE_HSR_HITS: boolean;
        ENABLE_API_CACHE: boolean;
        ENABLE_API_MESH_CACHE: boolean;
        ENABLE_API_RBX_CACHE: boolean;
        ENABLE_HSR: boolean;
        ENABLE_LC_WEIGHT_CACHE: boolean;
        FETCH_FUNC:
            | ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
            | undefined;
        GEAR_ENABLED: boolean;
        GET_WORKER_FUNC: () => Worker;
        HAIR_IS_BODYPART: boolean;
        HIDE_LAYERED_CLOTHING: boolean;
        HSR_RAY_COUNT: number;
        HSR_RAY_LENGTH: number;
        HSR_SHOW_RAY: boolean;
        INCLUDE_REQUEST_CREDENTIALS_OVERRIDE: RequestCredentials;
        INFLATE_LAYERED_CLOTHING: number;
        INSTANCE_GARBAGE_COLLECT: boolean;
        LAYERED_CLOTHING_ALGORITHM:
            | "linear"
            | "linearnormal"
            | "linearnormal2"
            | "rbf";
        LAYERED_CLOTHING_COOLDOWN: number;
        LEGACY_WELD_BEHAVIOR: boolean;
        LOAD_TEST_PLACE: string
        | undefined;
        ONLINE_ASSETS: boolean;
        PARTICLES_START_FULL: number;
        PARTICLES_START_FULL_FRAMERATE: number;
        POST_PROCESSING_IS_DOUBLE_SIZE: boolean;
        RBF_PATCH_COUNT: number;
        RBF_PATCH_DETAIL_SAMPLES: number;
        RBF_PATCH_SHAPE_SAMPLES: number;
        RENDERER_DELTA_TIME_MULTIPLIER: number;
        RENDERTARGET_TO_CANVASTEXTURE: boolean;
        RIG_PATH: string;
        ROAVATAR_DATA_URL: string;
        ROAVATAR_TRYON_PLACE: number;
        SEARCH_FOR_STRING: string | undefined;
        SHOW_CAGE: boolean;
        SHOW_SKELETON_HELPER: boolean;
        SKELETON_HELPER_INSTANCE_NAME: string | undefined;
        THUMBNAIL_TIMEOUT: number;
        UPDATE_SKELETON: boolean;
        USE_ASSEMBLY: boolean;
        USE_LOCAL_SKELETONDESC: boolean;
        USE_POST_PROCESSING: boolean;
        USE_RENDERTARGET: boolean;
        USE_VERTEX_COLOR: boolean;
        USE_WORKERS: boolean;
        VERBOSE_LOGGING: boolean;
    } = ...

    Type Declaration

    • ALWAYS_SHOW_ATTACHMENTS: boolean

      Always render attachments even when theyre set to not be visible

    • ANIMATE_SKELETON: boolean

      skeleton is animated every frame

    • API_DOMAIN: string

      the domain all api requests go through

    • API_REQUEST_PREFIX: string

      prefix to add before all api requests

    • API_REQUEST_RETRY: boolean

      if requests should be retried once after failing

    • ASSET_REQUEST_PRIORITY: RequestPriority | undefined

      request priority given to fetch for assetdelivery

    • ASSETDELIVERY_V2: boolean

      API uses assetdelivery v2 instead of v1

    • ASSETS_PATH: string

      path to rbxasset:// local files

    • AUDIO_ENABLED: boolean

      makes Audio instances play sound when played

    • AUTO_RESTORE_CONTEXT: boolean

      the renderer will attempt to restore the webgl context when it is lost

    • AUTO_SKIN_EVERYTHING: boolean

      autoskin is applied even when its disabled

    • AVATAR_JOINT_UPGRADE: boolean

      wip, do not enable

    • BODYCOLOR3: boolean

      outfits returned by api use Color3 instead of BrickColor

    • CACHE_HSR_HITS: boolean

      caches amount of hits for each triangle

    • ENABLE_API_CACHE: boolean

      allows API to cache data

    • ENABLE_API_MESH_CACHE: boolean

      allows API to cache mesh data

    • ENABLE_API_RBX_CACHE: boolean

      allows API to cache RBX data

    • ENABLE_HSR: boolean

      enables HSR (hidden surface removal)

    • ENABLE_LC_WEIGHT_CACHE: boolean

      makes linear algorithms cache weights

    • FETCH_FUNC:
          | ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
          | undefined

      the fetch function the api will use

    • GEAR_ENABLED: boolean

      makes HumanoidDescription load gears

    • GET_WORKER_FUNC: () => Worker

      function WorkerPool uses to create workers, replace with your own if workers cant be created using the default method

    • HAIR_IS_BODYPART: boolean

      Only used by RoAvatar UI

    • HIDE_LAYERED_CLOTHING: boolean

      hides layered clothing

    • HSR_RAY_COUNT: number

      rays per triangle

    • HSR_RAY_LENGTH: number

      length of each ray

    • HSR_SHOW_RAY: boolean

      shows rays created by HSR

    • INCLUDE_REQUEST_CREDENTIALS_OVERRIDE: RequestCredentials

      credentials request type when fetching from API_DOMAIN and credentials are usually include

    • INFLATE_LAYERED_CLOTHING: number

      only used by linear algorithms

    • INSTANCE_GARBAGE_COLLECT: boolean

      wip, only for memory leak debugging

    • LAYERED_CLOTHING_ALGORITHM: "linear" | "linearnormal" | "linearnormal2" | "rbf"

      algorithm, rbf (default) is fastest, others are deprecated

    • LAYERED_CLOTHING_COOLDOWN: number

      cooldown between mesh recompile

    • LEGACY_WELD_BEHAVIOR: boolean

      makes welds immediately update (bad for performance)

    • LOAD_TEST_PLACE: string | undefined

      only used by RoAvatar, set this to a string to load a place file, for example "../assets/UniversalApp.rbxm"

    • ONLINE_ASSETS: boolean

      loads assets from assetdelivery instead of local files

    • PARTICLES_START_FULL: number

      How many seconds particles will presimulate (mainly so they arent incomplete in thumbnail generations)

      This can now be set per-scene

    • PARTICLES_START_FULL_FRAMERATE: number

      Framerate of presimulation particles

      This can now be set per-scene

    • POST_PROCESSING_IS_DOUBLE_SIZE: boolean

      doubles render resolution when using post processing

    • RBF_PATCH_COUNT: number

      amount of "patches" that are used for layered clothing, multiple verts share the same patch

    • RBF_PATCH_DETAIL_SAMPLES: number

      amount of nearby vertices each patch samples from

    • RBF_PATCH_SHAPE_SAMPLES: number

      amount of far-away vertices (importants) each patch samples from, this is done so that the overall mesh shape is preserved

    • RENDERER_DELTA_TIME_MULTIPLIER: number

      Multiplier for delta time used by renderer things (does not affect datamodel side of things but particles and such instead)

    • RENDERTARGET_TO_CANVASTEXTURE: boolean

      RenderTarget textures are converted to CanvasTextures which can be exported

    • RIG_PATH: string

      path to RigR6.rbxm and RigR15.rbxm

    • ROAVATAR_DATA_URL: string

      url of model to load that lists issues with specific versions (only used by RoAvatar)

    • ROAVATAR_TRYON_PLACE: number

      the place try-on button sends you to (only used by RoAvatar)

    • SEARCH_FOR_STRING: string | undefined

      makes renderer print out strings in RBX that contain SEARCH_FOR_STRING

    • SHOW_CAGE: boolean

      renders cage mesh instead of actual mesh

    • SHOW_SKELETON_HELPER: boolean

      shows ThreeJS SkeletonHelper

    • SKELETON_HELPER_INSTANCE_NAME: string | undefined

      if set the skeleton helper will only show if the instance has the name

    • THUMBNAIL_TIMEOUT: number

      Amount of time thumbnail generator will wait after no assets are being loaded to resolve, should be a little time at least so particles can render OR just set PARTICLES_START_FULL = true

    • UPDATE_SKELETON: boolean

      skeleton is updated every frame

    • USE_ASSEMBLY: boolean

      caches hierarchy of joints and removes directionality (required for AVATAR_JOINT_UPGRADE)

    • USE_LOCAL_SKELETONDESC: boolean

      skeleton is local instead of global (broken)

      No longer does anything

    • USE_POST_PROCESSING: boolean

      this is needed to enable bloom, but ugly since it disables anti aliasing...

    • USE_RENDERTARGET: boolean

      enables full texture compilation using ThreeJS RenderTarget

    • USE_VERTEX_COLOR: boolean

      forces vertex color to be white when false

    • USE_WORKERS: boolean

      if WebWorkers (multithreading) can be used

    • VERBOSE_LOGGING: boolean

      enables logging for non-critical information