orels1 / udontoolkit

A set of purpose-built Udon Behaviours and tools to make your own

---

Purpose-built Udon Behaviours and tools to make your own

_{Built with ❤︎ by orels1 and contributors}

Quick Start Guide

Requirements

• VRC SDK3 with Udon (v 2021.06.03.14.57+)
• Udon Sharp Compiler (v 0.19.12+)

Installation

• Grab the latest package from releases
• Import it into the project

If you're upgrading from version prior to 1.x.x - you'll need to follow these upgrade steps to upgrade

• When importing you can select what to import:
  • Internal: REQUIRED. Contains all the editor functionality
  • Systems: Various systems listed in the SYSTEMS section of the documentation
  • Behaviours: A collection of scripts that perform actions in the world. You can find the full list in the BEHAVIOURS section of the documentation
  • Demo: assets and examples scenes for all the systems and behaviours. You should import this only if you are importing the full package
• Open your Project Settings -> UdonSharp and in the Default Behaviour Editor select UdonToolkit Editor

Check out the wiki for all the information

If you still have questions - join the discord

Copyright

Copyright (c) 2020 orels1

Licensed under the MIT license.

udontoolkit's Issues

Merge Controller code into the UdonSharpBehaviours

• Merge AreaTrigger
• Merge UniversalTracker
• Merge UniversalAction
• Merge InteractTrigger
• MergeLerpedFollower
• Merge ObjectBoundaryTrigger
• Merge NetworkedTrigger
• Merge PlatformTrigger
• Merge SecretActions
• Merge ShaderFeeder
• Merge SkyboxAdjustment
• Merge FogAdjustment
• Merge UIReadout

Reorderable List causes replacement of values

Steps to reproduce:

1. Create a program like this

public class TestBug : UdonSharpBehaviour
{
    public string testString = "abc";
    public TestBug[] testArray;
}

2. Create 3 GameObjects with this program and assign unique testString values but don't assign anything in the testArray yet
3. Verify all have unique values in testString
4. Add element to testArray on the first object and reference it to the second object
5. Add element to testArray on the second object and reference it to the third object
6. Inspect the first object again
7. The second object is now replaced with the values of the third object

Document new requirements for UT

• Update all screenshots
• Add U# 0.18 to the list of requirements as a minimum

Scene Start Trigger Behaviour

Done for v1.0.0

Remove controller generator 😭

Document the Removal of UTController

Chair Control Behaviour

Split popup source into separate popups to avoid Enums

Add an attribute to request udon behaviour arrays specifically

Add migration docs

• Link them to the Obsolete attributes

Remove the `Interact` trigger from UdonBehaviour Event autofill

Popup crashes when used on a regular array

