FrooxEngine

A base class for all components that provide Assets, either static or dynamic. It provides common behavior, such as tracking whether the asset is referenced and informing derived classes when the load or free the asset from the memory.

The type of the asset that is provided

Number of references to this asset in the world

Instance of the asset if loaded

Determines if the asset is currently loaded and available for use

This adapter will adjust HDR values over 1 against an inverse 2.2 gamma curve. This is useful for various situations where an HDR color exceeds 1, and a shader is expecting Unity to apply its own HDR conversion. Given we do these conversions ourselves, this ensures scenarios where we want a corrected color - particularly on legacy assets. This also avoids the creation of "fake" color spaces that have no real world basis.

Spawns an in-world representation of a folder or link to a folder.

Slot to spawn the link on The original URL used to retrieve the folder Record loaded from the URL

Will force asset variants to be generated locally. This is mostly useful for debugging and should NOT be used for production, as it will create load on systems and not work on certain platforms (e.g. Android)

This indicates whether already loaded asset with this descriptor can be converted to an asset with a new descriptor. This is used so the engine doesn't have to fully load the asset from scratch again when a new variant is requested. - E.g. texture is loaded with bilinear filtering and trilinear is requested. This change doesn't require a new binary - version to be loaded, just updating GPU flags, so it can be converted. - Alternatively if texture is loaded with BC3 compression, but RawRGBA is requested, this requires full reload and - different binary data, so the asset cannot be converted and the function will return false. Note: The actual conversion from one descriptor to another is responsibility of the engine, not the descriptors. Descriptors only say whether it's possible to do so.

Target descriptor to convert this one to. Whether already loaded asset with this descriptor can be converted to the new descriptor.

When asset providers request different variants to be loaded from the engine, the asset system will attempt to combine those descriptors into as few as possible, to avoid having to load multiple versions of the same asset. This function will try to combine two descriptors into a single one. - If the descriptors are mutually exclusive, it MUST return null, which will tell the engine they can't be merged. - Otherwise it should generate a new descriptor, that's best possible combination of them both. -- E.g. if one request if for texture with size 512 and one with size 1024, then the final descriptor will be for 1024 -- E.g. if one request if for bilinear filtering and another for trilinear, the result will use trilinear, since it's -- superior and trilinear is considered a suitable "upgrade" for bilinear. That is unless the descriptor says that it -- needs an exact variant if it specifically really wants bilinear.

The descriptor to combine this descriptor with. Null if descriptors are mutually exclusive or a new descriptor that's a superset of current one and provided. NOTE: Opaque typedef for lip-sync context is an unsigned int (uint) Current phoneme frame results

Creates a lip-sync context.

error code Context. Provider. Enable DSP Acceleration.

Creates a lip-sync context with specified model file.

error code Context. Provider. Model Dir. Sampling Rate. Enable DSP Acceleration.

Destroy a lip-sync context.

The context. Context.

Resets the context.

error code Context.

Sends a signal to the lip-sync engine.

error code Context. Signal. Arg1. Arg2.

Process float[] audio buffer by lip-sync engine.

error code Context. PCM audio buffer. Lip-sync Frame. Whether buffer is part of stereo or mono stream.

Process short[] audio buffer by lip-sync engine.

error code Context. PCM audio buffer. Lip-sync Frame. Whether buffer is part of stereo or mono stream.

Use , to instantiate.

This forwards invite request to given contacts and registers it as forwarded.

The invite request to forward Which session is this invite request for The corresponding name of the session List of contacts to forward it to. Typically host or admins

This forwards invite request to given contacts and registers it as forwarded.

The invite request to forward Indicates of the user who wants invite is contact of the host List of contacts to forward it to. Typically host or admins

This forwards invite request to given contacts and registers it as forwarded.

The invite request to forward Method that converts the invite request into a forwarded message List of contacts to forward it to. Typically host or admins

We use a 3D model based reference for calibrating feet, taken from the Y-bot mixamo model. The foot has its pivot at the ankle (which matches how bones are generally mapped). This means that the actual position of the foot pivot is off the ground. So in order to position the foot correctly at the ground, we need to know how much above the ground it is located. This value is measured from the model itself in-game.

Reconfigures the audio output of the user who grabs and releases object with this component on. It must be placed on the same slot as the Grabbable component.

A preset for the voice audio output.

Preset to set the voice to when the object is grabbed

Preset to set the voice to when the component is released

Upgrades legacy reverb to the new ZitaReverb implementation

The reverb zone to upgrade

Makes the object fly around the scene in a drone-like manner, pointing it at the active users. The component will follow one or more users and try to keep them entirely in the frame, while alternating height and relative position to them.

The user who updates the object position in the world.

Determines whether the camera is flying around autonomously or whether it's controlled manually via an operator

Reference to a field with field of view of the camera, used for proper framing.

An explicit field of view value in case the FieldOfViewSource is null

Reference to a field with the aspect ratio of the camera.

Explicit aspect ratio value in case the AspectRatioSource is set to null.

A reference to a specific user the camera should follow. Will pick an user automatically if null

Distance above which the user's controllers are excluded from the framing

Radius around each user in which it searches for more users to include in a group for framing.

Number of seconds between checks for the biggest group of users in the scene.

Whether it should ignore users who are also running in the camera mode.

Distance of a framing point in front of the user's head

Distance of a framing point in the back of user's head

Distance of a framing point above the user's head

Distance of a framing point below user's head

Offset along the vertical axis from the user's head

Anglular offset around a circle, with zero being in front of the current user (or average front direction of a group)

Additional distance offset to the distance computed by the framing, which fits all the control points in the view.

How fast the camera moves in a circle around the user(s)

How fast the camera moves towards the center of the user or a group framing

How fast the camera rotates at the center of the user or the group

How fast the camera changes the distance from the user/group

How fast do user movements influence the framing points of the camera

Amplitude of the height oscillation of the camera

Amplitude of the distance oscillation of the camera

Angle amplitude of the circle offset oscillation of the camera

Period of the height oscillation of the camera

Period of the distance oscillation of the camera

Period of the circle offset oscillation of the camera

Speed of change of the noise function used to modulate the oscillation speed

Influence of the noise function on the oscillation speed

Whether the camera should check for an occlusion between the user and the itself and adjust accordingly

Whether the camera should adjust height first if it helps resolving the occlusion

How long has the camera to be out of range before it teleports to reset the framing

Distance ratio relative to the computed target distance, above which the camera will trigger teleport to reset framing

An angle between the front direction of the camera and the target center of the framing, above which the camera will trigger teleport

Minimum interval before Fov is changed

