Class Element

The base class for any and all elements

Inheritance

object

Element

Blip

CollisionShape

DummyElement

Marker

Ped

Pickup

RadarArea

RootElement

Team

Vehicle

Water

WorldObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SlipeServer.Server.Elements

Assembly: SlipeServer.Server.dll

Syntax

public class Element

Constructors

Element()

Declaration

public Element()

Element(Element)

Declaration

public Element(Element parent)

Parameters

Type	Name	Description
Element	parent

Fields

alpha

Declaration

protected byte alpha

Field Value

Type	Description
byte

areCollisionsEnabled

Declaration

protected bool areCollisionsEnabled

Field Value

Type	Description
bool

dimension

Declaration

protected ushort dimension

Field Value

Type	Description
ushort

interior

Declaration

protected byte interior

Field Value

Type	Description
byte

isCallPropagationEnabled

Declaration

protected bool isCallPropagationEnabled

Field Value

Type	Description
bool

isFrozen

Declaration

protected bool isFrozen

Field Value

Type	Description
bool

position

Declaration

protected Vector3 position

Field Value

Type	Description
Vector3

rotation

Declaration

protected Vector3 rotation

Field Value

Type	Description
Vector3

turnVelocity

Declaration

protected Vector3 turnVelocity

Field Value

Type	Description
Vector3

velocity

Declaration

protected Vector3 velocity

Field Value

Type	Description
Vector3

Properties

Alpha

The element's alpha level, alpha of 0 means completely transparent, while 255 is completely opaque.

Declaration

public byte Alpha { get; set; }

Property Value

Type	Description
byte

AreCollisionsEnabled

Indicates whether the element collides with anything else, this includes both world objects, and the default map.

Declaration

public bool AreCollisionsEnabled { get; set; }

Property Value

Type	Description
bool

AssociatedPlayers

Players the element is associated with. These are players that are aware of the existence of this element.

Declaration

public IEnumerable<Player> AssociatedPlayers { get; }

Property Value

Type	Description
IEnumerable<Player>

Associations

Declaration

public IReadOnlyCollection<ElementAssociation> Associations { get; }

Property Value

Type	Description
IReadOnlyCollection<ElementAssociation>

AttachedElements

Elements that are attached to this element

Declaration

public IReadOnlyCollection<ElementAttachment> AttachedElements { get; }

Property Value

Type	Description
IReadOnlyCollection<ElementAttachment>

Attachment

The element's current attachment. Representing this element being attached to a target element.

Declaration

public ElementAttachment? Attachment { get; }

Property Value

Type	Description
ElementAttachment

BroadcastableElementData

A read-only representation of all element data that is broadcastable

Declaration

public CustomData BroadcastableElementData { get; }

Property Value

Type	Description
CustomData

Children

The element's children as in the element tree.

Declaration

public IReadOnlyCollection<Element> Children { get; }

Property Value

Type	Description
IReadOnlyCollection<Element>

Dimension

The element's dimension, elements are only visible in the dimension a player (or rather their camera) is in.

Declaration

public ushort Dimension { get; set; }

Property Value

Type	Description
ushort

ElementDataSubscriptions

Lists all the players that are subscribed to one (or more) element data entries on this element.

Declaration

