NightOut-Gaming Roleplay

NightOut-Gaming

Contents

• Blip
  • Color
  • Name
  • Scale
  • ShortRange
  • Sprite
  • Delete()
• BlipStreamer
  • CreateDynamicBlip(name,color,scale,shortRange,spriteId,position,dimension,range)
  • CreateStaticBlip(name,color,scale,shortRange,spriteId,position,dimension,range)
  • DestroyBlip(blip)
• Characters
  • SetCharacterFastFarm(charId,isFastFarm,fastFarmTime)
• DropShadow
• HelpText
  • Text
  • Delete()
• HelpTextStreamer
  • Create(text)
  • DeleteAllHelpText()
  • DeleteHelpText(dynamicTextLabelId)
  • DeleteHelpText(dynamicTextLabel)
  • GetAllHelpText()
  • GetHelpText(dynamicTextLabelId)
• Marker
  • BobUpDown
  • Color
  • Direction
  • DrawOnEnter
  • FaceCamera
  • MarkerType
  • Rotate
  • Rotation
  • Scale
  • TextureDict
  • TextureName
  • Destroy()
• MarkerStreamer
  • Create(markerType,position,scale,rotation,direction,color,bobUpDown,faceCamera,rotate,textureDict,textureName,drawOnEnter,dimension,streamRange)
  • Delete(dynamicMarkerId)
  • Delete(marker)
  • DestroyAllDynamicMarkers()
  • GetAllDynamicMarkers()
  • GetMarker(dynamicMarkerId)
• MarkerTypes
• Ped
  • Model
• PedStreamer
  • Create()
• PlayerLabel
  • Center
  • Color
  • DropShadow
  • Edge
  • Font
  • Proportional
  • Scale
  • Text
  • Delete()
• Prop
  • Dynamic
  • Freeze
  • LightColor
  • LodDistance
  • Model
  • OnFire
  • Rotation
  • TextureVariation
  • Visible
• PropStreamer
  • Create(model,position,rotation,dimension,isDynamic,frozen,lodDistance,lightColor,onFire,textureVariation,visible,streamRange)
  • DestroyAllDynamicObjects()
  • GetAllProp()
  • GetClosestDynamicObject(pos)
• TextLabelStreamer
  • Create(text,position,dimension,center,color,scale,dropShadow,edge,font,proportional,streamRange)
  • DestroyAllDynamicTextLabels()
  • DestroyDynamicTextLabel(dynamicTextLabelId)
  • DestroyDynamicTextLabel(dynamicTextLabel)
  • GetAllDynamicTextLabels()
  • GetDynamicTextLabel(dynamicTextLabelId)
• VirtualAPI
  • RunThreadSafe(function)

Blip type

Namespace

Altv_Roleplay.EntityStreamer

Summary

Blip class that stores all data related to a single blip.

Color property

Summary

Blip Color code, can also be found on the ALTV wiki

Name property

Summary

The text to display on the blip in the map menu

Scale property

Summary

Scale of the blip, 1 is regular size.

ShortRange property

Summary

Whether this blip can be seen on the minimap from anywhere on the map, or only when close to it(it will always show on the main map).

Sprite property

Summary

ID of the sprite to use, can be found on the ALTV wiki

Delete() method

Summary

Destroy this blip.

Parameters

This method has no parameters.

BlipStreamer type

Namespace

Altv_Roleplay.EntityStreamer

CreateDynamicBlip(name,color,scale,shortRange,spriteId,position,dimension,range) method

Summary

Create Dynamic Blip.

Returns

Parameters

Name	Type	Description
name	System.String
color	System.Int32
scale	System.Single
shortRange	System.Boolean
spriteId	System.Int32
position	System.Numerics.Vector3
dimension	System.Int32
range	System.UInt32

CreateStaticBlip(name,color,scale,shortRange,spriteId,position,dimension,range) method

Summary

Create static blip without any range limit

Returns

Parameters

Name	Type	Description
name	System.String
color	System.Int32
scale	System.Single
shortRange	System.Boolean
spriteId	System.Int32
position	System.Numerics.Vector3
dimension	System.Int32
range	System.UInt32