Maximum interval before Fov is changed. If set to zero, Fov randomization is disabled.

Lower bound for the randomized field of view angle

Upper bound for the randomized field of view angle

Miminum length of the field of view transition

Maximum length of the field of view transition

A preset that tries to follow and frame the biggest group in the scene.

Preset with a very slow gradual movements, ideal for speeding up the footage for a timelapse.

Preset which makes the camera stay behind the host (or selected user)

Preset which makes the camera fly in front of the host (or selected user) at varying distances. Useful for public events, like when presenting in front of an virtual audience.

Enables manual control of the camera by an operator or by grabbing it.

Will spawn a color editor dialog for a specified field when the button it is attached to is pressed.

Our color dialog only supports ColorX these days so there is no Color(no X) variant.

A component which holds a delegate reference without any additional information.

Type of the delegate the componet holds

Reference to the delegate.

The type of the delegate

The variable was written successfully

Corresponding variable or space wasn't found. This can be resolved by creating one.

The writing failed and is unrecoverable. This can happen when the value or other parameters are invalid

A component which holds a reference without any additional information.

Type of the referenced object

Reference to the object

Type of the referenced object

A component which holds an arbitrary value without any additional information.

Type of the value that is held

The value that is held

Type of the value

When a slot is dropped on this, offer to copy compatible data into the linked field.

This method builds a specific field in the editor.

This method builds out a member editor for a given field of a specified type.

Attaches a ReferenceDriveReceiver component for the given reference field to a slot

Attaches FieldDriveReceiver and ValueReceiver components for the given member field to a slot

Allows multiple vertical and horizontal layouts to exist in the same place with a custom alignment.

Copied from the changelog: - This allows to overlap multiple vertical and horizontal layout in the same place with a custom alignment - This layout will compute metrics based on the largest height/width of its individual layout. - This means that you can for example overlap two VerticalLayouts on top of each other and size the whole based on the largest of the overlapped layouts

True if this overlay should be closed when clicked

Used by to determine the default alignment settings for Layout Children.

Used by to determine the default alignment settings for basic Text.

Used by to determine the default alignment settings for text found within buttons.

The default text color of this UI style.

Creates a panel which will nest subsequent UI elements until a matching NestOut call is made.

Creates a horizontal layout for UI elements. Will automatically nest subsequent UI elements until a matching NestOut call is made.

Creates a vertical layout for UI elements. Will automatically nest subsequent UI elements until a matching NestOut call is made.

Creates a grid layout for UI elements. Will automatically nest subsequent UI elements until a matching NestOut call is made.

Creates a scroll area for UI elements. Will automatically nest subsequent UI elements until a matching NestOut call is made.

The Cartesian axes.

Contains tools for working with Axes that have no positive/negative directions.

Converts an Axis to float3.

Converts a float3 to Axis.

Returns the Axis of the Transform towards a world space position.

Returns the Axis of the Transform towards a world space direction.

Returns the local axis of the Transform towards a world space position.

Returns the local axis of the Transform that aligns the most with a direction.

The base abstract class for all %IK solvers

Determines whether this instance is valid or not.

Determines whether this instance is valid or not. If returns false, also fills in an error message.

Initiate the solver with specified root Transform. Use only if this %IKSolver is not a member of an %IK component.

Updates the %IK solver. Use only if this %IKSolver is not a member of an %IK component or the %IK component has been disabled and you intend to manually control the updating.

The %IK position.

The %IK position weight or the master weight of the solver.

Gets a value indicating whether this has successfully initiated.

Fixes all the Transforms used by the solver to their initial state.

Stores the default local state for the bones used by the solver.

Delegates solver update events.

Delegates solver iteration events.

Called before initiating the solver.

Called after initiating the solver.

Called before updating.

Called after writing the solved pose

Hybrid %IK solver designed for mapping a character to a VR headset and 2 hand controllers

Returns true if all required Transforms have been assigned (shoulder, toe and neck bones are optional).

Returns true if none of the Transforms have been assigned.

Guesses the hand bones orientations ('Wrist To Palm Axis' and "Palm To Thumb Axis" of the arms) based on the provided references. if onlyIfZero is true, will only guess an orientation axis if it is float3.zero.

Set default values for the animation curves if they have no keys.

Adds position offset to a body part. Position offsets add to the targets in VRIK.

Adds rotation offset to a body part. Rotation offsets add to the targets in VRIK

Call this in each Update if your avatar is standing on a moving platform

Resets all tweens, blendings and lerps. Call this after you have teleported the character.

If true, will keep the toes planted even if head target is out of reach.

Gets the root bone.

The spine solver.

The left arm solver.

The right arm solver.

The left leg solver.

The right leg solver.

The procedural locomotion solver.

4-segmented analytic arm chain.

The hand target.

The elbow will be bent towards this Transform if 'Bend Goal Weight' > 0.

Positional weight of the hand target.

Rotational weight of the hand target.

Different techniques for shoulder bone rotation.

The weight of shoulder rotation

If greater than 0, will bend the elbow towards the 'Bend Goal' Transform.

Angular offset of the elbow bending direction.

Local axis of the hand bone that points from the wrist towards the palm. Used for defining hand bone orientation.

Local axis of the hand bone that points from the palm towards the thumb. Used for defining hand bone orientation.

Use this to make the arm shorter/longer.

Evaluates stretching of the arm by target distance relative to arm length. Value at time 1 represents stretching amount at the point where distance to the target is equal to arm length. Value at time 2 represents stretching amount at the point where distance to the target is double the arm length. Value represents the amount of stretching. Linear stretching would be achieved with a linear curve going up by 45 degrees. Increase the range of stretching by moving the last key up and right at the same amount. Smoothing in the curve can help reduce elbow snapping (start stretching the arm slightly before target distance reaches arm length).

Target position of the hand. Will be overriden if target is assigned.

Target rotation of the hand. Will be overwritten if target is assigned.

The bending position of the limb. Will be used if bendGoalWeight is greater than 0. Will be overwritten if bendGoal is assigned.

The wight of the relaxing the twist of the forearm and hand

If 0.5, this Transform will be twisted half way from parent to child. If 1, the twist angle will be locked to the child and will rotate with along with it.

Position offset of the hand. Will be applied on top of hand target position and reset to float3.zero after each update.

A base class for limbs of all types.

4-segmented analytic leg chain.

The toe/foot target.

The knee will be bent towards this Transform if 'Bend Goal Weight' > 0.

Positional weight of the toe/foot target.

Rotational weight of the toe/foot target.

If greater than 0, will bend the knee towards the 'Bend Goal' Transform.

