Inheritance diagram for Sandbox.Game.Components.MyRopeComponent:

Public Member Functions
override void	LoadData ()

override void	UpdateBeforeSimulation ()

override void	UpdateAfterSimulation ()

void	GetRopesForGrids (HashSet< MyCubeGrid > grids, HashSet< MyRope > outRopes)
	Writes rope entity IDs (to outRopes) associated with given grids. More...

bool	HasGridAttachedRope (MyCubeGrid grid)

void	SetRopeLengthSynced (long ropeId, float currentLength)

Public Member Functions inherited from VRage.Game.Components.MySessionComponentBase
virtual bool	UpdatedBeforeInit ()

	MySessionComponentBase ()

void	SetUpdateOrder (MyUpdateOrder order)

virtual void	InitFromDefinition (MySessionComponentDefinition definition)

virtual void	Init (MyObjectBuilder_SessionComponent sessionComponent)

virtual MyObjectBuilder_SessionComponent	GetObjectBuilder ()

void	AfterLoadData ()

void	UnloadDataConditional ()

virtual void	SaveData ()

virtual void	BeforeStart ()

virtual void	Simulate ()

virtual void	UpdatingStopped ()

virtual void	Draw ()

virtual void	HandleInput ()

override string	ToString ()

Static Public Member Functions
static void	AddHook (long hookEntityId, float size, Vector3 localPivot)

static void	AddHookWinding (long hookEntityId, float radius, ref Matrix localDummy)

static void	AddHookRelease (long hookEntityId, Vector3 localAxis, float thresholdAngleCos)

static long	AddRopeData (long hookEntityIdA, long hookEntityIdB, MyRopeDefinition ropeDefinition, long ropeId)

static long	AddRopeData (MyRopeData publicData, long ropeId)

static void	RemoveHook (long hookEntityId)

static void	TryRemoveRopeOnHook (long hookEntityId)

static void	RemoveRopeData (long ropeId)

static bool	HasRope (long hookEntityId)

static bool	AreGridsConnected (MyCubeGrid grid1, MyCubeGrid grid2)

static bool	HasRelease (long hookEntityId)

static void	GetRopeData (long ropeEntityId, out MyRopeData ropeData)

static bool	TryGetRopeData (long ropeEntityId, out MyRopeData ropeData)

static void	SetRopeData (long ropeEntityId, float minRopeLength, float maxRopeLength)

static bool	TryGetRopeForHook (long hookEntityId, out long ropeEntityId)

static void	GetHookData (long hookEntityId, out Vector3 localPivot)

static void	GetReleaseData (long hookEntityId, out Vector3 localBaseAxis, out Vector2 orientation, out float thresholdAngleCos)

static void	SetReleaseData (long hookEntityId, Vector2 orientation, float thresholdAngleCos)

static void	ComputeLocalReleaseAxis (Vector3 localBaseAxis, Vector2 orientation, out Vector3 localAxis)

static bool	IsWindingUnlocked (long hookEntityId)

static void	AddOrSetDrumRopeLimits (long hookEntityId, float minRopeLength, float maxRopeLength)

static void	GetDrumRopeLimits (long hookEntityId, out float minRopeLength, out float maxRopeLength)

static void	RemoveDrumRopeLimits (long hookEntityId)

static bool	CanConnectHooks (long hookIdFrom, long hookIdTo, MyRopeDefinition ropeDefinition)

static bool	HasEntityWinding (long hookEntityId)

static void	UnlockWinding (long hookEntityId)

static void	LockWinding (long hookEntityId)

static void	AddRopeRequest (long entityId1, long entityId2, MyDefinitionId ropeDefinitionId)

static void	CloseRopeRequest (long ropeId)

static void	SetReleaseDataRequest (long hookEntityId, Vector2 orientation, float thresholdCos)

static void	SetReleaseData_Implementation (long hookEntityId, Vector2 orientation, float thresholdCos)

static void	SetDrumRopeLimitsRequest (long hookEntityId, float lengthMin, float lengthMax)

static void	SetDrumRopeLimits_Implementation (long hookEntityId, float lengthMin, float lengthMax)