DestroyBlip(blip) method

Summary

Destroy a dynamic blip

Parameters

Name	Type	Description
blip	Altv_Roleplay.EntityStreamer.Blip	The blip to destroy

Characters type

Namespace

Altv_Roleplay.Model

SetCharacterFastFarm(charId,isFastFarm,fastFarmTime) method

Summary

Setzt Character für eine bestimmbare Zeit auf doppelte Aufsammelmenge

Parameters

Name	Type	Description
charId	System.Int32
isFastFarm	System.Boolean
fastFarmTime	System.Int32

DropShadow type

Namespace

Altv_Roleplay.EntityStreamer

Summary

Class to hold drop shadow data.

HelpText type

Namespace

Altv_Roleplay.EntityStreamer

Summary

HelpText class that stores all data

Text property

Summary

Set/get the HelpText text.

Delete() method

Summary

Destroy this textlabel.

Parameters

This method has no parameters.

HelpTextStreamer type

Namespace

Altv_Roleplay.EntityStreamer

Create(text) method

Summary

Create a new HelpText.

Returns

The newly created dynamic textlabel.

Parameters

Name	Type	Description
text	System.String	The text to be displayed.

DeleteAllHelpText() method

Summary

Destroy all HelpText.

Parameters

This method has no parameters.

DeleteHelpText(dynamicTextLabelId) method

Summary

Destroy HelpText by it's ID.

Returns

True if successful, false otherwise.

Parameters

Name	Type	Description
dynamicTextLabelId	System.UInt64	The ID of the text label.

DeleteHelpText(dynamicTextLabel) method

Summary

Destroy an HelpText.

Parameters

Name	Type	Description
dynamicTextLabel	Altv_Roleplay.EntityStreamer.HelpText	The text label instance to destroy.

GetAllHelpText() method

Summary

Get all HelpText.

Returns

A list of dynamic textlabels.

Parameters

This method has no parameters.

GetHelpText(dynamicTextLabelId) method

Summary

Get a HelpText by it's ID.

Returns

The dynamic textlabel or null if not found.

Parameters

Name	Type	Description
dynamicTextLabelId	System.UInt64	The ID of the textlabel.

Marker type

Namespace

Altv_Roleplay.EntityStreamer

Summary

DynamicMarker class that stores all data related to a single marker.

BobUpDown property

Summary

Whether the marker should bob up and down.

Color property

Summary

Set marker color.

Direction property

Summary

Represents a heading on each axis in which the marker should face, alternatively you can rotate each axis independently with Rotation and set Direction axis to 0.

DrawOnEnter property

Summary

Whether the marker should be drawn onto the entity when they enter it.

FaceCamera property

Summary

Whether the marker should rotate on the Y axis towards the player's camera.

MarkerType property

Summary

Set or get the current marker's type(see MarkerTypes enum).

Rotate property

Summary

Whether the marker should rotate on the Y axis(heading).

Rotation property

Summary

Set or get the current marker's rotation (in degrees).

Scale property

Summary

Set scale of the marker.

TextureDict property

Summary

Set a texture dictionary, pass null to remove.

TextureName property

Summary

Texture name, only applicable if TextureDict is set. pass null to reset value.

Destroy() method

Summary

Destroy this marker.

Parameters

This method has no parameters.

MarkerStreamer type

Namespace

Altv_Roleplay.EntityStreamer

Create(markerType,position,scale,rotation,direction,color,bobUpDown,faceCamera,rotate,textureDict,textureName,drawOnEnter,dimension,streamRange) method

Summary

Create a new dynamic marker

Returns

Parameters