Angular offset of the knee bending direction.

Directional vector in calf's coordinate space along which to bend the knee

Target position of the toe/foot. Will be overwritten if target is assigned.

Target rotation of the toe/foot. Will be overwritten if target is assigned.

Position offset of the toe/foot. Will be applied on top of target position and reset to float3.zero after each update.

Position offset of the heel. Will be reset to float3.zero after each update.

Rotation offset of the toe/foot. Will be reset to floatQ.identity after each update.

The length of the leg (calculated in last read).

Used for blending in/out of procedural locomotion.

Tries to maintain this distance between the legs.

Makes a step only if step target position is at least this far from the current footstep or the foot does not reach the current footstep anymore or footstep angle is past the 'Angle Threshold'.

Makes a step only if step target position is at least 'Step Threshold' far from the current footstep or the foot does not reach the current footstep anymore or footstep angle is past this value.

Multiplies angle of the center of mass - center of pressure vector. Larger value makes the character step sooner if losing balance.

Maximum magnitude of head/hand target velocity used in prediction.

The amount of head/hand target velocity prediction.

How much can a leg be extended before it is forced to step to another position? 1 means fully stretched.

The speed of lerping the root of the character towards the horizontal mid-point of the footsteps.

The speed of steps

The height of the foot by normalized step progress (0 - 1).

The height offset of the heel by normalized step progress (0 - 1).

Rotates the foot while the leg is not stepping to relax the twist rotation of the leg if ideal rotation is past this angle.

The speed of rotating the foot while the leg is not stepping to relax the twist rotation of the leg.

Interpolation mode of the step.

Offset for the approximated center of mass.

Called when the left foot has finished a step.

Called when the right foot has finished a step

Gets the approximated center of mass.

Spine solver for IKSolverVR.

The head target.

The pelvis target, useful with seated rigs.

Positional weight of the head target.

Rotational weight of the head target.

Positional weight of the pelvis target.

Rotational weight of the pelvis target.

If chestGoalWeight is greater than 0, the chest will be turned towards this Transform.

Rotational weight of the chest target.

Minimum height of the head from the root of the character.

Determines how much the body will follow the position of the head.

Determines how much the body will follow the rotation of the head.

Determines how much the chest will rotate to the rotation of the head.

The amount of rotation applied to the chest based on hand positions.

Clamps chest rotation.

Clamps head rotation.

Moves the body horizontally along -character.forward axis by that value when the player is crouching.

How much will the pelvis maintain it's animated position?

Will automatically rotate the root of the character if the head target has turned past this angle.

Target position of the head. Will be overwritten if target is assigned.

Target rotation of the head. Will be overwritten if target is assigned.

Target position of the pelvis. Will be overwritten if target is assigned.

Target rotation of the pelvis. Will be overwritten if target is assigned.

The goal position for the chest. If chestGoalWeight > 0, the chest will be turned towards this position.

Position offset of the pelvis. Will be applied on top of pelvis target position and reset to float3.zero after each update.

Position offset of the chest. Will be reset to float3.zero after each update.

Position offset of the head. Will be applied on top of head target position and reset to float3.zero after each update.

Rotation offset of the pelvis. Will be reset to floatQ.identity after each update.

Rotation offset of the chest. Will be reset to floatQ.identity after each update.

Rotation offset of the head. Will be applied on top of head target rotation and reset to floatQ.identity after each update.

Solve the bone chain virtually using both solverPositions and SolverRotations. This will work the same as IKSolverTrigonometric.Solve.

Interpolation mode.

Class for various interpolation methods.

Interpolate the specified t by InterpolationMode mode.

T. InterpolationMode.

Interpolate between two verctors by InterpolationMode mode

Linear interpolation of value towards target.

Helper methods for dealing with floatQs.

Clamps the rotation similar to V3Tools.ClampDirection.

Helper methods for dealing with 3-dimensional vectors.

Optimized float3.Lerp

Optimized float3.Slerp

Returns vector projection on axis multiplied by weight.

Returns vector projected to a plane and multiplied by weight.

Clamps the direction to clampWeight from normalDirection, clampSmoothing is the number of sine smoothing iterations applied on the result.

Get the intersection point of line and plane

Projects a point to a plane.

Used to prevent users from saving an item to their inventory, from their context menu or inventory window.

This is not designed as a security feature. Inspectors/Tools can easily bypass it, it is recommended for game mechanics/items where users are not necessarily builders and you want to block the non-builder saving options.

Represents a generic "Block" for a specific action

Forms the root of an inheritance tree of action blocks. Which is handy for code searching, automation and potential future features.

The maximum flying speed in world units per second. Relative to the current user scale.

When using fly speed modulation with trigger (or other 1D analog input) this is the minimal flying speed ratio (relative to the MaxSpeed) when the modulation is zero

Represents the type of hit that the teleport locomotion sees after searching

Not a valid hit, but allows the teleporter to continue searching.

A small hit, teleport locomotion prefers

A big hit, usually represents a very valid and safe teleport destination.

An audio player UI, that provides interface for common audio playback actions. It holds a reference to an audio clip, shows a waveform, play/stop/pause/loop controls, seeking control, volume adjustment, and spatialization option.

Reference to the audio clip that this player will play and control.

Raw data for a dynamic character controller instance.

Direction the character is looking in world space. Defines the forward direction for movement.

Target horizontal velocity. X component refers to desired velocity along the strafing direction (perpendicular to the view direction projected down to the surface), Y component refers to the desired velocity along the forward direction (aligned with the view direction projected down to the surface).

If true, the character will try to jump on the next time step. Will be reset to false after being processed.

If true, any existing support contact will be cleared

Handle of the body associated with the character.

Character's up direction in the local space of the character's body.

Velocity at which the character pushes off the support during a jump.

Maximum force the character can apply tangent to the supporting surface to move.

Maximum force the character can apply to glue itself to the supporting surface.

Cosine of the maximum slope angle that the character can treat as a support.

Cosine of the maximum slope angle that the character has traction on.

Depth threshold beyond which a contact is considered a support if it the normal allows it.

Depth threshold beyond which a contact is considered a support if the previous frame had support, even if it isn't deep enough to meet the MinimumSupportDepth.

Whether the character is currently supported.

Whether the character has traction

Collidable supporting the character, if any. Only valid if Supported is true.

Handle of the character's motion constraint, if any. Only valid if Supported is true.

The last collidable used for jump, which can be used to reject generating traction with the same body

Render contact debug visuals

System that manages all the characters in a simulation. Responsible for updating movement constraints based on character goals and contact states.