public ConcurrentDictionary<Player, ConcurrentDictionary<string, bool>> ElementDataSubscriptions { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Player, ConcurrentDictionary<string, bool>>

ElementType

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

Declaration

public virtual ElementType ElementType { get; }

Property Value

Type	Description
ElementType

Forward

A vector representing 1 unit in front of the element.

Declaration

public Vector3 Forward { get; }

Property Value

Type	Description
Vector3

Id

Declaration

public ElementId Id { get; set; }

Property Value

Type	Description
ElementId

Interior

The element's interior, interiors are the mechanism the base game uses to not have the insides of buildings visible in the regular world.

Declaration

public byte Interior { get; set; }

Property Value

Type	Description
byte

IsCallPropagationEnabled

Indicates whether a call on this element will be called on its children a well on clients.

Declaration

public bool IsCallPropagationEnabled { get; set; }

Property Value

Type	Description
bool

Remarks

Note: This only affects clients, Slipe Server does not do call propagation.

IsDestroyed

Indicates whether this element has been destroyed

Declaration

public bool IsDestroyed { get; set; }

Property Value

Type	Description
bool

IsFrozen

Indicates whether the element is frozen, frozen elements are unable to move or be moved.

Declaration

public bool IsFrozen { get; set; }

Property Value

Type	Description
bool

IsSync

Indicates whether the current action originates from the handling of a sync packet

Declaration

public bool IsSync { get; set; }

Property Value

Type	Description
bool

IsVisibleToEveryone

When set to false will not create the element for new players that join, or any players when associated directly with the server

Declaration

public bool IsVisibleToEveryone { get; set; }

Property Value

Type	Description
bool

Name

The element name, for Player's this is the nickname, for other elements it's mostly unused.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Parent

The element's parent as in the element tree.

Declaration

public Element? Parent { get; set; }

Property Value

Type	Description
Element

Position

The element's position

Declaration

public Vector3 Position { get; set; }

Property Value

Type	Description
Vector3

Right

A vector representating the location 1 unit to the right of the element.

Declaration

public Vector3 Right { get; }

Property Value

Type	Description
Vector3

Rotation

The element's rotation, in euler angles

Declaration

public Vector3 Rotation { get; set; }

Property Value

Type	Description
Vector3

Subscribers

Indicates which elements are subscribed to this element

Declaration

public IEnumerable<Player> Subscribers { get; }

Property Value

Type	Description
IEnumerable<Player>

TimeContext

The time sync context, this is a value used to verify whether synchronisation packets are to be applied or ignored.

Declaration

public byte TimeContext { get; }

Property Value

Type	Description
byte

TurnVelocity

The element's turn velocity.

Declaration

public Vector3 TurnVelocity { get; set; }

Property Value

Type	Description
Vector3

Up

A vector representing the location 1 unit above the element.

Declaration

public Vector3 Up { get; }

Property Value

Type	Description
Vector3

UpdateContext

The element's update context, this indicates the source of the current change that is being applied to an element. This is primarily used to verify whether or not the current changes originate from a sync packet.

Declaration

public ElementUpdateContext UpdateContext { get; protected set; }

Property Value

Type	Description
ElementUpdateContext

Velocity

The element's current velocity.

Declaration

public Vector3 Velocity { get; set; }

Property Value

Type	Description
Vector3

Methods

AddChild(Element)

Adds a child in the element tree to this element

Declaration

public void AddChild(Element element)

Parameters

Type	Name	Description
Element	element	The child to add

AddSubscriber(Player)

Adds a subscriber to this element

Declaration

public void AddSubscriber(Player player)

Parameters

Type	Name	Description
Player	player	the subscriber to add to this element

AssociateWith(Player)

Associates an element with a player, causing the element to be created for this player

Declaration

public Element AssociateWith(Player player)

Parameters

Type	Name	Description
Player	player

Returns

Type	Description
Element

AssociateWith(MtaServer)

Associates an element with the server, causing the element to be created for all players on the server

Declaration

public Element AssociateWith(MtaServer server)

Parameters

Type	Name	Description
MtaServer	server	The server to associate the element with

Returns

Type	Description
Element

AttachTo(Element, Vector3?, Vector3?)

Attaches the element to a target element

Declaration

public ElementAttachment AttachTo(Element element, Vector3? positionOffset = null, Vector3? rotationOffset = null)

Parameters

Type	Name	Description
Element	element	Target element to attach to
Vector3?	positionOffset	position offset between the element, and the target element
Vector3?	rotationOffset	rotation offset between the element, and the target element

Returns

Type	Description
ElementAttachment

Exceptions

Type	Condition
Exception	Throws an exception when the target element does not have an ID

CanUpdateSync(byte)

Indicates whether a specific time context is valid to update this element

Declaration

public bool CanUpdateSync(byte remoteContext)

Parameters

Type	Name	Description
byte	remoteContext	The time context to compare

Returns

Type	Description
bool

CreateFor(Player)

Sends packets to create an elementto a set of players Do note that the element will be required to have an id assigned for this to work properly

Declaration

public virtual void CreateFor(Player player)

Parameters

Type	Name	Description
Player	player

CreateFor(IEnumerable<Player>)

Sends packets to create an elementto a set of players Do note that the element will be required to have an id assigned for this to work properly

Declaration

public virtual void CreateFor(IEnumerable<Player> players)

Parameters

Type	Name	Description
IEnumerable<Player>	players

Destroy()

Destroys the element, triggering the Destroyed event.

Declaration

public virtual bool Destroy()

Returns

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

DestroyFor(Player)

Sends packets to destroy an elementto a set of players Do note that the element will be required to have an id assigned for this to work properly

Declaration

public virtual void DestroyFor(Player player)

Parameters

Type	Name	Description
Player	player

DestroyFor(IEnumerable<Player>)

Sends packets to destroy an elementto a set of players Do note that the element will be required to have an id assigned for this to work properly

Declaration

public virtual void DestroyFor(IEnumerable<Player> players)

Parameters

Type	Name	Description
IEnumerable<Player>	players

DetachFrom(Element?)

Detaches the element from a target element

Declaration

public virtual void DetachFrom(Element? element = null)

Parameters

Type	Name	Description
Element	element	Target element to detach from

GetAndIncrementTimeContext()

Returns a new time context, to be used when sync updates sent prior to this moment are meant to be invaldiated.

Declaration

public byte GetAndIncrementTimeContext()

Returns

Type	Description
byte	The new time context

GetData(string, bool)

Gets element data on this element if it exists

Declaration

public LuaValue? GetData(string dataName, bool inherit = false)

Parameters

Type	Name	Description
string	dataName	The key to retrieve the stored value from
bool	inherit	Whether the value should be attempted to be fetched from the element's parent(s) as well

Returns

Type	Description
LuaValue	The value if it exists, null otherwise.

GetPlayersSubcribedToData(string)

Returns all players subscribes to a specific element data key on this element

Declaration

public IEnumerable<Player> GetPlayersSubcribedToData(string key)

Parameters

Type	Name	Description
string	key	The element data key

Returns

Type	Description
IEnumerable<Player>

IsChildOf(Element)

Indicates whether the element is an (indirect) child of another element, this includes grandchildren.

Declaration

public bool IsChildOf(Element element)

Parameters

Type	Name	Description
Element	element	The element to check against

Returns

Type	Description
bool

IsPlayerSubscribedToData(Player, string)

Checks whether a player is subscribes to a specific data key on this element

Declaration

public bool IsPlayerSubscribedToData(Player player, string key)

Parameters

Type	Name	Description
Player	player	The player to check
string	key	The key for the element data to check

Returns

Type	Description
bool

RemoveChild(Element)

Removes a child from this tree in the element tree

Declaration

public void RemoveChild(Element element)

Parameters

Type	Name	Description
Element	element	The child to remove

RemoveFrom(Player)

Removes an element from being associated with the server, causing the elements to no longer be created for all players

Declaration

public void RemoveFrom(Player player)

Parameters

Type	Name	Description
Player	player

RemoveFrom(MtaServer)

Removes an element from being associated with the server, causing the elements to no longer be created for all players

Declaration

public void RemoveFrom(MtaServer server)

Parameters

Type	Name	Description
MtaServer	server

RemoveSubscriber(Player)

Removes a subscriber from this element

Declaration

public void RemoveSubscriber(Player player)

Parameters

Type	Name	Description
Player	player	the subscriber to remove from this element

RunAsSync(Action, bool)

Runs an action with the sync context

Declaration

public void RunAsSync(Action action, bool value = true)

Parameters

Type	Name	Description
Action	action	the action to run
bool	value	Depending whether the context should be sync or not

RunAsSync(Func<Task>, bool)

Runs an asynchronous action with the sync context

Declaration

public Task RunAsSync(Func<Task> action, bool value = true)

Parameters

Type	Name	Description
Func<Task>	action	the action to run
bool	value	Depending whether the context should be sync or not

Returns

Type	Description
Task

RunWithContext(Action, ElementUpdateContext)

Runs an action with a specific context, this context can be fetched using element.UpdateContext

Declaration

public void RunWithContext(Action action, ElementUpdateContext context)

Parameters

Type	Name	Description
Action	action	the action to run
ElementUpdateContext	context	the context to run with

RunWithContext(Func<Task>, ElementUpdateContext)

Runs an asynchronous action with a specific context, this context can be fetched using element.UpdateContext

Declaration

public Task RunWithContext(Func<Task> action, ElementUpdateContext context)

Parameters

Type	Name	Description
Func<Task>	action	the action to run
ElementUpdateContext	context	the context to run with

Returns

Type	Description
Task

SetData(string, LuaValue, DataSyncType)

Sets element data on this element

Declaration

public void SetData(string key, LuaValue value, DataSyncType syncType = DataSyncType.Local)

Parameters

Type	Name	Description
string	key	The key to store the value under
LuaValue	value	The value to store
DataSyncType	syncType	The type of synchronisation to do with this value

SubscribeToData(Player, string)

Subscribes a player to changes to a specific element data value

Declaration

public void SubscribeToData(Player player, string key)

Parameters

Type	Name	Description
Player	player	The player to subscribe
string	key	The key of the data to subscribe to

UnsubscribeFromAllData(Player)

Unsubscribes an element from all element data on this element

Declaration

public void UnsubscribeFromAllData(Player player)

Parameters

Type	Name	Description
Player	player

UnsubscribeFromData(Player, string)

Unsubscribes a player from changes to a specific element data value

Declaration

public void UnsubscribeFromData(Player player, string key)

Parameters

Type	Name	Description
Player	player	The player to unsubscribe
string	key	The key of the data to unsubscribe from

UpdateAssociatedPlayers()

Declaration

protected void UpdateAssociatedPlayers()

Events

AlphaChanged

Declaration

public event ElementChangedEventHandler<byte>? AlphaChanged

Event Type

Type	Description
ElementChangedEventHandler<byte>

AssociatedWith

Declaration

public event ElementEventHandler<Element, ElementAssociatedWithEventArgs>? AssociatedWith

Event Type

Type	Description
ElementEventHandler<Element, ElementAssociatedWithEventArgs>

Attached

Declaration

public event ElementEventHandler<Element, ElementAttachedEventArgs>? Attached

Event Type

Type	Description
ElementEventHandler<Element, ElementAttachedEventArgs>

AttachedOffsetChanged

Declaration

public event ElementEventHandler<Element, ElementAttachOffsetsChangedArgs>? AttachedOffsetChanged

Event Type

Type	Description
ElementEventHandler<Element, ElementAttachOffsetsChangedArgs>

CallPropagationChanged

Declaration

public event ElementChangedEventHandler<bool>? CallPropagationChanged

Event Type

Type	Description
ElementChangedEventHandler<bool>

CollisionEnabledChanged

Declaration

public event ElementChangedEventHandler<bool>? CollisionEnabledChanged

Event Type

Type	Description
ElementChangedEventHandler<bool>

DataChanged

Declaration

public event ElementEventHandler<Element, ElementDataChangedArgs>? DataChanged

Event Type

Type	Description
ElementEventHandler<Element, ElementDataChangedArgs>

Destroyed

Declaration

public event Action<Element>? Destroyed

Event Type

Type	Description
Action<Element>

Detached

Declaration

public event ElementEventHandler<Element, ElementDetachedEventArgs>? Detached

Event Type

Type	Description
ElementEventHandler<Element, ElementDetachedEventArgs>

DimensionChanged

Declaration

public event ElementChangedEventHandler<ushort>? DimensionChanged

Event Type

Type	Description
ElementChangedEventHandler<ushort>

FrozenChanged

Declaration

public event ElementChangedEventHandler<bool>? FrozenChanged

Event Type

Type	Description
ElementChangedEventHandler<bool>

IdChanged

Declaration

public event ElementChangedEventHandler<Element, ElementId>? IdChanged

Event Type

Type	Description
ElementChangedEventHandler<Element, ElementId>

InteriorChanged

Declaration

public event ElementChangedEventHandler<byte>? InteriorChanged

Event Type

Type	Description
ElementChangedEventHandler<byte>

NameChanged

Declaration

public event ElementChangedEventHandler<string>? NameChanged

Event Type

Type	Description
ElementChangedEventHandler<string>

PositionChanged

Declaration

public event ElementChangedEventHandler<Vector3>? PositionChanged

Event Type

Type	Description
ElementChangedEventHandler<Vector3>

RemovedFrom

Declaration

public event ElementEventHandler<Element, ElementAssociatedWithEventArgs>? RemovedFrom

Event Type

Type	Description
ElementEventHandler<Element, ElementAssociatedWithEventArgs>

RotationChanged

Declaration

public event ElementChangedEventHandler<Vector3>? RotationChanged

Event Type

Type	Description
ElementChangedEventHandler<Vector3>

TurnVelocityChanged

Declaration

public event ElementChangedEventHandler<Vector3>? TurnVelocityChanged

Event Type

Type	Description
ElementChangedEventHandler<Vector3>

VelocityChanged

Declaration

public event ElementChangedEventHandler<Vector3>? VelocityChanged

Event Type

Type	Description
ElementChangedEventHandler<Vector3>

Operators

implicit operator LuaValue(Element)

Returns a Lua value for the element, this is used for any lua event communication.

Declaration

public static implicit operator LuaValue(Element value)

Parameters

Type	Name	Description
Element	value

Returns

Type	Description
LuaValue

Extension Methods

ElementPropertyRelayingExtensions.AddRelayers(Element)

ElementPropertyRelayingExtensions.RelayChange(Element, Packet)