🔣 Blueprint

Une classe Blueprint permet de faire apparaître n'importe quel Blueprint Unreal dans nanos world.

Client & Server🔁Auto-Distributed🧑‍💻API Source

👪Inheritance

This class shares methods and events from Base Entity, Base Actor, Base Paintable.

---

tip

Si votre acteur Blueprint a été créé sur le Serveur, il sera automatiquement synchronisé avec les autres joueurs en utilisant le système d'Autorité de Réseau de nanos world ! Il suit les mêmes règles que toutes les autres entités !

🎒 Exemples

Appeler des événements Blueprint depuis Lua

Client/Index.lua

-- Spawns the Blueprint
local blueprint = Blueprint(Vector(), Rotator(), "my-asset-pack::BP_MyBlueprint")

local param1 = 123
local param2 = "hello there!"

-- Calls the event, passing any parameters
blueprint:CallBlueprintEvent("MyBlueprintCustomEvent", param1, param2)

Lier des Event Dispatchers de Blueprint

Client/Index.lua

-- Spawns the Blueprint
local blueprint = Blueprint(Vector(), Rotator(), "my-asset-pack::BP_MyBlueprint")

-- Subscribes to a Blueprint Event Dispatcher
blueprint:BindBlueprintEventDispatcher("MyBlueprintDispatcher", function(self, arg1, arg2)
    Console.Log("Called from Blueprint!", arg1, arg2)
end)

🛠 Constructeurs

Default Constructor

No description provided

local my_blueprint = Blueprint(location, rotation, blueprint_asset, collision_type?)

Parameters

Type	Name	Default	Description
Vector	location	Required parameter	World location to spawn at
Rotator	rotation	Required parameter	World rotation to spawn with
Blueprint Reference	blueprint_asset	Required parameter	The Blueprint asset to spawn
CollisionType	collision_type	CollisionType.Auto	Collision profile of this Actor

🗿 Fonctions statiques

Inherited Entity Static Functions

Blueprint inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

	Returns	Name	Description
	table of Base Entity	GetAll	Returns a table containing all Entities of the class this is called on
	Base Entity	GetByIndex	Returns a specific Entity of this class at an index
	integer	GetCount	Returns how many Entities of this class exist
	table of table	GetInheritedClasses	Gets a list of all directly inherited classes from this Class created with the Inheriting System
	iterator	GetPairs	Returns an iterator with all Entities of this class to be used with pairs()
	table or nil	GetParentClass	Gets the parent class if this Class was created with the Inheriting System
	table	Inherit	Inherits this class with the Inheriting System
	boolean	IsChildOf	Gets if this Class is child of another class if this Class was created with the Inheriting System
	function	Subscribe	Subscribes to an Event for all entities of this Class
	function	SubscribeRemote	Subscribes to a custom event called from server
		Unsubscribe	Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed

This class doesn't have own static functions.

🦠 Fonctions

Inherited Entity Functions

Blueprint inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

	Returns	Name	Description
		BroadcastRemoteEvent	Calls a custom remote event directly on this entity to all Players
		BroadcastRemoteInRadiusEvent	Appelle un événement distant personnalisé directement sur cette entité pour tous les Joueurs dans un rayon donné
		CallRemoteEvent	Calls a custom remote event directly on this entity to a specific Player
		CallRemoteEvent	Calls a custom remote event directly on this entity
		CallRemotePlayersEvent	Appelle un événement distant personnalisé directement sur cette entité pour une liste de Joueurs
		Destroy	Destroys this Entity
		FinishSpawn	Finish the spawning process and send the entity to clients if it was spawned with a deferred spawn_mode
	table of string	GetAllValuesKeys	Gets a list of all values keys
	table	GetClass	Gets the class of this entity
	integer	GetID	Gets the universal network ID of this Entity (same on both client and server)
	any	GetValue	Gets a Value stored on this Entity at the given key
	boolean	HasAuthority	Gets if the local context has authority over this Entity (true if spawned by the client, false if spawned by the server)
	boolean	IsA	Recursively checks if this entity is inherited from a Class
	boolean	IsBeingDestroyed	Returns true if this Entity is being destroyed
	boolean	IsSpawned	Gets if this Entity finished spawning
	boolean	IsValid	Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
		SetSpawnMode	Overrides when this Entity finishes spawning, from the Constructor of an Inherited Class
		SetValue	Sets a Value in this Entity
	function	Subscribe	Subscribes to an Event on this specific entity
	function	SubscribeRemote	Subscribes to a custom event called from server on this specific entity
		Unsubscribe	Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed

Inherited Actor Functions