Preallocates space for support data collected during the narrow phase. Should be called before the narrow phase executes.

Updates all character support states and motion constraints based on the current character goals and all the contacts collected since the last call to AnalyzeContacts. Attach to a simulation callback where the most recent contact is available and before the solver executes.

Returns pool-allocated resources.

Description of a character motion constraint where the support is static.

Maximum force that the horizontal motion constraint can apply to reach the current velocity goal.

Maximum force that the vertical motion constraint can apply to fight separation.

Target horizontal velocity in terms of the basis X and -Z axes.

Depth of the supporting contact. The vertical motion constraint permits separating velocity if, after a frame, the objects will still be touching.

Stores the quaternion-packed orthonormal basis for the motion constraint. When expanded into a matrix, X and Z will represent the Right and Backward directions respectively. Y will represent Up. In other words, a target tangential velocity of (4, 2) will result in a goal velocity of 4 along the (1, 0, 0) * Basis direction and a goal velocity of 2 along the (0, 0, -1) * Basis direction. All motion moving along the (0, 1, 0) * Basis axis will be fought against by the vertical motion constraint.

World space offset from the character's center to apply impulses at.

Gets the constraint type id that this description is associated with.

Gets the TypeProcessor type that is associated with this description.

AOSOA formatted bundle of prestep data for multiple static-supported character motion constraints.

Simulation-wide unique id for the character motion constraint. Every type has needs a unique compile time id; this is a little bit annoying to guarantee given that there is no central registry of all types that can exist (custom ones, like this one, can always be created), but having it be constant helps simplify and optimize its internal usage.

Description of a character motion constraint where the support is dynamic.

Maximum force that the horizontal motion constraint can apply to reach the current velocity goal.

Maximum force that the vertical motion constraint can apply to fight separation.

Target horizontal velocity in terms of the basis X and -Z axes.

Depth of the supporting contact. The vertical motion constraint permits separating velocity if, after a frame, the objects will still be touching.

World space offset from the character's center to apply impulses at.

World space offset from the support's center to apply impulses at.

Gets the constraint type id that this description is associated with.

Gets the TypeProcessor type that is associated with this description.

AOSOA formatted bundle of prestep data for multiple dynamic-supported character motion constraints.

Used to create Cursors that are appropriate for the engine based on a user's settings.

Does not determine how/where/why icons for cursors are sourced, you can find a default implementation here: .

Used in , as this type of Cursor is used on the dash which has a different UI Scale

Returns an appropriate multiplier for an interaction type.

Is this interaction active? Examples of active are: Button Held, Grabbing etc. Inactive would be "hover"

Returns a suitable cursor for any miscelaneous interactions

Returns a suitable cursor for use with Grab based interactions

Returns a suitable cursor for use with interactions such as buttons.

Returns a suitable cursor for use in Screen Mode Overlay UIs such as the Dash.

See for more on the differences.

Returns a suitable cursor for use with Slider based interactions

Returns a suitable cursor for use with Text editing/interactions

Is the direct cursor enabled?

The default cursor base size, without any modifications

Determines the size of quads that have the cursor image drawn to them.

Be careful changing this as it will mess with everyone's cursor settings

In case the category links deeper than one subcategory, this can be

A string key that uniquely identifies this item and forms a part of the path. This is never shown to the user and is only for internal use

This is the path that the item is located at. It will be empty/null for root items. For all others, each element of the list represents ItemKey of the category that it's in.

Indicates if this item is at the root of the data feed

This indicates which group does this item belong to based on the grouping key that was requested. Normally when items are generated they will be generated right after the group that they belong to, however with events they can also be added and removed dynamically, so this helps route them into the right group.

This is human readable label of given item that will be displayed to the user.

A human readable optional description of this item, that can be shown to the users. This can be useful for providing additional details about given item in UI, such us when expanding a help option.

This is an optional URL for an icon texture representing the given item which can be displayed to the user by views that support it

Any generated UI item can be potentially dynamically hidden and shown. This allows field that controls the visibility of the generated UI to be setup properly, so it can be shown and hidden when needed without regenerating the whole of UI.

Any generated UI item has potentially an enabled and disabled state. This allows that field to be setup properly, so the UI item can be enabled and disabled based on whatever logic it needs to use

This gets a pre-computed sorting order for this item, which the data feed should use to actually sort the item

Indicates if this item has any subitems

Each item can have a number of subitems, which can be other items or categories. This provides mechanism for grouping items together. When sorting, grouping or filtering, this item and all its subitems will be treated as one unit and will never be split apart

This can be arbitrary entity associated with this item. This can be utilized by views that are made for specific types of items, for additional custom rendering, visuals, interactions and so on.

A new item has been added to the list

Existing item was updated. This item was already provided in previous enumeration and just needs its data to be updated

Item has been removed from the path and should be cleared.

This indicates that the entire path has been invalidated and all items should be regenerated. This should be used sparingly, as it's more expensive, but is useful when tracking items being added or removed is too expensive or too complicated, compared to just regenerating the list fresh

This indicates that the sorting order in the path has been changed. This doesn't require the items to be necessarily regenerated, but they just need to be sorted again. In some cases this will require regeneration for feeds that rely on this, but if all items are already generated and shown, it is fine

In some cases systems expect a return value for this, but the item might be unchanged, meaning that no action should be taken. This value covers those cases.

If set, this will instantiate the parent container first and put this item inside of it. This can be used for compositing UI from multiple modular pieces on the fly.

This indicates where any nested children for this element will go. This can happen in two cases: 1) When a child instantiates this instance using ParentContainer, this indicates where the child should go in the hierarchy 2) When this is used as a group container for other elements

When this item is spawned, it can spawn a number of nested items as well. This is a complementary mechanism to allow building generic UI using composition.

Creates an Item within the filter preset, which includes a HiddenSearchTerm.

Builder for the current set of filters in the facet. Name of the preset, also used as a Locale Key. Icon for the preset, displayed to the left of the name in game. Hidden search term for this button List of preset roots to apply when this option is pressed. A created preset button

Creates a preset button in the World Filter Facet.

Builder for the current set of filters in the facet. Name of the preset, also used as a Locale Key. Icon for the preset, displayed to the left of the name in game. List of preset roots to apply when this option is pressed.

This is used in case the facet itself needs to be replaced during placement. This can happen with the template facets. It's a bit dirty way of going about it, but we're in a bit of a time crunch right now and it should work. We should probably revisit this a bit later and how template facets are handled, the system overall needs more work and perhaps use a prefab system instead of this mechanism, which loads the whole facet.

Alpha adjustment applied to the direct cursor's colors.

