Class ObjMovable

This is a useful feature that adds dynamic movement to any NavObject. With it, NavObjects can be moved around using forces, input, or actions, making their movement responsive and flexible.

Inheritance

object

AxisMonoBehaviour

ObjFeature

ObjMovable

Inherited Members

AxisMonoBehaviour.ContainsLabel(string)

AxisMonoBehaviour.CountChildrenWithLabel(string, bool)

AxisMonoBehaviour.ContainsLabelInChildren(string, bool)

AxisMonoBehaviour.GetSpaceBetweenColliders(AxisMonoBehaviour)

AxisMonoBehaviour.GetSpaceBetweenCollidersHorizontally(AxisMonoBehaviour)

AxisMonoBehaviour.PauseGame()

AxisMonoBehaviour.SetActiveByName(string)

AxisMonoBehaviour.ResumeGame()

AxisMonoBehaviour.GameTimeScaleSet(float)

AxisMonoBehaviour.transform

AxisMonoBehaviour.gameObject

AxisMonoBehaviour.collider

AxisMonoBehaviour.Origin

AxisMonoBehaviour.OnTransformChildrenChanged()

Namespace: Axis.ObjFeatures

Assembly: cs.temp.dll.dll

Syntax

public sealed class ObjMovable : ObjFeature

Fields

FireworkOnGrounded

Firework to burst when falling is stopped by ground

Declaration

public AxisFirework FireworkOnGrounded

Field Value

Type	Description
AxisFirework

FireworkOnJump

Declaration

public AxisFirework FireworkOnJump

Field Value

Type	Description
AxisFirework

MaxFallHeight

Max height between two tiles this NavObject can seamless fall down. Higher heights will block the object like invisible wall.

Declaration

public float MaxFallHeight

Field Value

Type	Description
float

MaxHeightWalkable

Max height between two tiles this NavObject can seamless walk up as a ramp

Declaration

public float MaxHeightWalkable

Field Value

Type	Description
float

MaxSpeed

Max speed this object can reach, will clamp when higher

Declaration

public float MaxSpeed

Field Value

Type	Description
float

OnMove

Object with events dispatched related to movement

Declaration

public ObjMovableEvents OnMove

Field Value

Type	Description
ObjMovableEvents

SpeedAcceleration

This ranges from 0.1f where the object takes a long time to accelerate and start moving, to 1.0f where object goes to fullspeed immediatly.

Declaration

public float SpeedAcceleration

Field Value

Type	Description
float

speedDamping

This ranges from 0f where the object never looses speed, to 1.0f where object stops as soon as no force is pushing it.

Declaration

public float speedDamping

Field Value

Type	Description
float

StartSpeed

Speed and direction to be pushed when this object is enabled

Declaration

public Vector3 StartSpeed

Field Value

Type	Description
Vector3

UnabledTerrains

List of terrain labels this NavObject is forebiden to move through, use methods UnabledTerrains_Add() and UnabledTerrains_Remove() to change this property in runtime.

Declaration

public TerrainType[] UnabledTerrains

Field Value

Type	Description
TerrainType[]

VeryDynamic

Declaration

public bool VeryDynamic

Field Value

Type	Description
bool

Weight

This NavObject weight, affects gravity, movement and collision

Declaration

public float Weight

Field Value

Type	Description
float

Properties

SpeedDamping

This ranges from 0f where the object never looses speed, to 1.0f where object stops as soon as no force is pushing it.

Declaration

public float SpeedDamping { get; set; }

Property Value

Type	Description
float

Methods

Fall()

Force falling even if it has forces pushing up

Declaration

public void Fall()

FlapWing(float)

Execute a flap of wings on this object

Declaration

public void FlapWing(float force)

Parameters

Type	Name	Description
float	force	Force to apply

Jump(float)

Execute a jump force on this object

Declaration

public void Jump(float force)

Parameters

Type	Name	Description
float	force	Force to apply

MoveBackward()

Declaration

public void MoveBackward()

MoveForward()

Declaration

public void MoveForward()

MoveLeft()

Declaration

public void MoveLeft()

MoveRight()

Declaration

public void MoveRight()

Push(Vector3)

Apply force push in this object

Declaration

public void Push(Vector3 force)

Parameters

Type	Name	Description
Vector3	force	Force to apply

UnabledTerrains_Add(TerrainType)

Adds a new terrain type to the unabled list

Declaration

public void UnabledTerrains_Add(TerrainType value)

Parameters

Type	Name	Description
TerrainType	value	Terrain to unable

Remarks

If its already in the list, doesn't duplicate

UnabledTerrains_Remove(TerrainType)

Removes a terrain type from the unabled list

Declaration

public void UnabledTerrains_Remove(TerrainType value)

Parameters

Type	Name	Description
TerrainType	value	Terrain to allow

Remarks

If its not in the list, nothing happens