Class ClimbSystem

Inheritance

System.Object

SharedClimbSystem

ClimbSystem

Namespace: Content.Server.Climbing

Assembly: Content.Server.dll

Syntax

public sealed class ClimbSystem : SharedClimbSystem

Methods

CanVault(ClimbableComponent, EntityUid, EntityUid, EntityUid, out String)

Checks if the user can vault the dragged entity onto the the target

Declaration

public bool CanVault(ClimbableComponent component, EntityUid user, EntityUid dragged, EntityUid target, out string reason)

Parameters

Type	Name	Description
ClimbableComponent	component	The climbable component of the object being vaulted onto
EntityUid	user	The user that wants to vault the entity
EntityUid	dragged	The entity that is being vaulted
EntityUid	target	The object that is being vaulted onto
System.String	reason	The reason why it cant be dropped

Returns

Type	Description
System.Boolean

CanVault(ClimbableComponent, EntityUid, EntityUid, out String)

Checks if the user can vault the target

Declaration

public bool CanVault(ClimbableComponent component, EntityUid user, EntityUid target, out string reason)

Parameters

Type	Name	Description
ClimbableComponent	component	The component of the entity that is being vaulted
EntityUid	user	The entity that wants to vault
EntityUid	target	The object that is being vaulted
System.String	reason	The reason why it cant be dropped

Returns

Type	Description
System.Boolean

ForciblySetClimbing(EntityUid, EntityUid, ClimbingComponent)

Declaration

public void ForciblySetClimbing(EntityUid uid, EntityUid climbable, ClimbingComponent component = null)

Parameters

Type	Name	Description
EntityUid	uid
EntityUid	climbable
ClimbingComponent	component

Initialize()

Declaration

public override void Initialize()

Overrides

SharedClimbSystem.Initialize()

MoveEntityToward(EntityUid, EntityUid, PhysicsComponent, ClimbingComponent)

Moves the entity toward the target climbed entity

Declaration

public void MoveEntityToward(EntityUid uid, EntityUid target, PhysicsComponent physics = null, ClimbingComponent climbing = null)

Parameters

Type	Name	Description
EntityUid	uid
EntityUid	target
Robust.Shared.Physics.Components.PhysicsComponent	physics
ClimbingComponent	climbing

OnCanDragDropOn(EntityUid, ClimbableComponent, ref CanDropTargetEvent)

Declaration

protected override void OnCanDragDropOn(EntityUid uid, ClimbableComponent component, ref CanDropTargetEvent args)

Parameters

Type	Name	Description
EntityUid	uid
ClimbableComponent	component
CanDropTargetEvent	args

TryClimb(EntityUid, EntityUid, EntityUid, out Nullable<DoAfterId>, ClimbableComponent, ClimbingComponent)

Declaration

public bool TryClimb(EntityUid user, EntityUid entityToMove, EntityUid climbable, out DoAfterId? id, ClimbableComponent comp = null, ClimbingComponent climbing = null)

Parameters

Type	Name	Description
EntityUid	user
EntityUid	entityToMove
EntityUid	climbable
System.Nullable<Content.Shared.DoAfter.DoAfterId>	id
ClimbableComponent	comp
ClimbingComponent	climbing

Returns

Type	Description
System.Boolean

Update(Single)

Declaration

public override void Update(float frameTime)

Parameters

Type	Name	Description
System.Single	frameTime