The direct cursor must be a minimum of this value's distance away from the primary cursor before it will be visible.

This prevents some ghosting issues that occur when these two are within close proximity.

A reference to the root slot of the regular Cursor.

A reference to the Regular Cursor's Image Slot

A reference to the root slot of the Direct Cursor

The direct cursor is a second copy of the cursor, which is displayed at the "true" location of the cursor. The regular cursor can be affected by a user's laser smoothing settings.

A reference to the Direct Cursor's Image Slot

Determines whether the component is currently the active source of ambient light in the world

A read-only bool which shows if this instance of the component is the currently active one

Provides explicit bounds data in the hierarchy

Determines if the bounding box is currently available for encapsulating

Boudning box in local coordinates that will be provided to bounds queries

Provides additonal font style for text renderer

Renders a light source in the world

The type of the light source to render

Intensity of the light source

Color of the light source

Type of the shadow the light source casts

Intensity of the cast shadow from this light source

The near clip plane for the shadow's camera itself.

Override for the shadow map's resolution. 0 is automatic.

Bias for shadows. Offsets the shadow map's depth buffer.

Bias for shadows. Offsets the shadow map's depth buffer using the receiving surface's angle.

Used by point and spot light sources, determines the maximum distance the light reaches

Anglular size in degrees of a spot light type

Texture whose alpha channel is used to modulate the intensity of the light

Renders a mesh with given set of materials in the world.

Reference to the mesh asset to be rendered

List of references to the materials to be rendered

ShadowCasting mode for rendering the mesh.

s Shortcut for the first material in the list of materials.

Contains metadata of rigged 3D model composed of one or more SkinnedMeshRenderers

List of references to slots representing the bones

Renders a skinned mesh in the world, deformed by a set of bones.

List of references to slots in the world representing the mesh bones

List of weights of the blend shapes contained in the skinned mesh

Finds the index of a blend shape with given name in the currently associated mesh asset.

Returns a name of a blend shape with given index in the currently associated mesh asset

Returns whether a blendshape exists in the currently associated mesh asset

The blendshape name to check True if the blendshape exists, otherwise false

Tries to get a blendshape from the currently associated mesh asset

The blendshape name to search for The IField of the blendshape, otherwise null

Returns the number of blend shapes in the currently associated mesh asset

Returns the current blend shape weight for the currently associated mesh asset

Sets the blend shape weight for the currently associated mesh asset

Renders a skybox in the world using a material asset

Reference to the material asset to be used for skybox rendering

A read-only bool which shows if this instance of the component is the currently active one

Determines whether the component is currently rendering skybox in the world

Corrects ambiguous matches within chains(such as legs and arms) by examining the parent bone's type.

A child that you're trying to fix The immediate parent of that child node A fixed BodyNode if a match could be found Given a child LeftUpperArm, whose parent is also LeftUpperArm, we know that the child should actually be LeftLowerArm


            BodyNode child = BodyNode.LeftUpperArm;
            BodyNode parent = BodyNode.LeftUpperArm;
            BodyNode fixed = BipedRig.FixChain(child, parent); // Will be LeftLowerArm

Gets position and rotation data for a single finger.

Finger node to get the data for. Finger position relative to its root space. Finger rotation relative to its root space.

Gets finger positions for specified body nodes. The order corresponds to the provided order.

Finger nodes for which to get the finger data. List to be filled with finger positions. Pass null if not interested. List to be filled with finger rotations. Pass null if not interested.

Gets all finger positions and rotations for given hand. The order of the coordinates corresponds to the order of the finger nodes in the BodyNode enumeration

Which side to get the finger data for List to be filled with finger positions. Pass null if not interested. List to be filled with finger rotations. Pass null if not interested.

Uses physics in the world, to source colors or materials for the brush.

Updates the color from .

is usually updated from the Color Picker,Components and ProtoFlux.

Used to tag a slot with a material policy, when the CanApply property is set to false. It will prevent material applications.

Used to determine if a material can be applied. true will allow a material to apply and false will not.

True if the tip contains an orb.

Parents the orb inside the tool into the user's local space.

Provides a framework around the base tooltip interactions for tooltips which carry out some "action" on the world as a builder.

Controls if the tip will apply, edit grabbables on the object root slot OR on the directly hit slot.

Given a raycase hit from a tooltip, decide if the action should be applied to the objectroot or the collider that's hit.

The from the ToolTip.

GrabbleSetterTip modifies a hit object by adding/enabling/disabling the grabbable component on the hit object.

Controls if this tip will set the Grabbable to true or false.

Modifies the grabbable state of the hit object.

True if the hit grabable should be enabled

Returns true if the grabber is holding ANY item that has a

The type of action to check, must inherit from True, if disabled copies of should be excluded true if the action block was found, false otherwise.

Checks if a Grabbed Item has a

Root Slot of the item

Checks if a tool can be equipped by this InteractionHandler.

See Remarks on

Checks if an InteractionHandler can continue to have a tool equipped.

The difference from CanEquip is that here we don't care about if the tool is already equipped. It is used in permission related systems which check if a user can continue having this tool equipped. A good example is in where we de-equip the tool if it cannot continue to be equipped.

Specifies the FormatNumber for the the resultant meter's DistanceMeter Component.

This is designed to allow for more fine grain control over the resultant Label on the meter tip. By default the meter tip provides a huge amount of decimal places which is usually not needed. This let's a user create and edit MeterTips for specific situations.

Specifies the FormatUnit for the the resultant meter's DistanceMeter Component.

Drives an to the inverse(NOT) of a given field.

Field to drive. Boolean field to base this setup on. An optional location to place the on. The created

Convinient shortcut to setup a field to have its value driven by a and a given .

Type of field to drive Field to drive with this setup. A boolean field to base this setup on. A value to be used when 's value is true. A value to be used when 's value is false. An optional, location to place the BooleanValueDriver on. The created

Shortcut to setup a Localized string field, to be driven by a and a given .

Field to drive with this setup. A boolean field to base this setup on. Locale key to be used when is True Locale key to be used when is False The created

How much time it takes to consume this stage

Overrides the global reference point for this stage when not null

Keeps the consume progress when consumation is paused

When true, this stage requires the consumation to be reset before starting this stage

Indicates if it's being actively consumed

Indicates if this stage has been consumed

Indicates if this is currently the active stage

User which has consumed this Stage

The current consume progress of this stage from 0...1

Drives a field to be active when this stage is active. This is useful for activating visuals

Trigger actions when this stage has been consumed

Must be held to consume

When true, other users will consume this when held