Name	Type	Description
markerType	Altv_Roleplay.EntityStreamer.MarkerTypes	The type of marker to spawn.
position	System.Numerics.Vector3	The position at which the marker should spawn at.
scale	System.Numerics.Vector3	The scale of the marker.
rotation	System.Nullable{System.Numerics.Vector3}	The rotation of the marker.
direction	System.Nullable{System.Numerics.Vector3}	The direction of the marker.
color	System.Nullable{AltV.Net.Data.Rgba}	The color of the marker.
bobUpDown	System.Int32	Whether the marker should bob up and down.
faceCamera	System.Nullable{System.Boolean}	Whether the marker should face the entity's camera.
rotate	System.Nullable{System.Boolean}	Whether the marker should rotate on the Y axis only.
textureDict	System.Nullable{System.Boolean}	An optional texture dictionary to apply to the marker.
textureName	System.String	An optional texture name to apply to the marker.
drawOnEnter	System.String	Whether it should draw the marker onto an entity that intersects with it.
dimension	System.Nullable{System.Boolean}	The dimension of the marker
streamRange	System.UInt32	Stream distance of the marker, default is 100.

Delete(dynamicMarkerId) method

Summary

Destroy a dynamic marker by it's ID.

Returns

True if successful, false otherwise.

Parameters

Name	Type	Description
dynamicMarkerId	System.UInt64	The ID of the marker.

Delete(marker) method

Summary

Destroy a dynamic marker.

Parameters

Name	Type	Description
marker	Altv_Roleplay.EntityStreamer.Marker	The marker instance to destroy.

DestroyAllDynamicMarkers() method

Summary

Destroy all created dynamic markers.

Parameters

This method has no parameters.

GetAllDynamicMarkers() method

Summary

Get all created dynamic markers.

Returns

A list of dynamic markers.

Parameters

This method has no parameters.

GetMarker(dynamicMarkerId) method

Summary

Get a dynamic marker by it's ID.

Returns

The dynamic marker or null if not found.

Parameters

Name	Type	Description
dynamicMarkerId	System.UInt64	The ID of the marker.

MarkerTypes type

Namespace

Altv_Roleplay.EntityStreamer

Summary

Marker types.

Ped type

Namespace

Altv_Roleplay.EntityStreamer

Model property

Summary

Set or get the current ped model.

PedStreamer type

Namespace

Altv_Roleplay.EntityStreamer

Create() method

Summary

Create Ped

Parameters

This method has no parameters.

PlayerLabel type

Namespace

Altv_Roleplay.EntityStreamer

Summary

DynamicTextLabel class that stores all data related to a single textlabel

Center property

Summary

Set/get textlabel center, if true the textlabel will be centered.

Color property

Summary

Set/get textlabel's color.

DropShadow property

Summary

Set/get textlabel's drop shadow.

Edge property

Summary

Set/get textlabel's edge color.

Font property

Summary

Set/get textlabel's font type.

Proportional property

Summary

Set/get textlabel proportional.

Scale property

Summary

Set/get or get the current textlabel's scale.

Text property

Summary

Set/get the textlabel's text.

Delete() method

Summary

Destroy this textlabel.

Parameters

This method has no parameters.

Prop type

Namespace

Altv_Roleplay.EntityStreamer

Summary

DynamicObject class that stores all data related to a single object

Dynamic property

Summary

Get or set the object's dynamic state. Some objects can be moved around by the player when dynamic is set to true.

Freeze property

Summary

Freeze an object into it's current position. or get it's status

LightColor property

Summary

Set the light color of the object, use null to reset it to default.

LodDistance property

Summary

Set or get LOD Distance of the object.

Model property

Summary

Set or get the current object's model.

OnFire property

Summary

Set/get an object on fire, NOTE: does not work very well as of right now, fire is very small.

Rotation property

Summary

Set or get the current object's rotation (in degrees).

TextureVariation property

Summary

Get or set the current texture variation, use null to reset it to default.

Visible property

Summary

Set/get visibility state of object

PropStreamer type

Namespace

Altv_Roleplay.EntityStreamer

Create(model,position,rotation,dimension,isDynamic,frozen,lodDistance,lightColor,onFire,textureVariation,visible,streamRange) method

Summary

Create a new dynamic object.

Returns

The newly created dynamic object.

Parameters

