Public Member Functions
	MyHighlightData (long entityId=0, int thickness=-1, ulong pulseTimeInFrames=0, Color?outlineColor=null, bool ignoreUseObjectData=false, long playerId=-1, string subPartNames=null)
	Constructor. More...

Public Attributes
long	EntityId
	Id of entity that should be highlighted. More...

Color	OutlineColor
	Color of highlight overlay. More...

int	Thickness
	Overlay thickness. More...

ulong	PulseTimeInFrames
	Number of frames between pulses. More...

long	PlayerId
	Id of player that should do the highlight. (For non local players its send to client) More...

bool	IgnoreUseObjectData
	When set to true the system does not use the IMyUseObject logic to process the highlight. More...

string	SubPartNames
	Specify there the names of the subparts that would be highlighted instead of the full model. Format: "subpart_1;subpart_2" More...

Detailed Description

Definition at line 30 of file MyHighlightSystem.cs.

Constructor & Destructor Documentation

Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.MyHighlightData	(	long	entityId = `0`,
		int	thickness = `-1`,
		ulong	pulseTimeInFrames = `0`,
		Color?	outlineColor = `null`,
		bool	ignoreUseObjectData = `false`,
		long	playerId = `-1`,
		string	subPartNames = `null`
	)

inline

Constructor.

Parameters

entityId	Id of entity that should be highlighted.
thickness	Overlay thickness.
pulseTimeInFrames	Number of frames between the pulses.
outlineColor	Color of overlay.
ignoreUseObjectData	Used to ignore IMyUseObject logic for highlighting.
playerId	Id of receiving player.
subPartNames	Names of subparts that should be highlighted instead of the full model.

Definition at line 75 of file MyHighlightSystem.cs.

long Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.EntityId

Id of entity that should be highlighted.

Definition at line 35 of file MyHighlightSystem.cs.

bool Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.IgnoreUseObjectData

When set to true the system does not use the IMyUseObject logic to process the highlight.

Definition at line 57 of file MyHighlightSystem.cs.

Color Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.OutlineColor

Color of highlight overlay.

Definition at line 39 of file MyHighlightSystem.cs.

long Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.PlayerId

Id of player that should do the highlight. (For non local players its send to client)

Definition at line 52 of file MyHighlightSystem.cs.

ulong Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.PulseTimeInFrames

Number of frames between pulses.

Definition at line 47 of file MyHighlightSystem.cs.

string Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.SubPartNames

Specify there the names of the subparts that would be highlighted instead of the full model. Format: "subpart_1;subpart_2"

Definition at line 63 of file MyHighlightSystem.cs.

int Sandbox.Game.SessionComponents.MyHighlightSystem.MyHighlightData.Thickness

Overlay thickness.

Definition at line 43 of file MyHighlightSystem.cs.

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