If you try to add a popup to a regular array - it will crash due to not being suited for that (the Property Drawer gets passed the data SerializedProperty` and it just crashes and burns)

[Popup("Handler")]
public string[] stuff;

Need to handle it in the UTEditor code

• Avoid nested properties in popups
• Handle the popups directly in the RenderArray code same way as the RenderStackedArray does it
• Refactor the popup lookups to a UTUtils function
• Documented the updated logic

Sound Occlusion Behaviour

In terms of probes i think i can do it the simple way allowing maximum one probe per area so you just define like a reflection probe with a sample point and a bounding box, so its just a box trigger collider and not some overly smart and expensive system to figure it out

• Get rid of the Controller and move stuff back
• Add support for probes, can try the Remedy way
• Set up the occlusion triggers that adjust the raycast target to a probe
• Add a handle for the occlusion trigger to place the probe
• Add options to the probes for configuring relevant falloff
• Retarget the system to the probe when present
• Allow to close/open the proxy for doors and stuff

Update:
Somewhat figured out the basics but i'm not really using the proxy positions too much right now, i'm just slapping and arbitrary modifier on top. Which works, but i still wanna try out some kind of lerping to the target position of the proxy, just need to make sure it's a flat timing, and it correlates to the filter/volume adjustments.
Also need to look into compltely yeeting the modifier and doing it a different way - where proxy completely overwrite the min/max and then makes it so the behaviour now scales locally. That can work, but its a bit more fiddly. Need to play around more

• Add basic reverb adjustment, probably need a bit more tweaking

This will be closed off due to Xiexe finalizing his own system that does the same

Adding `[ListView]` to existing arrays of different lengths breaks the editor

Should probably adjust the length to the larger array instead of trusting that they are the same length

Duplicate Section Header names case them to not appear

Having 2 SectionHeader attributes with the same text will cause the second one to not show up, while still adjusting the height

Add inline documentation for Attributes

Currently the documentation on the attributes is only available on the Wiki which isn't great - it would be nice to have it in the code as well

v0.4.1 Release summary

Mostly bugfixes and small improvements to Popup and OnValueChanged attributes.

Added new class-level attributes: OnBeforeEditor, OnAfterEditor and OnValuesChanged

Added new field-level attribute: Disabled

All attributes also have inline documentation for better IDE support now too 🎉

Remove PostProcessing requirement for compiling and add warning

Add explanation of the Attribute stack to the docs

It is not really obvious that the Attributes from UdonToolkit work like a modifier stack and unwrap in reverse. so if something says that the field is hdden - it will hide the Attributes before it in the field attributes list

Refactor colors into a separate singleton

Add basic guides

• Skybox day/night cycle
• Object Boundary Trigger
• Area Trigger
• Secret action
• Door

Document manual copy paste value buttons

Move the detailed installation instructions to the Readme

Add [Disabled] and [DisabledIf] attributes for automatically controlled fields

• Add Disbaled
• Add DisabledIf
• Add Documentation

Update UTEditor to support U# 0.18

• Add basic support
• Make universal once merlin updates it
• Update behaviours

Add Build-Safe versions of attributes

Add a "Show Default Inspector" button for ez debugging

Document Edit mode buttons

Add support for boolean animator parameter to Universal Action

This requires #20 to be done, which is a large refactor

Make events generate buttons automatically

Change the Fog code to interpolate

Add support for PlayMode value adjustment

Using a custom label on a toggle attribute throws an error when doing a VRC build

Add back sync to UTController on first editor render

Improve the `Button` rendering

"Exception of type 'UnityEngine.ExitGUIException' was thrown." error happens whenever you click the circle next to a reference

Doesn't seem to break anything whatsoever, but worth mentioning

Error leads to line 325 of UTEditor.cs

Document the `#if` requirements

• Update Popup docs
• Update OnValueChanged docs
• Replace all the UdonPublic references with UTEditor

Add support for Drag & Drop on Arrays and ListViews

Dragging & Dropping on list views will automatically try to populate the fields with correct values for both arrays.

So if you have an array of GameObject and UdonSharpBehaviour - it will populate both fields with corresponging values of the objects being dragged

• Add a "clear all values" button for quick re-filling of the list

Support 3-4 elements in list view

Implemented in v1.0.0

Helpboxes applied to arrays do not respect the provided methodname

Example code:

    public bool TestBool;

    [UTEditor]
    [HelpBox("This should be hidden if TestBool is false", "@TestBool")]
    public string[] TestArray;

    [UTEditor]
    [HelpBox("This should be hidden if TestBool is false", "@TestBool")]
    public string TestString;

TestString's helpbox gets hidden but TestArray's does not

Migrate old Popups to the new U# friendly Popup attributes

Add "revert to default" button

Document SoundOcclusion

Sound Occlusion got canceled due to there being a better solution close to release, so this is not needed anymore

Move ListView attribute to the Modifier type

Current list view is a Property Drawer, which means it can conflict with other PropertyDrawers and prevent them from initializing

Will be closed off via the v1.0.0 release

Extract the shader Properties as a popup source

Add Source Types to ShaderFeeder

• Text Input (numbers)
• Program variable (for color / float / vector)

Remove the ControlledBehaviour attribute

Update `Button` to call custom event by default

Add [OnBeforeEditor], [OnAfterEditor], [OnValuesChanged] attributes with SerializedObject

Call the methods on the top and bottom of inspector code with SerializedObject

• Document this stuff
• Implement the functionality

Update UTTestController to be UTTestBeahviour