 | FlexibleCollider Class |
A Component that wraps a Collider, which can be easily
swapped for different shapes, sizes, or orientations at run-time, and which can be synchronized with a
corresponding part across a plane of symmetry.
Inheritance HierarchySystemObject
Object
Component
Behaviour
MonoBehaviour
Candlelight.PhysicsFlexibleCollider
Candlelight.PhysicsPhysicalBody
Object
Component
Behaviour
MonoBehaviour
Candlelight.PhysicsFlexibleCollider
Candlelight.PhysicsPhysicalBody
Namespace: Candlelight.Physics
Assembly: Assembly-CSharp-firstpass (in Assembly-CSharp-firstpass.dll) Version: 0.0.0.0
SyntaxC#
public class FlexibleCollider : MonoBehaviour
The FlexibleCollider type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | OnCollisionEnter |
Raises the collision enter event.
|
| OnCollisionExit |
Raises the collision exit event.
|
| OnCollisionStay |
Raises the collision stay event.
|
| OnDisable |
Raises the disable event.
|
| OnEnable |
Raises the enable event.
|
 | OnModifySymmetricalProperty |
Raises the modify symmetrical property event. This method is called when a property is set that needs to be
pushed to the corresponding FlexibleCollider. You can invoke it manually if you
need to push settings that are not managed on this object directly, such as Joint
limits.
|
| OnSynchronizeSymmetricalProperties |
Raises the synchronize symmetrical properties event. Override this method if the child class defines other
properties that need to be reflected to the corresponding part. This method will only be called if this
FlexibleCollider is not currently applying symmetry and
CorrespondingObject is not null.
|
| Start |
Ensure the collider is on the correct layer if it was already rotated before this instance loaded.
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetPrefabName |
Gets the name of the prefab associated with the supplied instance.
(Defined by ObjectX.) |
| OpenReferencePage |
Opens a reference web page generated for the specified object.
(Defined by ObjectX.) |
Properties| Name | Description | |
|---|---|---|
 | Center |
Gets or sets the center of the Collider in this object's space.
|
| Collider |
Gets the collider.
|
| CorrespondingObject | Gets the corresponding FlexibleCollider across a plane of symmetry. It will be the FlexibleCollider component on the CorrespondingTransform of the SymmetryMapper assigned to this instance. |
| LocalRotation |
Gets or sets the Collider's local rotation in this object's space.
|
| OnCollisionEnterEvent |
Gets the on collision enter event.
|
| OnCollisionExitEvent |
Gets the on collision exit event.
|
| OnCollisionStayEvent |
Gets the on collision stay event.
|
| RunTimeSync |
Gets or sets a value describing whether or not this FlexibleCollider should
continue to sync with its corresponding part at run-time.
|
| Shape |
Gets or sets the shape of the Collider.
|
| Size |
Gets or sets the size of the Collider.
|
| SymmetryMapper | Gets or sets a SymmetricalTransform component on this GameObject, which allows symmetrical property edits. If it is not and its CorrespondingTransform is assigned and has a FlexibleCollider component of this object's type, then all changes made to properties on this object will be reflected across the plane of symmetry. |
| Transform |
Gets this object's Transform.
|
See Also