Public Attributes
const float	DEFAULT_RELEASE_THRESHOLD = (float)(Math.PI / 18.0)

Public Attributes inherited from VRage.Game.Components.MySessionComponentBase
readonly string	DebugName

readonly int	Priority

readonly Type	ComponentType

IMySession	Session

Static Public Attributes
static MyRopeComponent	Static

Protected Member Functions
override void	UnloadData ()

Properties
static MyRopeAttacher	RopeAttacher `[get]`

override bool	IsRequiredByGame `[get]`

Properties inherited from VRage.Game.Components.MySessionComponentBase
MyUpdateOrder	UpdateOrder `[get]`

MyObjectBuilderType	ObjectBuilderType `[get]`

bool	Loaded `[get]`

bool	Initialized `[get]`

MyDefinitionId	Definition `[get, set]`

virtual Type[]	Dependencies `[get]`

virtual bool	IsRequiredByGame `[get]`
	Indicates whether a session component should be used in current configuration. Example: MyDestructionData component returns true only when game uses Havok Destruction More...

Detailed Description

Definition at line 42 of file MyRopeComponent.cs.

Member Function Documentation

static void Sandbox.Game.Components.MyRopeComponent.AddHook	(	long	hookEntityId,
		float	size,
		Vector3	localPivot
	)

inlinestatic

Definition at line 687 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.AddHookRelease	(	long	hookEntityId,
		Vector3	localAxis,
		float	thresholdAngleCos
	)

inlinestatic

Definition at line 697 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.AddHookWinding	(	long	hookEntityId,
		float	radius,
		ref Matrix	localDummy
	)

inlinestatic

Definition at line 692 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.AddOrSetDrumRopeLimits	(	long	hookEntityId,
		float	minRopeLength,
		float	maxRopeLength
	)

inlinestatic

Definition at line 912 of file MyRopeComponent.cs.

static long Sandbox.Game.Components.MyRopeComponent.AddRopeData	(	long	hookEntityIdA,
		long	hookEntityIdB,
		MyRopeDefinition	ropeDefinition,
		long	ropeId
	)

inlinestatic

Definition at line 702 of file MyRopeComponent.cs.

static long Sandbox.Game.Components.MyRopeComponent.AddRopeData	(	MyRopeData	publicData,
		long	ropeId
	)

inlinestatic

Definition at line 727 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.AddRopeRequest	(	long	entityId1,
		long	entityId2,
		MyDefinitionId	ropeDefinitionId
	)

inlinestatic

Definition at line 1343 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.AreGridsConnected	(	MyCubeGrid	grid1,
		MyCubeGrid	grid2
	)

inlinestatic

Definition at line 831 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.CanConnectHooks	(	long	hookIdFrom,
		long	hookIdTo,
		MyRopeDefinition	ropeDefinition
	)

inlinestatic

Definition at line 943 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.CloseRopeRequest ( long ropeId )

inlinestatic

Definition at line 1356 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.ComputeLocalReleaseAxis	(	Vector3	localBaseAxis,
		Vector2	orientation,
		out Vector3	localAxis
	)

inlinestatic

Definition at line 902 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.GetDrumRopeLimits	(	long	hookEntityId,
		out float	minRopeLength,
		out float	maxRopeLength
	)

inlinestatic

Definition at line 931 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.GetHookData	(	long	hookEntityId,
		out Vector3	localPivot
	)

inlinestatic

Definition at line 878 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.GetReleaseData	(	long	hookEntityId,
		out Vector3	localBaseAxis,
		out Vector2	orientation,
		out float	thresholdAngleCos
	)

inlinestatic

Definition at line 883 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.GetRopeData	(	long	ropeEntityId,
		out MyRopeData	ropeData
	)

inlinestatic

Definition at line 847 of file MyRopeComponent.cs.

void Sandbox.Game.Components.MyRopeComponent.GetRopesForGrids	(	HashSet< MyCubeGrid >	grids,
		HashSet< MyRope >	outRopes
	)

inline

Writes rope entity IDs (to outRopes) associated with given grids.

Definition at line 1279 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.HasEntityWinding ( long hookEntityId )

inlinestatic

Definition at line 965 of file MyRopeComponent.cs.

