Class FlexalonComponent

Base type for many Flexalon components. Deals with FlexalonNode lifecycle, and provides the ForceUpdate and MarkDirty methods to trigger a Flexalon update.

Inheritance

object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

FlexalonComponent

FlexalonConstraint

FlexalonGridCell

FlexalonObject

FlexalonRandomModifier

LayoutBase

Syntax

[ExecuteAlways]
[RequireComponent(typeof(FlexalonResult))]
public abstract class FlexalonComponent : MonoBehaviour

Fields

_node

Declaration

protected FlexalonNode _node

Field Value

Type	Description
FlexalonNode

Properties

Node

The FlexalonNode associated with this gameObject.

Declaration

public FlexalonNode Node { get; }

Property Value

Type	Description
FlexalonNode

Methods

DoOnDisable()

Called when the component is disabled.

Declaration

protected virtual void DoOnDisable()

DoOnEnable()

Called when the component is enabled.

Declaration

protected virtual void DoOnEnable()

DoUpdate()

Called when the component is updated.

Declaration

public virtual void DoUpdate()

ForceUpdate()

Forces this component, its parent nodes, and its children nodes to update immediately.

Declaration

public void ForceUpdate()

Initialize()

Called when the component is first created.

Declaration

protected virtual void Initialize()

MarkDirty()

Marks this component needing an update. The Flexalon singleton will visit it in dependency order on LateUpdate.

Declaration

public void MarkDirty()

ResetProperties()

Called when the component is destroyed to reset properties on the FlexalonNode.

Declaration

protected virtual void ResetProperties()

UpdateProperties()

Called when the component is enabled to apply properties to the FlexalonNode.

Declaration

protected virtual void UpdateProperties()

Upgrade(int)

Called when the component is upgraded to a new version of Flexalon.

Declaration

protected virtual void Upgrade(int fromVersion)

Parameters

Type	Name	Description
int	fromVersion