Class CollisionShape

Collision shape element base class. Collision shapes are invisible elements, that trigger an event when a player enters the shape.

Inheritance

object

Element

CollisionShape

CollisionCircle

CollisionCuboid

CollisionPolygon

CollisionRectangle

CollisionSphere

CollisionTube

Inherited Members

Element.Parent

Element.Children

Element.Associations

Element.AssociatedPlayers

Element.Id

Element.TimeContext

Element.Name

Element.position

Element.Position

Element.Right

Element.Up

Element.Forward

Element.rotation

Element.Rotation

Element.velocity

Element.Velocity

Element.turnVelocity

Element.TurnVelocity

Element.interior

Element.Interior

Element.dimension

Element.Dimension

Element.alpha

Element.Alpha

Element.areCollisionsEnabled

Element.AreCollisionsEnabled

Element.isCallPropagationEnabled

Element.IsCallPropagationEnabled

Element.isFrozen

Element.IsFrozen

Element.UpdateContext

Element.IsSync

Element.Subscribers

Element.ElementDataSubscriptions

Element.BroadcastableElementData

Element.Attachment

Element.AttachedElements

Element.IsDestroyed

Element.IsVisibleToEveryone

Element.AddSubscriber(Player)

Element.RemoveSubscriber(Player)

Element.GetAndIncrementTimeContext()

Element.CanUpdateSync(byte)

Element.RunWithContext(Action, ElementUpdateContext)

Element.RunWithContext(Func<Task>, ElementUpdateContext)

Element.RunAsSync(Action, bool)

Element.RunAsSync(Func<Task>, bool)

Element.RemoveFrom(MtaServer)

Element.AssociateWith(Player)

Element.RemoveFrom(Player)

Element.UpdateAssociatedPlayers()

Element.AddChild(Element)

Element.RemoveChild(Element)

Element.IsChildOf(Element)

Element.SetData(string, LuaValue, DataSyncType)

Element.GetData(string, bool)

Element.SubscribeToData(Player, string)

Element.UnsubscribeFromData(Player, string)

Element.UnsubscribeFromAllData(Player)

Element.IsPlayerSubscribedToData(Player, string)

Element.GetPlayersSubcribedToData(string)

Element.AttachTo(Element, Vector3?, Vector3?)

Element.DetachFrom(Element)

Element.CreateFor(IEnumerable<Player>)

Element.CreateFor(Player)

Element.DestroyFor(IEnumerable<Player>)

Element.DestroyFor(Player)

Element.PositionChanged

Element.RotationChanged

Element.VelocityChanged

Element.TurnVelocityChanged

Element.InteriorChanged

Element.DimensionChanged

Element.AlphaChanged

Element.NameChanged

Element.CallPropagationChanged

Element.CollisionEnabledChanged

Element.FrozenChanged

Element.IdChanged

Element.AssociatedWith

Element.RemovedFrom

Element.DataChanged

Element.Attached

Element.Detached

Element.AttachedOffsetChanged

Element.Destroyed

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SlipeServer.Server.Elements.ColShapes

Assembly: SlipeServer.Server.dll

Syntax

public abstract class CollisionShape : Element

Constructors

CollisionShape()

Declaration

public CollisionShape()

Properties

AutoCallEvent

Declaration

public bool AutoCallEvent { get; set; }

Property Value

Type	Description
bool

DimensionsMustMatch

Declaration

public bool DimensionsMustMatch { get; set; }

Property Value

Type	Description
bool

ElementType

The element type as per MTA's specifications. Multiple C# types can share the same MTA element type.

Declaration

public override ElementType ElementType { get; }

Property Value

Type	Description
ElementType

Overrides

Element.ElementType

ElementsWithin

Declaration

public IEnumerable<Element> ElementsWithin { get; }

Property Value

Type	Description
IEnumerable<Element>

InteriorsMustMatch

Declaration

public bool InteriorsMustMatch { get; set; }

Property Value

Type	Description
bool

IsEnabled

Declaration

public bool IsEnabled { get; set; }

Property Value

Type	Description
bool

Methods

AssociateWith(MtaServer)

Declaration

public CollisionShape AssociateWith(MtaServer server)

Parameters

Type	Name	Description
MtaServer	server

Returns

Type	Description
CollisionShape

CheckElementWithin(Element)

Declaration

public void CheckElementWithin(Element element)

Parameters

Type	Name	Description
Element	element

Destroy()

Destroys the element, triggering the Destroyed event.

Declaration

public override bool Destroy()

Returns

Type	Description
bool	A bool indicating whether the element is destroyed, false if it was already destroyed prior to this call.

Overrides

Element.Destroy()

IsWithin(Element, bool, bool)

Declaration

public bool IsWithin(Element element, bool matchInterior = true, bool matchDimension = true)

Parameters

Type	Name	Description
Element	element
bool	matchInterior
bool	matchDimension

Returns

Type	Description
bool

IsWithin(Vector3, byte?, ushort?)

Declaration

public abstract bool IsWithin(Vector3 position, byte? interior = null, ushort? dimension = null)

Parameters

Type	Name	Description
Vector3	position
byte?	interior
ushort?	dimension

Returns

Type	Description
bool

Events

ElementEntered

Declaration

public event ElementEventHandler<CollisionShape, CollisionShapeHitEventArgs>? ElementEntered

Event Type

Type	Description
ElementEventHandler<CollisionShape, CollisionShapeHitEventArgs>

ElementLeft

Declaration

public event ElementEventHandler<CollisionShape, CollisionShapeLeftEventArgs>? ElementLeft

Event Type

Type	Description
ElementEventHandler<CollisionShape, CollisionShapeLeftEventArgs>

Extension Methods

CollisionShapePropertyRelayingExtensions.AddCollisionShapeRelayers(CollisionShape)

ElementPropertyRelayingExtensions.AddRelayers(Element)

ElementPropertyRelayingExtensions.RelayChange(Element, Packet)