Blueprint inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/actor

	Returns	Name	Description
		AddActorTag	Adds an Unreal Actor Tag to this Actor
		AddAngularImpulse	Add an angular impulse to this Actor. Good for one time instant burst
		AddImpulse	Add an impulse to this Actor. Good for one time instant burst
	boolean	AttachTo	Attache cet acteur à tout autre acteur, éventuellement à un os spécifique
		Detach	Détache cet Acteur à partir de AttachedTo Actor
	table of string	GetActorTags	Gets all Unreal Actor Tags on this Actor
	Vector	GetAngularForce	Gets this Actor's angular force (set by SetAngularForce())
	float	GetAngularVelocity	Renvoie la vitesse angulaire de cet Acteur
	table of Base Actor	GetAttachedEntities	Gets all Actors attached to this Actor
	Base Actor or nil	GetAttachedTo	Gets the Actor this Actor is attached to
	string	GetAttachedToSocket	Récupère le nom du bone ou du socket auquel l'acteur concerné est attaché
	table	GetBounds	Obtient les limites englobantes de l'acteur concerné, utile pour connaître sa taille dans le monde
	CollisionType	GetCollision	Gets this Actor's collision type
	integer	GetDimension	Gets this Actor's dimension
	float	GetDistanceFromCamera	Gets the distance of this Actor from the Camera
	Vector	GetForce	Gets this Actor's force (set by SetForce())
	float	GetLifeSpan	Définit le temps (en secondes) avant que l'acteur concerné soit détruit
	Vector	GetLocation	Gets this Actor's location in the game world
	float	GetMass	Renvoie la masse de cet Acteur
	Player or nil	GetNetworkAuthority	Gets this Actor's Network Authority Player
	Vector	GetRelativeLocation	Gets this Actor's Relative Location if it's attached
	Rotator	GetRelativeRotation	Gets this Actor's Relative Rotation if it's attached
	Rotator	GetRotation	Gets this Actor's angle in the game world
	Vector	GetScale	Gets this Actor's scale
	float	GetScreenPercentage	Gets the percentage of this Actor size in the screen
	table	GetSocketTransform	Gets a Socket Transform in world space given a bone or socket name
	Vector	GetVelocity	Gets this Actor's current velocity
	boolean	HasNetworkAuthority	Returns true if the local Player is currently the Network Authority of this Actor
	boolean	IsGravityEnabled	Returns true if gravity is enabled on this Actor
	boolean	IsImpulseOnDamage	Renvoie true si les dégâts subis exercent une poussée sur le corps physique de l'acteur concerné
	boolean	IsInWater	Returns true if this Actor is in water
	boolean	IsNetworkDistributed	Returns true if this Actor is currently network distributed
	boolean	IsVisible	Returns true if this Actor is visible
		RemoveActorTag	Removes an Unreal Actor Tag from this Actor
		ResetVelocity	Resets this Actor's linear and angular velocities to zero
		RotateRelativeTo	Fait pivoter progressivement l'acteur attaché jusqu’à un angle relatif à son parent, sur une durée définie
		RotateTo	Smoothly rotates this actor to an angle over a certain time
		SetAngularForce	Adds a permanent angular force to this Actor, set to Vector(0, 0, 0) to cancel
		SetCastShadow	Sets this Actor's to cast shadows or not
		SetCollision	Sets this Actor's collision type
		SetDimension	Définit la dimension de l'acteur concerné. Les acteurs ne peuvent voir et interagir qu’avec les entités appartenant à la même dimension
		SetDistanceOptimizationMultiplier	Définit le multiplicateur d'optimisation de distance de cet Acteur
		SetForce	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
		SetGravityEnabled	Sets whether gravity is enabled on this Actor
		SetHighlightEnabled	Sets whether the highlight is enabled on this Actor, and which highlight index to use
		SetImpulseOnDamage	Définit si les dégâts subis (tirs, attaques au corps à corps, explosions) provoquent une poussée sur le corps physique de cet acteur
		SetLifeSpan	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
		SetLocation	Sets this Actor's location in the game world
		SetNetworkAuthority	Sets the Player to have network authority over this Actor
		SetNetworkAuthorityAutoDistributed	Sets if this Actor will auto distribute the network authority between players
		SetOutlineEnabled	Définit si le contour est activé sur cet acteur et quel index de contour utiliser
		SetRelativeLocation	Sets this Actor's relative location in local space (only if this actor is attached)
		SetRelativeRotation	Sets this Actor's relative rotation in local space (only if this actor is attached)
		SetRenderCullDistance	Sets this Actor's render cull distance
		SetRotation	Sets this Actor's rotation in the game world
		SetScale	Sets this Actor's scale
		SetVisibility	Sets whether the actor is visible or not
		TranslateRelativeTo	Fait bouger progressivement l'acteur attaché jusqu’à une position relatif à son parent, sur une durée définie
		TranslateTo	Smoothly moves this actor to a location over a certain time
	boolean	WasRecentlyRendered	Gets if this Actor was recently rendered on screen