Reference point for determining if this item is close enough to mouth. When null, uses the Slot it's one

Radius of the item where it will be consumed

Ratio of the radius at which the consumation will start

Index of the active stage

Indicates if it's currently being actively consumed

Indicates if this has been fully consumed

User who is currently consuming this consumable

Should this be destroyed on consumed?

Trigger actions when stage has been consumed

Trigger actions when fully consumed

All the consumable stages. Needs at least 1 stage to work

Indicates at which component should be recursive searched stopped (for example when grabbing, touching) This is exclusive, meaning components on the slot with SearchBlock will still be returned

Finds all components of type T in parents (including current slot), stopping after SearchBlock component is encountered.

The type of the component to find The slot to begin the search on A list to which to add found components Optional predicate to filter the found components

Finds all components of type T in parents (including current slot), stopping after SearchBlock component is encountered.

The type of the component to find The slot to begin the search on Optional predicate to filter the found components List of all found components

Finds the first component of type T in parents, searching until SearchBlock component is encountered

The type of the component to find The slot to start the search on Optional predicate to filter the found components. First found component or null if no component is found

When added to a Slot, blocks teleportation attempts that hit this slot's colliders

Marks a slot allowing teleport locomotion to search for destinations that are "through" this slot's colliders

Marks a Slot's colliders as being a good candidate for a teleport destination.

This component fill forward avatar object component (d)equip events to another part of the slot hierarchy. This is useful for cases where the object components are placed outside the child hierachy of the object slot.

The root of the target hierarchy for which to invoke the events.

A reason, displayed to the user when the Hyperlink warning dialog is shown.

Attaches a Hyperlink with a URL to a wiki page for a specific component/ProtoFlux node/etc

Slot to attach the Hyperlink to Type of the component/ProtoFlux node to link to Attached Hyperlink component instance

Marks a type as having a prefix for its wiki pages

Not guarenteed to be called. Use to run actions that must be guarenteed to run.

Slot is an empty hiearchy element that forms the base data tree of the World scene. It has a few basic properties, such as transform and name, but majority of functionality is provided by attaching various components on the slot.

Indicates whether this slot is the root slot of the World, under which all other slots are parented.

The name of the slot

Optional tag of the slot, which allows finding or classifying slots in the scene by a string

Reference to the parent slot. Assigning a new parent automatically preserves world transform

Raw reference to the parent slot. This one will return the previous parent slot if it has been already removed from the hierarchy. It's not guaranteed to be consistent across the clients.

Indicates the hiearchy depth of the slot relative to the root slot of the world

Computes hierchy depth relative to another slot. This indicates a number of slots required to travel upwards in the hiearrchy to reach the target slot.

The slot relative to which the depth is computed Hierarchy depth relative to the root slot, -1 if the root isn't a parent of this slot

Sets a new parent to the slot, while optionally not preserving the global transform

Reference to the new parent slot Whether to preserve the global transform (position, rotation and scale) of the slot

Determines whether the Slot itself is active or not, regardless of the parent hierarchy's active state. Inactive slots deactivate their whole children hierarchy. See to query if the slot has been made active or inactive by it's parent hierarchy.

Field that holds the local position of the slot

Field that holds the local rotation of the slot

Field that holds the local scale of the slot

Ordered index of the slot among all children of its parent. This order is ensured to stay consistent among clients. Assigning a new value will swap it with the child that's currently at given index.

Inserts this slot at specific index in the list of children of the parent slot, shifting other children around.

Index at which this slot should be inserted

Creates a new slot in the scene as a child of this one.

The name of the newly created slot

Creates a new slot in the scene as a child of this one and inserts it at specific index among the other children.

The index of the new child The name of the newly created slot

Destroys the Slot, removing it from the world, while parenting all its children under a different slot.

The slot under which all current children will be parented

Destroys the Slot and its entire children hierarchy, removing them from the scene.

Destroys the entire children hiearchy of this slot, but keeps the slot itself.

Destroys the slot, but preserves all AssetProviders in its hiearchy that are referenced outside of the destroyed hierachy. This technically preserves all slots with asset provider components, but destroys all other components on them.

Optional slot under which to relocate all the assets. If null, it'll be automatically created.

Indicates whether this slot is Active within the hierachy. Slot can be inactive in hierarchy if one of its parent slots are not active, even if it's active itself.

Indicates if the slot is persistent in the hiearchy. If any of the parent slots are non-persistent, then all children are non persistent as well. Non-persistent elements of the hiearchy do not get saved with the world.

Indicates if the slot itself is set to be persistent. Setting it to non-persistent will make the whole children hierarchy non-persistent, whic h means that they do not get saved with the world.

Serializes a part of the scene hiearchy starting at this slot into a DataTreeNode hiearchy.

Helper object used to control the serialization process.

Deserializes part of previously saved scene hieararchy under the hierarchy of this slot.

The root DataTreeNode from which to deserialize the scene hiearchy Helper object used to control the deserializaiton process

Returns a first component in the children hierarchy (including this slot) that satisfies given condition.

The type of the component to find. Optional function used to filter the components First found component or null if none found

Returns a list of all components in the children hierarchy (including this slot) that satisfy given condion.

The type of the components to find Optional function used to filter the components. A list of all found components

Adds all components in the children hiearchy (including this slot) that satisfy given condition to the provided list.

The type of components to find List to which the found components will be added Optional function used to filter the components.

Calls the provided function for each component of given type in the children hiearchy (including self)

The type of the components to find The function which to call for each component.

Calls the provided function for each component of given type in the children hierarchy (including self). If the function returns false, the walking of the hierachy is stopped.

The type of the components to find The functio nwhich to call for each component. True if the function returned true for all found components, otherwise false

Calls the provided function for each component of given type in the parent hierarchy (including self)

The type of the components to find Function to call for each component

Calls the provided function for each component of given type in the parent hierarchy (including self) If the function returns false it'll stop.

The type of the components to find The function to call for each component True if the function returned true for all components, false if it was stopped

Finds the first component in the parent hierarchy (including self) which matches the given criteria

The type of the component to find Optional predicate to filter the components The first found component or null if none matches the criteria

Fills the list with components in the parent hierarchy (including self) which match the given criteria

The type of the component to find The list to fill with the found components Optional predicate to filter the components

Finds all components in the parent hierarchy (including self) which match the given criteria

The type of the component to find Optional predicate to filter the components List of all found components that match the criteria

Current number of children slots

A collection of all the current children slots

Returns a child slot at specific index from all the current children slots. The order of children is ensured to stay consistent between clients in presence of no changes.

The index of the child slot to return The child slot at given index

