Class: EntityControl

• Namespace: Global
• Assembly: Dew.Core.dll
• Inheritance / Derived: DewNetworkBehaviour → EntityComponent

[HideMonoScript]
[RequireComponent(typeof(EntityTransformSync))]
public class EntityControl : EntityComponent, ILogicUpdate, ICleanup

Fields

Name	Declaration	Description
attackTarget	`[NonSerialized]
public Entity attackTarget`	Available on server.
baseAgentSpeed	public float baseAgentSpeed
ClientEvent_OnDisplacementCanceled	public SafeAction<Displacement> ClientEvent_OnDisplacementCanceled
ClientEvent_OnDisplacementFinished	public SafeAction<Displacement> ClientEvent_OnDisplacementFinished
ClientEvent_OnDisplacementStarted	public SafeAction<Displacement> ClientEvent_OnDisplacementStarted
ClientEvent_OnInnerRadiusChanged	public SafeAction<float, float> ClientEvent_OnInnerRadiusChanged
ClientEvent_OnOuterRadiusChanged	public SafeAction<float, float> ClientEvent_OnOuterRadiusChanged
ClientEvent_OnTeleport	public SafeAction<Vector3, Vector3> ClientEvent_OnTeleport
CommandStallTimeout	public const float CommandStallTimeout = 0.15
lastMoveTime	`[NonSerialized]
public float lastMoveTime`	Available on server.
normalizedAcceleration	public float normalizedAcceleration
obstacleAvoidance	public bool obstacleAvoidance
ongoingChannels	public List<Channel> ongoingChannels	List of ongoingChannels on this entity.Only valid on server.
QueuedActionExpireTime	public const float QueuedActionExpireTime = 0.2
rotateSpeed	public float rotateSpeed
rotationSmoothTime	public float rotationSmoothTime
SyncAgentVelocityLifetime	public static float SyncAgentVelocityLifetime
SyncExtrapolateMaxTime	public static float SyncExtrapolateMaxTime
SyncExtrapolateStrength	public static float SyncExtrapolateStrength
SyncFixSmoothTime	public static float SyncFixSmoothTime
SyncFixSnapshotLifetime	public static float SyncFixSnapshotLifetime
SyncFixWarpDistance	public static float SyncFixWarpDistance

Properties

Name	Declaration	Description
agentPosition	public Vector3 agentPosition { get; }
agentVelocity	public Vector3 agentVelocity { get; }	Agent velocity of this entity. Available everywhere.
canDestroy	public bool canDestroy { get; }
currentMaxAgentSpeed	public float currentMaxAgentSpeed { get; }
desiredAngle	public float desiredAngle { get; }
desiredRotation	public Quaternion desiredRotation { get; }
forceWalking	public bool forceWalking { get; }
freeMovement	public bool freeMovement { get; set; }	Disables agent.
innerRadius	public float innerRadius { get; set; }
isAirborne	public bool isAirborne { get; }	Is this entity doing non-friendly displacement?
isClientSideMovement	public bool isClientSideMovement { get; }	Is client-side movement enabled for this entity?
isControlReversed	public bool isControlReversed { get; set; }	This only has effect on player-controlled entities.
isDashing	public bool isDashing { get; }	Is this entity doing friendly displacement?
isDisplacing	public bool isDisplacing { get; }
isDodging	public bool isDodging { get; }	Is this entity doing a displacement from dodge ability? e.g. Ai_GenericDodge
isDoingMoveToAction	public bool isDoingMoveToAction { get; }	Available on movement processors and server
isGamepadRotationLocked	public bool isGamepadRotationLocked { get; }	Is gamepad look rotation locked?
isLocalMovementProcessor	public bool isLocalMovementProcessor { get; }	Is local machine liable for processing movements?
isWalking	public bool isWalking { get; }	Is this entity walking? Available everywhere.
ongoingDisplacement	public Displacement ongoingDisplacement { get; }
outerRadius	public float outerRadius { get; set; }
overridenDesiredAngle	public float? overridenDesiredAngle { get; }
proxyCollider	public ProxyCollider proxyCollider { get; }
queuedActions	public IReadOnlyList<ActionBase> queuedActions { get; }
walkStrength	public float walkStrength { get; }	Can have values of range 0 ~ 1 depending on how fast it is walking. Available everywhere.

Methods

Attack(Entity, bool)

public void Attack(Entity target, bool doChase)

Parameters:

Name	Type	Description
target	Entity
doChase	bool

AttackMove(Vector3, bool)

public void AttackMove(Vector3 destination, bool useDistanceFromDestination = false)

Parameters:

