Component:DestroyProxy: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page DestroyProxy (Component) to Component:DestroyProxy: Creating component Namespace
add some info, remove component stub
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=DestroyProxyComponent.png
|Image=DestroyProxyComponent.png
Line 11: Line 10:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|DestroyTarget|IDestroyable|
|DestroyTarget|IDestroyable| The slot, component (etc) to destroy.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
The DestroyProxy component is used to automatically destroy a specified <code>DestroyTarget</code> when the slot it is attached to gets destroyed.
The DestroyProxy component is used to automatically destroy a specified <code>DestroyTarget</code> when this component itself or it's parent slot is destroyed.


Important to note: If you'd like to remove the component, first unset the <code>DestroyTarget</code> or else the target IDestroyable object will be destroyed as well.
Important to note: If you'd like to remove the component, first unset the <code>DestroyTarget</code> or else the target IDestroyable object will be destroyed as well.
Line 22: Line 21:


== Examples ==
== Examples ==
This can be put under a slot with a bunch of other destroy proxies that group together certain feature sets on an avatar, item or world. When the slot is destroyed, every destroy proxy on the slot will destroy everything they point to. This is useful for example, making multiple avatars with different feature sets and removing them to make simpler versions.


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Destroy Proxy]]
[[Category:Components{{#translation:}}|Destroy Proxy]]
[[Category:Components:Transform:Utility{{#translation:}}|Destroy Proxy]]
[[Category:Components:Transform:Utility{{#translation:}}|Destroy Proxy]]

Latest revision as of 23:42, 15 October 2024

Component image 
Destroy Proxy component as seen in the Scene Inspector


Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
DestroyTarget IDestroyable The slot, component (etc) to destroy.

Usage

The DestroyProxy component is used to automatically destroy a specified DestroyTarget when this component itself or it's parent slot is destroyed.

Important to note: If you'd like to remove the component, first unset the DestroyTarget or else the target IDestroyable object will be destroyed as well.

Examples

This can be put under a slot with a bunch of other destroy proxies that group together certain feature sets on an avatar, item or world. When the slot is destroyed, every destroy proxy on the slot will destroy everything they point to. This is useful for example, making multiple avatars with different feature sets and removing them to make simpler versions.

Related Components