How To Create Plugins/Creating Components: Difference between revisions

Latest revision as of 09:11, 3 April 2025

Creating components is one of the easiest part of making a plugin.

Creating the component file

Add references to
- FrooxEngine
- Elements.Core
Next, assign a namespace to your component. It can be anything but creating a custom one for your plugin is recommended to avoid conflicts. A good example is MyPlugin.Components. Making the namespace follow the category inside of the game is recommended.
Set your category, this is where your component is placed in the browser.
- This is done by adding a [Category("PATH")] before your component class.
- Some examples:
  - [Category("MyPlugin/Transform")]
  - [Category("MyPlugin/Users")]

Creating the component class

Create a new class inside of your namespace
- It should be a public class which inherits the Component class.
- So your code should look like: public class MyComponent : Component
Create your variables
- These go immediately after you start the class and follow a few rules to show up in the in game inspector:
  - It must be public
  - It must be readonly
  - It must be a FrooxEngine generic type^{[Citation needed]} wrapping your original type. Such as Sync<T>.
- If you do not want your variable to show up in game:
  - It should be private
  - It does not need to be readonly
  - It does not need to be a FrooxEngine generic type^{[Citation needed]}.
- Do not assign default values. These should be assigned in OnAttach()^{[Citation needed]}
- Examples:
  - public readonly SyncRef<Slot> MySlotReference;
  - public readonly Sync<bool> MyBoolValue;
  - private bool AnInternalValue;

Adding functionality

FrooxEngine has many events you can hook your functionality into, to do this you need to add a protected override to each of these. Do not return any values. You can see a full list of functions at Custom Components

For this guide, we'll focus on the basics

Function	Description
OnAttach()	Called when the component is attached. If you want any default values, you assign them here.
OnEnabled()	Called when the component is enabled
OnDisabled()	Called when the component is disbaled
OnCommonUpdate()	Called every update, or approximately 60 times per second.
OnDestroying()	Called just before the component is destroyed. Usually used to unlink drives.

@@ Line 4: / Line 4: @@
 #* FrooxEngine
 #* Elements.Core
-# Next, assign a namespace to your component.
+# Next, assign a namespace to your component. It can be anything but creating a custom one for your plugin is recommended to avoid conflicts. A good example is <code><nowiki>MyPlugin.Components</nowiki></code>. Making the namespace follow the category inside of the game is recommended.
-#* If this is your first component, you can make up a namespace! Just ensure it starts with <code>FrooxEngine</code>. If you want to be extra sure that your plugin does not conflict with others, make your namespace <code>FrooxEngine.MyPlugin</code> (where <code>''MyPlugin''</code> is your plugin's custom namespace, of course.)
-#* If you already have a namespace set up, use that!
 # Set your category, this is where your component is placed in the browser.
-#* This is done by adding a <code><nowiki>[Category(new string [] { "PATH" })]</nowiki></code> before your component class.
+#* This is done by adding a <code><nowiki>[Category("PATH")]</nowiki></code> before your component class.
 #* Some examples:
-#** <code><nowiki>[Category(new string [] { "MyPlugin/Transform" })]</nowiki></code>
+#** <code><nowiki>[Category("MyPlugin/Transform")]</nowiki></code>
-#** <code><nowiki>[Category(new string [] { "MyPlugin/Users" })]</nowiki></code>
+#** <code><nowiki>[Category("MyPlugin/Users")]</nowiki></code>
 == Creating the component class ==
 # Create a new class inside of your namespace
@@ Line 18: / Line 16: @@
 # Create your variables
 #* These go immediately after you start the class and follow a few rules to show up in the in game inspector:
-#** They need to be public
+#** It must be public
-#** They need to be readonly
+#** It must be readonly
-#* If you're creating a value, the data must be of type <code><nowiki>Sync<T></nowiki></code> where <code>T</code> is your type.
+#** It must be a [[How_To_Create_Plugins#Variable_types_relevant_for_Components|FrooxEngine generic type]]{{Citation needed}} wrapping your original type. Such as <code>Sync<T></code>.
-#* If you're creating a reference, the data must be of type <code><nowiki>SyncRef<T></nowiki></code> where <code>T</code> is your type.
+#* If you do not want your variable to show up in game:
-#* '''Do not assign default values.''' These should be assigned in <code>OnAttach()</code>
+#** It should be private
+#** It does not need to be <code>readonly</code>
+#** It does not need to be a [[How_To_Create_Plugins#Variable_types_relevant_for_Components|FrooxEngine generic type]]{{Citation needed}}.
+#* '''Do not assign default values.''' These should be assigned in <code>OnAttach()</code>{{Citation needed}}
 #* Examples:
 #** <code><nowiki>public readonly SyncRef<Slot> MySlotReference;</nowiki></code>
 #** <code><nowiki>public readonly Sync<bool> MyBoolValue;</nowiki></code>
+#** <code><nowiki>private bool AnInternalValue;</nowiki></code>
 == Adding functionality ==
 FrooxEngine has many events you can hook your functionality into, to do this you need to add a <code>protected override</code> to each of these. Do not return any values.
-You can see a full list of functions at [[How_To_Write_Plugins/Custom_Components|Custom Components]]
+You can see a full list of functions at [[How_To_Create_Plugins/Custom_Components|Custom Components]]
 For this guide, we'll focus on the basics