DOCSEARCHbyAlgolia
Submit Docs

Circuits Documentation

website·Indexed 30 days ago

https://circuits.pages.dev/

A comprehensive reference for Circuits chips, featuring a library of functional blocks for tasks such as vector mathematics (dot and cross products, magnitude clamping), Trigger Volume management, player state detection (prone status, interaction labels), and UI element control like Toggle Buttons and welcome mats.

Tokens
91.8K
Snippets
659
Records
1.2K
Agent score
74%

What's inside Circuits

  2. Set position and rotation of a player or object using chip 5898c7f7-cb5d-4344-a194-bd09260b12dd

    This chip sets the position and rotation of a target player or Rec Room object. Note that players will only rotate about the vertical axis.

    Constraints and Failure Cases: The operation will fail if:

    • The target object is currently being held.
    • The target object is selected or frozen by the maker pen.
    • The target object is a child of a gizmo.
    • The target player is currently seated.

    Deprecation Warning: This chip is deprecated and users are encouraged to migrate to a different chip.

    Inputs:

    • exec: Trigger execution
    • Target (player, rec room object): The object to move/rotate
    • Position (vector3): The target coordinates
    • Rotation (vector3, quaternion): The target rotation
    • Spawn Radius (float): Radius for spawning
    • Clear Velocity (bool): Whether to reset the object's velocity
    • Use Rez Effects (bool): Whether to trigger rez visual effects

    Outputs:

    • exec: Success execution path
    • Failed: Execution path if the operation fails

  4. Set position and rotation of a player or object

    Use this chip to set the position and rotation of a target player or Rec Room object. Note that players will only rotate about the vertical axis. The operation will fail if the target object is currently held, selected/frozen by the maker pen, is the child of a gizmo, or if the target player is seated.
    Chip UUID: 950368dc-fbdd-4627-a0e3-157fd2955276

  5. Record and store custom audio samples using the Audio Sample chip

    The Audio Sample chip (UUID: 2cb45825-f385-414f-9a65-2425963fa720) allows users to record and store a custom audio sample. This stored sample can then be used as an input for the Audio Player. The chip provides a single audio output.

  7. Implement HUD elements using the HUD chip

    The HUD chip (UUID: 0681e9de-2f79-4f6a-9d8a-06140507760c) is used to create Heads-Up Display (HUD) elements such as progress bars, wheels, and counters. It can be configured to customize a single element and then enabled or modified using existing HUD chips. Additionally, it can be configured to pull data from Room Progression if the Progression setting is enabled in the room settings. The chip outputs to the room level hud.

  8. Use the Data Table chip to manage tabular data

    The Data Table chip provides a single data table interface. You can edit the table's structure and content via the chip's configuration menu. When setting up the table, you must specify the data type for each column. To retrieve specific values from the table for use within circuit graphs, use the 'Data Table Read Cell' operation. Note that changes to the table must be saved to be committed.

  9. Retrieve objects and players within a 3D box using chip 5df93bc7-4bb7-44c6-b260-d7b2836436c8

    Use this chip to get information (such as position, distance, and direction) about all objects and players located within a specific 3D box. The box is defined by its center point, its extents (size), and its orientation.

    Inputs:

    • exec
    • vector3 (Center)
    • vector3 (Extents)
    • quaternion (Orientation)

    Outputs:

    • exec
    • List<collision data> (Collisions)

  10. Set the rotation of a player or object using chip 0a6f6078-8075-43c7-bbb2-32b63ae48e92

    This chip sets the rotation of a target player or Rec Room object. For players, rotation is applied only about the vertical axis.

    Constraints and Failure Cases: The operation will fail if:

    • The target object is currently being held.
    • The target object is selected or frozen by the Maker Pen.
    • The target object is a child of a gizmo.
    • The target player is currently seated.

    Inputs:

    • exec: Trigger the rotation
    • Target (player, rec room object): The entity to rotate
    • Rotation (vector3, quaternion): The desired rotation value

    Outputs:

    • exec: Continues execution
    • Success (bool): Returns true if the rotation was successfully applied

  12. Check if a player's Share Camera is spawned

    Use the chip with UUID f28a5263-76d9-4bba-97f2-2654ae04ce61 to determine if a specific target player has their Share Camera spawned. This chip returns a boolean value indicating the spawn status.

    Requirement: This chip requires beta content to be enabled in the room. This can be configured via "This Room -> Settings".

    Inputs: player | Player Outputs: bool | Is Spawned