Inherited Paintable Functions

Blueprint inherits from Base Paintable Class, sharing it's methods and functions:
Base Paintablescripting-reference/classes/base-classes/paintable

	Returns	Name	Description
	Color	GetMaterialColorParameter	Gets a Color parameter from this Actor's material
	float	GetMaterialScalarParameter	Gets a Scalar parameter from this Actor's material
	string	GetMaterialTextureParameter	Gets a Texture parameter from this Actor's material
	Vector	GetMaterialVectorParameter	Gets a Vector parameter from this Actor's material
		ResetMaterial	Resets the material from the specified index to the original one
		SetMaterial	Sets the material at the specified index of this Actor
		SetMaterialColorParameter	Sets a Color parameter in this Actor's material
		SetMaterialFromCanvas	Définit le matériau à l'index spécifié de cet acteur sur un objet Canvas
		SetMaterialFromSceneCapture	Sets the material at the specified index of this Actor to a SceneCapture object
		SetMaterialFromWebUI	Sets the material at the specified index of this Actor to a WebUI object
		SetMaterialScalarParameter	Définit un paramètre "Scalar" sur le matériau de cet acteur
		SetMaterialTextureParameter	Sets a texture parameter in this Actor's material to an image
		SetMaterialVectorParameter	Définit un paramètre "Vector" sur le matériau de cet acteur
		SetPhysicalMaterial	Overrides this Actor's Physical Material with a new one

	Returns	Name	Description
	function	BindBlueprintEventDispatcher	Assigns and Binds a Blueprint Event Dispatcher
	varargs of any	CallBlueprintEvent	Calls a Blueprint Event or Function
	any	GetBlueprintPropertyValue	Gets a Blueprint Property/Variable value
		SetBlueprintPropertyValue	Sets a Blueprint Property/Variable value directly
		UnbindBlueprintEventDispatcher	Unbinds a Blueprint Event Dispatcher

---

Slow

BindBlueprintEventDispatcher

Assigns and Binds a Blueprint Event Dispatcher

local ret = my_blueprint:BindBlueprintEventDispatcher(dispatcher_name, callback)

Parameters

Type	Parameter	Default	Description
string	dispatcher_name	Required parameter	Event Dispatcher name
function	callback	Required parameter	Callback function to call with this format

Returns

Type	Description
function	le callback lui-même

---

Slow

CallBlueprintEvent

Calls a Blueprint Event or Function.

Returns all Function return values on Client Side

local ret_01, ret_02, ... = my_blueprint:CallBlueprintEvent(event_name, arguments...?)

Parameters

Type	Parameter	Default	Description
string	event_name	Required parameter	Nom de l'événement ou de la fonction
any	arguments...?	nil	Sequence of arguments to pass to the event

Returns

Type	Description
varargs of any	the function return values

---

Slow

GetBlueprintPropertyValue

Gets a Blueprint Property/Variable value

local value = my_blueprint:GetBlueprintPropertyValue(property_name)

Parameters

Type	Parameter	Default	Description
string	property_name	Required parameter	Name of the Blueprint variable

Returns

Type	Description
any	La valeur

See also SetBlueprintPropertyValue.

---

Slow

SetBlueprintPropertyValue

Sets a Blueprint Property/Variable value directly

my_blueprint:SetBlueprintPropertyValue(property_name, value)

Parameters

Type	Parameter	Default	Description
string	property_name	Required parameter	Name of the Blueprint variable
any	value	Required parameter	La valeur à définir

See also GetBlueprintPropertyValue.

---

Moderate

UnbindBlueprintEventDispatcher

Unbinds a Blueprint Event Dispatcher

my_blueprint:UnbindBlueprintEventDispatcher(dispatcher_name, callback?)

Parameters

Type	Parameter	Default	Description
string	dispatcher_name	Required parameter	Event Dispatcher name
function	callback?	nil	Optional callback to unbind

🚀 Événements

Inherited Entity Events

Blueprint inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/entity

	Name	Description
	ClassRegister	Triggered when a new Class is registered with the Inheriting System
	Destroy	Triggered when an Entity is destroyed
	Spawn	Triggered when an Entity is spawned/created
	ValueChange	Triggered when an Entity has a value changed with :SetValue()

Inherited Actor Events