Returns the child index of a specific slot.

The slot for which to determine the index Child index of the slot or -1 if it's not a child of given slot

Indicates if this slot is within the hierarchy of another

The root of the children hierarchy to check Whether to return true if the slot is the same one as this is called on True is the slot is within the hierarchy, false otherwise

Copies all components from another slot onto this one

Finds the first direct child with given name

The name to find First found slot with given name or null if none matches

Finds the first child slot in the hierarchy with given name

The name to find First found slot with given name or null if none matches

Finds a direct child slot with given name or adds a new one with that name if none found

The name to find First found slot with that name or the newly added one if none was found

Returns a list with all the direct and indirect children in the slot's hiearchy

Whether to include the slot this is called on in the list List of all the children

Sets the Tag of the Slot and all of its chlidren recursively

The tag to set

Gets list of all slots (including this one) with a specific tag

The tag to check for The list of all children with the given tag

Fills the list with all children with given tag

The tag to check for The list which to fill with the found slots

Sets the local transform to identity with its parent.

Transforms this slot using other slot, as if it was its child. Only this slot is assigned, the other slot's transform is unchanged

The slot to transform by The new virtual global position of the other slot The new virtual global rotation of the other slot Thew virtual global scale of the other slot

Indicates if the slot has identify transform relative to its parent

Copies to global position, rotation and scale of the other slot

Local position of the slot in the coordinate system of its parent

The local rotation of the slot in the coordinate system of its parent

The local scale of the slot in the coordinate system of its parent

The global position of the slot in the scene coordinate space

The global rotation of the slot in the scene coorindate space

The global scale of the slot in the scene coordinate space

Transformation matrix that transforms from the scene coordinate space into the coordinate space of the slot

The transformation matrix of the slot. It transforms from its local coordinate space into the parent's

Computes a transformation matrix from the slot's local coordinate space to another slots' local coordinate space.

The slot that the matrix should transform into Transformation matrix

Transformation matrix which transforms from the slot's coordinate space into the scene coordinate space

Quaternion representing a rotation from the slot's local coordinate space to the global. This doesn't include negative scaling transformation.

Quaternions representing a rotation from global coordinate space into slot's local. This doesn't include negative scaling transformation.

Unit vector indicating the slot's forward direction in the global coodinate space.

Unit vector indicating the slot's upwards direction in the global coodinate space.

Unit vector indicating the slot's backward direction in the global coodinate space.

Unit vector indicating the slot's downwards direction in the global coodinate space.

Unit vector indicating the slot's left direction in the global coodinate space.

Unit vector indicating the slot's right direction in the global coodinate space.

Transforms a positional coordinate from slot's local space to global

Point in the slot's local coordinate system Point the global coordinate system

Transforms a positional coordinate from global space to slot's local

Point in the global coordinate system Point in the slot's local coordinate system

Transforms a direction of a vector from the slot's local coordinate space to the global. This rotates and inverts the vector, but preserves its length (unit input vector will output unit output vector, regardless of scaling)

Directional vector in the slot's local coodinate space Directional vector in the global coordinate space

Transforms a direction of a vector from the global coordinate space to the slot's local. This rotates and inverts the vector, but preserves its length (unit input vector will output unit output vector, regardless of scaling)

Directional vector in the global coordinate space Directional vector in the slot's local coordinate space

Transforms a vector from the global coordinate space to the slot's local. This rotates and scales the vector, but the position of the slots doesn't affect it.

Vector in the global coordinate space Vector in the slot's local coordinate space

Transforms a vector from the slot's local coordinate space to global. This rotates and scales the vector, but the position of the slots doesn't affect it.

Vector in the local coordinate space Vector in the global coordinate space

Loads an object from a record URI in-place, consuming the slot it is called from.

URI of the object to be loaded. Root slot for the asset of the object. Preserves the root transform of the object. Rewrites the data tree to avoid creating a parent Holder slot. Excludes certain types from loading, using a predicate set to false. This is an out of data model event and shouldn't be used for anything data model related

Copies values from a Worker of the same type

Copies values from a Worker of a different type, matching them by name.

This type of reference can be used when an explicit change event needs to be invoked when the target is destroyed (assuming it supports this event

RelayRef should be used if you want to be informed when the target field changes and have changes of the target invoke OnChanges() on the component that's referencing it.

Determines whether the engine should assume to use a Wine-based renderer when
executed in a Linux environment.

Beware! This may be removed when dispatch of the renderer process is improved!

The Universe ID for this Engine.

If you're using this to check if the Engine is in a Universe,
then is recommended as it makes Universe
checks easier to read.

The full Universe details for this copy of the Engine.

True, if this Engine is in a Universe.

Login user and create new UserSession for authenticating further requests. To authenticate self, either password, session token or recover code should be provided. If you're creating a headless or standalone app with FrooxEngine, this is probably where you want to be.

The credential to login. This will be a username. The authentication method used. Whether the attempt to login succeeded.

List of all found workers in the FrooxEngine

Delegate signature for handling audio samples.

A buffer of audio samples provided by the callback.

The input semantics of the audio driver (e.g. whether the input device is from an actual capture device, is an output, or is a loopback device)

Base class for declaring audio inputs.

The name of the audio device this driver controls.

The ID of the device this driver controls.

The InputInterface this audio input belongs to.

The engine this audio input belongs to.

The audio system which controls this audio input.

Whether this audio input is active.

The semantics of how this driver's input device operates (e.g. if it's an actual input device, loopback, etc.)

Whether this driver's device is the system's default audio input device.

Whether this driver's device is connected.

The sampling rate that this driver's device inputs at.

Invoked whenever this driver's active status changes.

Invoked whenever this driver's connected status changes.

Invoked whenever there are new raw audio samples available for consumption.

Invoked whenever there are new filtered audio samples available for consumption.

Invokes with False when called.

Invokes with True when called.

Updates this driver to be marked as the system default.

Indicator of whether this is the system default. True if the default was successfully updated, otherwise False.

Updates the active state of this driver.

Creates a new audio input driver.

Friendly name of this driver's audio device. ID of this driver's audio device. The input interface this driver belongs to. The semantics of how this driver handles audio input. The audio system this driver belongs to.

Sets the sample rate of this input.

The target sample rate.

Writes samples from the input buffer to the internal audio system.

The buffer to ingest samples from. The last position of the last sample read. The last sample read.

Processes incoming samples for consumption by the engine.

Base class for declaring audio outputs.

Time span (in seconds) over which and are calculated.

The audio system this output driver belongs to.

The name of the audio device this driver controls.

The ID of the device this driver controls.

