Interface IMyControllableEntity

Inherited Members
Namespace: Sandbox.Game.Entities
Assembly: Sandbox.Game.dll
Syntax
public interface IMyControllableEntity : IMyControllableEntity

Properties

AuxiliaryContext

Declaration
MyStringId AuxiliaryContext { get; }
Property Value
Type Description
MyStringId

ControlContext

Declaration
MyStringId ControlContext { get; }
Property Value
Type Description
MyStringId

ControllerInfo

Declaration
MyControllerInfo ControllerInfo { get; }
Property Value
Type Description
Sandbox.Game.World.MyControllerInfo

EnabledBroadcasting

Declaration
bool EnabledBroadcasting { get; }
Property Value
Type Description
System.Boolean

Entity

Declaration
MyEntity Entity { get; }
Property Value
Type Description
MyEntity

HeadLocalXAngle

Declaration
float HeadLocalXAngle { get; set; }
Property Value
Type Description
System.Single

HeadLocalYAngle

Declaration
float HeadLocalYAngle { get; set; }
Property Value
Type Description
System.Single

RelativeDampeningEntity

Declaration
MyEntity RelativeDampeningEntity { get; set; }
Property Value
Type Description
MyEntity

Toolbar

Declaration
MyToolbar Toolbar { get; }
Property Value
Type Description
Sandbox.Game.Screens.Helpers.MyToolbar

ToolbarType

Declaration
MyToolbarType ToolbarType { get; }
Property Value
Type Description
MyToolbarType

Methods

BeginShoot(MyShootActionEnum)

This will be called locally to start shooting with the given action

Declaration
void BeginShoot(MyShootActionEnum action)
Parameters
Type Name Description
MyShootActionEnum action

CanSwitchAmmoMagazine()

Declaration
bool CanSwitchAmmoMagazine()
Returns
Type Description
System.Boolean

CanSwitchToWeapon(Nullable<MyDefinitionId>)

Declaration
bool CanSwitchToWeapon(Nullable<MyDefinitionId> weaponDefinition)
Parameters
Type Name Description
System.Nullable<MyDefinitionId> weaponDefinition
Returns
Type Description
System.Boolean

CleanControls()

Implementation should clear previousControlled entities and cameras. They are no longer valid. Called on game load, if player is not online

Declaration
void CleanControls()

EndShoot(MyShootActionEnum)

This will be called locally to start shooting with the given action

Declaration
void EndShoot(MyShootActionEnum action)
Parameters
Type Name Description
MyShootActionEnum action

GetCameraEntitySettings()

Declaration
MyEntityCameraSettings GetCameraEntitySettings()
Returns
Type Description
Sandbox.Game.Multiplayer.MyEntityCameraSettings

OnBeginShoot(MyShootActionEnum)

This will be called back from the sync object both on local and remote clients

Declaration
void OnBeginShoot(MyShootActionEnum action)
Parameters
Type Name Description
MyShootActionEnum action

OnEndShoot(MyShootActionEnum)

This will be called back from the sync object both on local and remote clients

Declaration
void OnEndShoot(MyShootActionEnum action)
Parameters
Type Name Description
MyShootActionEnum action

PickUpFinished()

Declaration
void PickUpFinished()

ShouldEndShootingOnPause(MyShootActionEnum)

Declaration
bool ShouldEndShootingOnPause(MyShootActionEnum action)
Parameters
Type Name Description
MyShootActionEnum action
Returns
Type Description
System.Boolean

Sprint(Boolean)

Declaration
void Sprint(bool enabled)
Parameters
Type Name Description
System.Boolean enabled

SwitchAmmoMagazine()

Declaration
void SwitchAmmoMagazine()

SwitchBroadcasting()

Declaration
void SwitchBroadcasting()

SwitchToWeapon(MyToolbarItemWeapon)

Declaration
void SwitchToWeapon(MyToolbarItemWeapon weapon)
Parameters
Type Name Description
Sandbox.Game.Screens.Helpers.MyToolbarItemWeapon weapon

SwitchToWeapon(MyDefinitionId)

Declaration
void SwitchToWeapon(MyDefinitionId weaponDefinition)
Parameters
Type Name Description
MyDefinitionId weaponDefinition

UseFinished()

Declaration
void UseFinished()

Extension Methods