Name	Type	Description
destination	UnityEngine.Vector3
useDistanceFromDestination	bool

CancelOngoingChannels()

public void CancelOngoingChannels()

CancelOngoingDisplacement()

public void CancelOngoingDisplacement()

Cast(AbilityTrigger, CastInfo, bool)

public void Cast(AbilityTrigger trigger, CastInfo info, bool allowMoveToCast = true)

Parameters:

Name	Type	Description
trigger	AbilityTrigger
info	CastInfo
allowMoveToCast	bool

Cast(AbilityTrigger, Entity, bool)

public void Cast(AbilityTrigger trigger, Entity predictTarget, bool allowMoveToCast = true)

Parameters:

Name	Type	Description
trigger	AbilityTrigger
predictTarget	Entity
allowMoveToCast	bool

Cast(AbilityTrigger, int, CastInfo, bool, bool)

Provide -1 forconfigIndexto denote ANY config index.This will cause undefined behavior if cast method differs between configs!!

public void Cast(AbilityTrigger trigger, int configIndex, CastInfo info, bool allowMoveToCast = true, bool skipRangeCheck = false)

Parameters:

Name	Type	Description
trigger	AbilityTrigger
configIndex	int
info	CastInfo
allowMoveToCast	bool
skipRangeCheck	bool

Cast(AbilityTrigger, int, Entity, bool)

public void Cast(AbilityTrigger trigger, int configIndex, Entity predictTarget, bool allowMoveToCast = true)

Parameters:

Name	Type	Description
trigger	AbilityTrigger
configIndex	int
predictTarget	Entity
allowMoveToCast	bool

ClearActionQueue()

public void ClearActionQueue()

ClearMovement()

public void ClearMovement()

CmdAttack(Entity, bool)

Provide null to clear attack target.

public void CmdAttack(Entity target, bool doChase)

Parameters:

Name	Type	Description
target	Entity
doChase	bool

CmdAttackMove(Vector3, bool)

public void CmdAttackMove(Vector3 destination, bool useDistanceFromDestination)

Parameters:

Name	Type	Description
destination	UnityEngine.Vector3
useDistanceFromDestination	bool

CmdCancelOngoingChannels()

public void CmdCancelOngoingChannels()

CmdCast(AbilityTrigger, int, CastInfo, bool, bool)

public void CmdCast(AbilityTrigger trigger, int configIndex, CastInfo info, bool allowMoveToCast, bool skipRangeCheck)

Parameters:

Name	Type	Description
trigger	AbilityTrigger
configIndex	int
info	CastInfo
allowMoveToCast	bool
skipRangeCheck	bool

CmdClearMovement()

public void CmdClearMovement()

CmdInteract(IInteractable, bool, bool)

public void CmdInteract(IInteractable interactable, bool isAlt, bool isMouse)

Parameters:

Name	Type	Description
interactable	IInteractable
isAlt	bool
isMouse	bool

CmdLookInDirection(Vector3)

public void CmdLookInDirection(Vector3 dir)

Parameters:

Name	Type	Description
dir	UnityEngine.Vector3

CmdMoveToDestination(Vector3, bool, float)

public void CmdMoveToDestination(Vector3 destination, bool immediately, float speedMult = 1)

Parameters:

Name	Type	Description
destination	UnityEngine.Vector3
immediately	bool
speedMult	float

CmdMoveWithDirection(Vector3)

public void CmdMoveWithDirection(Vector3 direction)

Parameters:

Name	Type	Description
direction	UnityEngine.Vector3

CmdStop()

public void CmdStop()

CreateTransformABTo01(Vector2, Vector2)

public static Matrix4x4 CreateTransformABTo01(Vector2 a, Vector2 b)

Parameters:

Name	Type	Description
a	UnityEngine.Vector2
b	UnityEngine.Vector2

Returns: UnityEngine.Matrix4x4

DecrementBlockCounters(BlockedAction, bool)

public void DecrementBlockCounters(Channel.BlockedAction action, bool delayOneFrame = true)

Parameters:

Name	Type	Description
action	Channel.BlockedAction
delayOneFrame	bool

DisobeyBlock(BlockableAction)

Disobey blocks for certain action, canceling related channels.

public void DisobeyBlock(EntityControl.BlockableAction action)

Parameters:

Name	Type	Description
action	EntityControl.BlockableAction

FrameUpdate()

public override void FrameUpdate()

GetPointOnBezierCurve(Vector2, Vector2, Vector2, Vector2, float)

public static Vector2 GetPointOnBezierCurve(Vector2 p0, Vector2 p1, Vector2 p2, Vector2 p3, float t)