Whether this driver's device is connected.

Whether this driver's device is the system's default audio output device.

The sampling rate that this driver's device outputs at.

The number of playback samples this driver's device has queued.

The number of buffer underruns this driver's device has encountered.

The average read rate (in samples) over the course of 15 seconds.

The average write rate (in samples) over the course of 15 seconds.

The context in which certain operations are done.

Mostly used for logging purposes.

Delegate which signifies that this output driver may trigger audio renders.

Invoked whenever this driver's connected status changes.

Creates a new audio output driver.

Friendly name of this driver's audio device. ID of this driver's audio device. Whether this is the default output for the system. The audio system this driver belongs to.

Invokes with False when called.

Invokes with True when called.

Updates this driver to be marked as the system default.

Indicator of whether this is the system default. True if the default was successfully updated, otherwise False.

Starts playing audio through this driver's device.

The user-defined context explaining why this device was started. Thrown when the device has already been started.

Stops playing audio through this driver's device.

Submits audio samples to a buffer when the audio render has completed.

Location where submitted samples are stored. The current simulation time of the audio system.

Re-allocates internal structures when the frame size of the simulation changes.

Reads any available samples into a destination buffer.

If there aren't enough samples available, new samples will be rendered on-demand. Destination buffer. The number of samples read.

Called when this driver has been started.

Called when this driver has been stopped.

Multiplies two s together. Their types must be the same.

Type for this operation See for a version of this operation that multiplies by a singular float value as an amplitude.
See for a version of this operation that can multiply by a constant as oposed to an .

Scales an Input, by a singular float value(amplitude)

Source data type See for a version that can multiple two inputs together.

Generates a unique file path if file already exists.

The file name The path where to save the file

Tests to see if a Platform interface should be initialized based on its name and a supplied app config.

true if the provided platform should be initialized

User has denied the request for access.

User has allowed the request for access.

User has ignored the request for access.

You Might be looking for this.

Gets an active settings component by its Type.

The setting component type to retrieve. The setting component or null if it could not be found This method can return null, if this is the first time the setting is accessed. If you want to be sure to get a setting use The setting component type to retrieve. Used via Reflection, See: Used via Reflection, See: Used via Reflection, See: Used via Reflection, See:

Base cursor size used, to calculate all other cursor sizes.

Applied to the cursor size as a multiplier when Grabbing

Applied to the cursor size as a multiplier when interacting with buttons and other Touchables.

Applied to the cursor size as a multiplier when selecting and manipulating text.

Applied to the cursor size as a multiplier when interacting with Sliders

Turns on/off Direct Cursors

18.62x smaller

14.01x smaller

5.14x smaller

2.94x smaller

Uncompressed

Used via Reflection, See: Used via Reflection, See: Used via Reflection, See: Used via Reflection, See:

When importing a Session/World URL, open/join that world/session

When importing a Session/World URL, spawn a Session Interface.

This is currently spawned as a World Orb, however we want to move towards using the EntityInterface for these. This name was chosen to avoid having to rename it later.

When importing a Session/World URL, spawn a URL Interface with the value set to the world/session url

Shares NO session details with the rich presence system

Shares only basic information with the rich presence system.

As an example, Basic would send "User is playing Resonite" but not necesarily what session they're in or any other details.

Shares all information available to the rich presence system.

As an example, Full would send "User is playing Resonite, they're in "Cool World" with 8 users". etc.

User's preference for Discord's Rich Presence

User's preference for Steam's Rich Presence

When set to true, Steam will save a copy of any screenshots to Steam's screenshot system.

If true, indicates that the user wishes to strip file meta-data tags from images on import/export.

While refers to in-app MetaData, this setting refers to things like EXIF tags.

This indicates the general compatibility version between the system types. This can be used to manually break compatibility between builds when changes are made that do not add or remove any data types, but that in some other way make the two versions incompatible. An example of this might be when algorithms responsible for realtime encoding of the types are changed, so even with the same set of types, the two clients wouldn't compatible at the binary level. These changes should be rare so this shouldn't update very often. Adding, removing or reordering types doesn't require this value to be changed, because that will change the compatibility hash implicitly.

A TimeSpan value which represents their Local TimeSpan offset from the UTC Timezone. This can be used to figure out the timezone and local time of this user.

A generic we use to wrap legacy radiant screens, mostly for the dash. If you want to change the background color of our legacy screens, look here.

Can this item be saved by any means?

Waits for a user's registration to complete, displaying any errors encountered

Whether the registration was completed successfully

A Cloud Interface, which can connect to another Third-Party Cloud for migration details etc.

The previous message history state, stored when the contacts checkbox is toggled.

Sets all optional migration data settings for the migration to the specified state.

State to set

How long after, the world is loaded should the indicator be destroyed.

Encapsulates a request to load home, with an error if it occured.

Retrieves a Universe's home template, based on the currently active Universe

The type of Home to get the template for A URI, for the appropriate home template. For non-universe templates see

Retrieves a Regular Home Template for this platform.

The type of Home to get the template for A URI, for the appropriate home template. For universe templates see . Also see for usage of this. />

Given a Record, try to figure out if the record is a world orb. If it is return the URI from "inside" the world orb.

Input record A valid Record URL if successful true for success, false otherwise World Orb records, usually get two tags 'world_orb' and 'world_uri:resrec//etc' see for more info.

Checks if any of the URIs in this are valid for a given platform

Platform to use when checking if there are valid URIs. otherwise.

Checks if this worldstartsettings can "start" a world.

Platform the world should run on. if this can be used to start a world. otherwise. This is a quick check, that doesn't rely on anything external to the WorldStartSettings except for the platform.

This is where we generate the paths for a given folder.

Checks to see if the be spawned. Will check various permissions etc.

true if the avatar creator can be spawned, false if it cannot.

Owner of the World/Session.

Analgous to "Host".

Runs an action in sync with the world update from the update thread, when changes to the data model are allowed by the running code. This allows you to schedule modifications to the world from background threads and other worlds. The action is ran as soon as possible, usually between the world's own update stages. This action is not guaranteed to run if the world is destroyed.

The action to run synchronously If true, will run the action immediatelly if called from the world update thread, rather than scheduling it in a queue.

Delegate triggered on OWOConnectionHandler started

Delegate triggered on connection open

Delegate triggered on connection closed

Delegate triggered when game send a sensation to OWO app

Delegate triggered on log messages

Connect to OWO app. Note: for this client to work, you need to provide the IP of a device running OWO app

Request to OWO app a sensation to be runned

Id of the sensation to run Muscle to focus

Close conection, to finally close the conection a second is waited