Name	Type	Description
model	System.String	The object model name.
position	System.Numerics.Vector3	The position to spawn the object at.
rotation	System.Numerics.Vector3	The rotation to spawn the object at(degrees).
dimension	System.Int32	The dimension to spawn the object in.
isDynamic	System.Nullable{System.Boolean}	(Optional): Set object dynamic or not.
frozen	System.Nullable{System.Boolean}	(Optional): Set object frozen.
lodDistance	System.Nullable{System.Boolean}	(Optional): Set LOD distance.
lightColor	System.Nullable{System.UInt32}	(Optional): set light color.
onFire	Altv_Roleplay.EntityStreamer.Rgb	(Optional): set object on fire(DOESN'T WORK PROPERLY YET!)
textureVariation	System.Nullable{System.Boolean}	(Optional): Set object texture variation.
visible	System.Nullable{Altv_Roleplay.EntityStreamer.TextureVariation}	(Optional): Set object visibility.
streamRange	System.Nullable{System.Boolean}	(Optional): The range that a player has to be in before the object spawns, default value is 400.

DestroyAllDynamicObjects() method

Summary

Destroy all created dynamic objects.

Parameters

This method has no parameters.

GetAllProp() method

Summary

Get all created dynamic objects.

Returns

A list of dynamic objects.

Parameters

This method has no parameters.

GetClosestDynamicObject(pos) method

Summary

Get the dynamic object that's closest to a specified position.

Returns

The closest dynamic object to the specified position, or null if none found.

Parameters

Name	Type	Description
pos	System.Numerics.Vector3	The position from which to check.

TextLabelStreamer type

Namespace

Altv_Roleplay.EntityStreamer

Create(text,position,dimension,center,color,scale,dropShadow,edge,font,proportional,streamRange) method

Summary

Create a new dynamic textlabel.

Returns

The newly created dynamic textlabel.

Parameters

Name	Type	Description
text	System.String	The text to be displayed.
position	System.Numerics.Vector3	The position to spawn it at.
dimension	System.Int32	The dimension to spawn it in.
center	System.Nullable{System.Boolean}	Center the textlabel.
color	System.Nullable{AltV.Net.Data.Rgba}	The color of the textlabel.
scale	System.Nullable{System.Single}	The scale of the textlabel.
dropShadow	Altv_Roleplay.EntityStreamer.DropShadow	The drop shadow of the textlabel.
edge	System.Nullable{AltV.Net.Data.Rgba}	The edge color of the textlabel.
font	System.Nullable{System.Int32}	The font type of the textlabel.
proportional	System.Nullable{System.Boolean}	Whether to set textlabel proportional.
streamRange	System.UInt32	Stream range, default is 30.

DestroyAllDynamicTextLabels() method

Summary

Destroy all created dynamic textlabels.

Parameters

This method has no parameters.

DestroyDynamicTextLabel(dynamicTextLabelId) method

Summary

Destroy a dynamic text label by it's ID.

Returns

True if successful, false otherwise.

Parameters

Name	Type	Description
dynamicTextLabelId	System.UInt64	The ID of the text label.

DestroyDynamicTextLabel(dynamicTextLabel) method

Summary

Destroy a dynamic text label.

Parameters

Name	Type	Description
dynamicTextLabel	Altv_Roleplay.EntityStreamer.PlayerLabel	The text label instance to destroy.

GetAllDynamicTextLabels() method

Summary

Get all created dynamic textlabels.

Returns

A list of dynamic textlabels.

Parameters

This method has no parameters.

GetDynamicTextLabel(dynamicTextLabelId) method

Summary

Get a dynamic text label by it's ID.

Returns

The dynamic textlabel or null if not found.

Parameters

Name	Type	Description
dynamicTextLabelId	System.UInt64	The ID of the textlabel.

VirtualAPI type

Namespace

Global.mGlobal

RunThreadSafe(function) method

Summary

Permet d'effectuer un appel API 100% Thread-Safe via le taskmanager interne de alt:V

Parameters

Name	Type	Description
function	System.Action

Built With

• C#
• JavaScript
• TypeScript
• HTML
• CSS
• SCSS

Links

• Alt:V Wiki
• Alt:V Natives