Struct PlatformEffector2D

Source
pub struct PlatformEffector2D {
Show 15 fields pub m_ColliderMask: BitField, pub m_Enabled: u8, pub m_GameObject: PPtr, pub m_OneWay: Option<bool>, pub m_RotationalOffset: Option<f32>, pub m_SideAngleVariance: Option<f32>, pub m_SideArc: Option<f32>, pub m_SideBounce: Option<bool>, pub m_SideFriction: Option<bool>, pub m_SurfaceArc: Option<f32>, pub m_UseColliderMask: Option<bool>, pub m_UseOneWay: Option<bool>, pub m_UseOneWayGrouping: Option<bool>, pub m_UseSideBounce: Option<bool>, pub m_UseSideFriction: Option<bool>,
}
Expand description

PlatformEffector2D is a class of the Unity engine since version 5.0.0f4. Exert from Unity’s scripting documentation: Applies “platform” behaviour such as one-way collisions etc. When the source Collider2D is a trigger, the effector will apply forces whenever the target Collider2D overlaps the source. When the source Collider isn’t a trigger, the effector will apply forces whenever the target Collider2D is in contact with the source only.

Fields§

§m_ColliderMask: BitField

The mask used to select specific layers allowed to interact with the effector.

§m_Enabled: u8

Enabled Behaviours are Updated, disabled Behaviours are not.

§m_GameObject: PPtr

The game object this component is attached to. A component is always attached to a game object. PPtr<GameObject>: (5.0.0f4 - 2022.3.2f1)

§m_OneWay: Option<bool>

bool: (5.0.0f4 - 5.0.0f4)

§m_RotationalOffset: Option<f32>

The rotational offset angle from the local ‘up’. f32: (5.5.0f3 - 2022.3.2f1)

§m_SideAngleVariance: Option<f32>

f32: (5.0.0f4 - 5.1.1f1)

§m_SideArc: Option<f32>

The angle of an arc that defines the sides of the platform centered on the local ‘left’ and ‘right’ of the effector. Any collision normals within this arc are considered for the ‘side’ behaviours. f32: (5.2.2f1 - 2022.3.2f1)

§m_SideBounce: Option<bool>

bool: (5.0.0f4 - 5.0.0f4)

§m_SideFriction: Option<bool>

bool: (5.0.0f4 - 5.0.0f4)

§m_SurfaceArc: Option<f32>

The angle of an arc that defines the surface of the platform centered of the local ‘up’ of the effector. f32: (5.1.2f1 - 2022.3.2f1)

§m_UseColliderMask: Option<bool>

Should the collider-mask be used or the global collision matrix? bool: (5.0.2f1 - 2022.3.2f1)

§m_UseOneWay: Option<bool>

Should the one-way collision behaviour be used? bool: (5.0.1f1 - 2022.3.2f1)

§m_UseOneWayGrouping: Option<bool>

Ensures that all contacts controlled by the one-way behaviour act the same. bool: (5.2.4f1 - 2022.3.2f1)

§m_UseSideBounce: Option<bool>

Should bounce be used on the platform sides? bool: (5.0.1f1 - 2022.3.2f1)

§m_UseSideFriction: Option<bool>

Should friction be used on the platform sides? bool: (5.0.1f1 - 2022.3.2f1)

Trait Implementations§

Source§

impl Debug for PlatformEffector2D

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PlatformEffector2D

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PlatformEffector2D

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,