Blueprint inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	DimensionChange	Déclenché lorsqu'un Actor change de dimension
	EnterWater	Déclenché lorsqu’un acteur entre dans une étendue d’eau
	LeaveWater	Déclenché lorsqu’un acteur quitte une étendue d’eau
	NetworkAuthorityChange	Déclenché lorsqu'un Acteur modifie son autorité sur le réseau
	NetworkAuthorityChange	Déclenché lorsque le joueur local gagne/perd l'autorité du réseau sur cet Acteur

This class doesn't have own events.

✅ Liste des types de paramètres pris en charge

Liste de tous les types de paramètres qui peuvent passer entre Lua ↔ Blueprint :

Type Lua	Type Blueprint	Lua → BP	BP → Lua
boolean	Boolean	✅	✅
number	Byte	✅	✅
number	Integer	✅	✅
number	Integer64	✅	✅
number	Float	✅	✅
number	Enum	✅	✅
string	String	✅	✅
string	Name	✅	✅
string	Text	✅	✅
Vector2D	Vector2D	✅	✅
Vector	Vector	✅	✅
Rotator	Rotator	✅	✅
Color	Color	✅	✅
Color	LinearColor	✅	✅
StaticMesh	StaticMeshActor	✅	✅
Prop	StaticMeshActor	✅	✅
Weapon	SkeletalMeshActor	✅	✅
Base Vehicle	WheeledVehiclePawn	✅	✅
Grenade	StaticMeshActor	✅	✅
Melee	StaticMeshActor	✅	✅
Light	PointLight, SpotLight ou RectLight	✅	✅
Decal	DecalActor	✅	✅
TextRender	TextRenderActor	✅	✅
Text3D	Text3DActor	✅	✅
Sound	AmbientSound	✅	✅
Canvas	MaterialInstanceDynamic	✅	❌
WebUI	MaterialInstanceDynamic	✅	❌
SceneCapture	MaterialInstanceDynamic	✅	❌
Blueprint	Actor	✅	✅
Widget	Widget	✅	❌
Base Actor	Actor	✅	✅
Player	PlayerController	✅	❌
Image Path	Texture2D	✅	❌
string	Class	✅	❌
steam-avatar://	MaterialInstanceDynamic	✅	❌
table	CurveFloat	✅	❌
table	Transform	✅	✅
table	SlateBrush	✅	✅
table	SlateFontInfo	✅	✅
table	Any Struct	✅	✅

Remarque

On ne peut passer des Actors de Blueprint → Lua que si l'Actor est une entité apparue (Spawned Entity). Il n'est pas possible de passer à Lua des Actors fraîchement apparus dans des Blueprints.

tip

Les Maps, Arrays et Sets peuvent aussi être passés ! Tant que leurs clés/valeurs font partie de la liste ci-dessus.

N'importe quelle struct

Les structs personnalisées peuvent aussi être passées et récupérées : il suffit de passer un objet avec les mêmes propriétés que la struct Unreal, par exemple :

FTransform

{
	["Translation"] = Vector(),
	["Rotation"] = Rotator(),
	["Scale"] = Vector()
}

FSlateBrush

{
	["DrawAs"] = 0, -- ESlateBrushDrawType
	["Tiling"] = 0, -- ESlateBrushTileType
	["Mirroring"] = 0, -- ESlateBrushMirrorType
	["ImageSize"] = Vector2D(),
	["Tint"] = Color(),
	["Image"] = "package://sandbox/Client/my_image.jpg", -- Special Path, or Canvas, WebUI, SceneCapture
	["Margin"] = {}, -- FMargin
	["OutlineSettings"] = {} -- FSlateBrushOutlineSettings
}

FSlateFontInfo

{
	["FontFamily"] = "package://my-package/Client/my_font.ttf", -- Special Path
	["FontMaterial"] = "my-asset-pack::M_MyMaterial", -- Material Path
	["OutlineSettings"] = {}, -- FSlateBrushOutlineSettings
	["Typeface"] = "", -- string
	["Size"] = 24,
	["LetterSpacing"] = 0,
	["SkewAmount"] = 0.0,
	["Monospacing"] = false,
	["MonospacedWidth"] = 1.0
}

FMargin

{
	["Bottom"] = 0.0,
	["Left"] = 0.0,
	["Right"] = 0.0,
	["Top"] = 0.0
}

FVector4

{
	["W"] = 0.0,
	["X"] = 0.0,
	["Y"] = 0.0,
	["Z"] = 0.0
}

UCurveFloat

{
	[0.0] = 0.0,
	[0.25] = 0.8,
	[0.5] = 1.0,
	[0.75] = 0.3,
	[1.0] = 0.0,
}