Parameters:

Name	Type	Description
p0	UnityEngine.Vector2
p1	UnityEngine.Vector2
p2	UnityEngine.Vector2
p3	UnityEngine.Vector2
t	float

Returns: UnityEngine.Vector2

IncrementBlockCounters(BlockedAction)

public void IncrementBlockCounters(Channel.BlockedAction action)

Parameters:

Name	Type	Description
action	Channel.BlockedAction

Interact(IInteractable, bool, bool)

public void Interact(IInteractable interactable, bool isAlt, bool isMouse)

Parameters:

Name	Type	Description
interactable	IInteractable
isAlt	bool
isMouse	bool

IsActionBlocked(BlockableAction)

Is the entity allowed to do a certain action? If not, the action will be postponed until the block is resolved.Available everywhere.

public EntityControl.BlockStatus IsActionBlocked(EntityControl.BlockableAction action)

Parameters:

Name	Type	Description
action	EntityControl.BlockableAction

Returns: EntityControl.BlockStatus

LockGamepadRotation()

Lock gamepad look rotation of this entity. You must call UnlockLookRotation afterwards.

public void LockGamepadRotation()

LogicUpdate(float)

public override void LogicUpdate(float dt)

Parameters:

Name	Type	Description
dt	float

MoveToDestination(Vector3, bool, float)

public void MoveToDestination(Vector3 destination, bool immediately, float speedMult = 1)

Parameters:

Name	Type	Description
destination	UnityEngine.Vector3
immediately	bool
speedMult	float

OnCleanup()

public void OnCleanup()

OnStart()

public override void OnStart()

OnStartClient()

public override void OnStartClient()

OnStartServer()

public override void OnStartServer()

OnStop()

public override void OnStop()

OnStopServer()

public override void OnStopServer()

Rotate(float, bool, float)

public void Rotate(float angle, bool immediately, float overrideDuration = -1)

Parameters:

Name	Type	Description
angle	float
immediately	bool
overrideDuration	float

Rotate(Quaternion, bool, float)

public void Rotate(Quaternion rotation, bool immediately, float overrideDuration = -1)

Parameters:

Name	Type	Description
rotation	UnityEngine.Quaternion
immediately	bool
overrideDuration	float

Rotate(Vector3, bool, float)

public void Rotate(Vector3 forward, bool immediately, float overrideDuration = -1)

Parameters:

Name	Type	Description
forward	UnityEngine.Vector3
immediately	bool
overrideDuration	float

RotateTowards(Entity, bool, float)

public void RotateTowards(Entity ent, bool immediately, float overrideDuration = -1)

Parameters:

Name	Type	Description
ent	Entity
immediately	bool
overrideDuration	float

RotateTowards(Vector3, bool, float)

public void RotateTowards(Vector3 position, bool immediately, float overrideDuration = -1)

Parameters:

Name	Type	Description
position	UnityEngine.Vector3
immediately	bool
overrideDuration	float

SetAgentDestination(Vector3, bool)

public void SetAgentDestination(Vector3 destination, bool important)

Parameters:

Name	Type	Description
destination	UnityEngine.Vector3
important	bool

SetAgentPosition(Vector3)

Can be called on local movement processor.

public void SetAgentPosition(Vector3 position)

Parameters:

Name	Type	Description
position	UnityEngine.Vector3

StartChannel(Channel)

public Channel StartChannel(Channel channel)

Parameters:

Name	Type	Description
channel	Channel

Returns: Channel

StartDaze(float)

public Channel StartDaze(float duration)

Parameters:

Name	Type	Description
duration	float

Returns: Channel

StartDisplacement(Displacement)

public void StartDisplacement(Displacement disp)

Parameters:

Name	Type	Description
disp	Displacement

Stop()

public void Stop()

StopOverrideRotation()

Unlock override rotation.

public void StopOverrideRotation()

Teleport(Vector3)

Teleport this entity to the targeted position.You should only feed in a valid position by usingDew.GetValidAgentPosition()beforehand.

public void Teleport(Vector3 position)

Parameters:

Name	Type	Description
position	UnityEngine.Vector3

TransformPoint(Vector2, Matrix4x4)

public static Vector2 TransformPoint(Vector2 point, Matrix4x4 transform)

Parameters:

Name	Type	Description
point	UnityEngine.Vector2
transform	UnityEngine.Matrix4x4

Returns: UnityEngine.Vector2

UnlockGamepadRotation()

Unlock gamepad look rotation of this entity.

public void UnlockGamepadRotation()

UpdateLastMoveTime()

public void UpdateLastMoveTime()