bool Sandbox.Game.Components.MyRopeComponent.HasGridAttachedRope ( MyCubeGrid grid )

inline

Definition at line 1296 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.HasRelease ( long hookEntityId )

inlinestatic

Definition at line 842 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.HasRope ( long hookEntityId )

inlinestatic

Definition at line 826 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.IsWindingUnlocked ( long hookEntityId )

inlinestatic

Definition at line 907 of file MyRopeComponent.cs.

override void Sandbox.Game.Components.MyRopeComponent.LoadData ( )

inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 232 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.LockWinding ( long hookEntityId )

inlinestatic

Definition at line 1031 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.RemoveDrumRopeLimits ( long hookEntityId )

inlinestatic

Definition at line 938 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.RemoveHook ( long hookEntityId )

inlinestatic

Definition at line 756 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.RemoveRopeData ( long ropeId )

inlinestatic

Definition at line 789 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.SetDrumRopeLimits_Implementation	(	long	hookEntityId,
		float	lengthMin,
		float	lengthMax
	)

inlinestatic

Definition at line 1404 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.SetDrumRopeLimitsRequest	(	long	hookEntityId,
		float	lengthMin,
		float	lengthMax
	)

inlinestatic

Definition at line 1391 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.SetReleaseData	(	long	hookEntityId,
		Vector2	orientation,
		float	thresholdAngleCos
	)

inlinestatic

Definition at line 891 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.SetReleaseData_Implementation	(	long	hookEntityId,
		Vector2	orientation,
		float	thresholdCos
	)

inlinestatic

Definition at line 1386 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.SetReleaseDataRequest	(	long	hookEntityId,
		Vector2	orientation,
		float	thresholdCos
	)

inlinestatic

Definition at line 1373 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.SetRopeData	(	long	ropeEntityId,
		float	minRopeLength,
		float	maxRopeLength
	)

inlinestatic

Definition at line 865 of file MyRopeComponent.cs.

void Sandbox.Game.Components.MyRopeComponent.SetRopeLengthSynced	(	long	ropeId,
		float	currentLength
	)

inline

Definition at line 1306 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.TryGetRopeData	(	long	ropeEntityId,
		out MyRopeData	ropeData
	)

inlinestatic

Definition at line 852 of file MyRopeComponent.cs.

static bool Sandbox.Game.Components.MyRopeComponent.TryGetRopeForHook	(	long	hookEntityId,
		out long	ropeEntityId
	)

inlinestatic

Definition at line 873 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.TryRemoveRopeOnHook ( long hookEntityId )

inlinestatic

Definition at line 780 of file MyRopeComponent.cs.

override void Sandbox.Game.Components.MyRopeComponent.UnloadData ( )

inlineprotectedvirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 654 of file MyRopeComponent.cs.

static void Sandbox.Game.Components.MyRopeComponent.UnlockWinding ( long hookEntityId )

inlinestatic

Definition at line 970 of file MyRopeComponent.cs.

override void Sandbox.Game.Components.MyRopeComponent.UpdateAfterSimulation ( )

inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 540 of file MyRopeComponent.cs.

override void Sandbox.Game.Components.MyRopeComponent.UpdateBeforeSimulation ( )

inlinevirtual

Reimplemented from VRage.Game.Components.MySessionComponentBase.

Definition at line 255 of file MyRopeComponent.cs.

Member Data Documentation

const float Sandbox.Game.Components.MyRopeComponent.DEFAULT_RELEASE_THRESHOLD = (float)(Math.PI / 18.0)

Definition at line 193 of file MyRopeComponent.cs.

MyRopeComponent Sandbox.Game.Components.MyRopeComponent.Static

static

Definition at line 196 of file MyRopeComponent.cs.

Property Documentation

override bool Sandbox.Game.Components.MyRopeComponent.IsRequiredByGame

get

Definition at line 228 of file MyRopeComponent.cs.

MyRopeAttacher Sandbox.Game.Components.MyRopeComponent.RopeAttacher

staticget

Definition at line 223 of file MyRopeComponent.cs.

The documentation for this class was generated from the following file:

Sources/Sandbox.Game/Game/SessionComponents/MyRopeComponent.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation