🔣 Blueprint
A Blueprint Class allows spawning any Unreal Blueprint Actor in nanos world.
info
🟦🟧 Authority: This class can be spawned on both Client and Server (if you spawn it on client, it won't be synchronized with other players).
⏬ Inheritance: This class inherits from Base Actor and Base Paintable.
Usage
Index.lua
local my_blueprint = Blueprint(
Vector(200, 200, 200), -- location
Rotator(0, 0, 0), -- rotation
"nanos-world::BP_AwesomeDoor" -- blueprint
)
tip
If your Actor Blueprint was spawned on the Server, it will be automatically synchronized with other players using the nanos world Network Authority system! It follows the same rules as all other entities!
note
Currently it is only possible to communicate in one-way with the Blueprint (Scripting -> Blueprint). We didn't find a way to have the inverse communication hopefully yet.
Constructor Parameters
| Type | Name | Default | Description |
|---|---|---|---|
| Vector | location | Vector(0, 0, 0) | |
| Rotator | rotation | Rotator(0, 0, 0) | |
| Blueprint Reference | blueprint_path | `` |
Functions
Inherited Actor Functions
| Returns | Name | Description | |
|---|---|---|---|
 | AddImpulse | Applies a Force in world space to this Actor | |
| AttachTo | Attaches this Actor to another Actor | |
| Destroy | Destroys this Actor | |
| Detach | Detaches this Actor if attached | |
| SetCollision | Sets this Actor's collision type | |
| SetForce | Adds a permanent force to this Actor | |
| SetGravityEnabled | Sets whether gravity is enabled on this Actor | |
 | SetVisibility | Sets the Actor visibility | |
 | SetHighlightEnabled | Sets whether the highlight is enabled on this Actor, and which highlight index to use | |
| SetOutlineEnabled | Sets whether the outline is enabled on this Actor, and which outline index to use | |
| SetLifeSpan | Sets the time (in seconds) before this Actor is destroyed | |
| SetLocation | Sets this Actor's location in the game world | |
 | SetNetworkAuthority | Sets the Player this Actor will have its physics calculated on Network Authority | |
| SetRelativeLocation | Sets this Actor's relative location in local space | |
| SetRelativeRotation | Sets this Actor's relative rotation in local space | |
| SetRotation | Sets this Actor's rotation in the game world | |
| SetScale | Sets this Actor's scale | |
| SetValue | Sets a value in this Actor, which can be accessed by any package | |
| TranslateTo | Smoothly moves this Actor to the specified location | |
| RotateTo | Smoothly rotates this Actor to the specified angle | |
| boolean | HasNetworkAuthority | Gets if the LocalPlayer is currently the Network Authority of this Actor |
| boolean | HasAuthority | Gets if this Actor was spawned by the client side |
| boolean | IsBeingDestroyed | Gets if this Actor is being destroyed |
| boolean | IsGravityEnabled | Gets whether gravity is enabled on this Actor |
| boolean | IsVisible | Gets whether this actor is Visible or not |
| boolean | IsInWater | Gets if this Actor is in water |
| boolean | IsNetworkDistributed | Gets if this Actor is currently Network Distributed |
| boolean | IsValid | Returns if this Actor is valid (i.e. not destroyed) |
| table | GetAttachedEntities | Gets all Actors attached to this Actor |
| any | GetAttachedTo | Gets the Actor this Actor is attached to |
| table | GetBounds | Gets this Actor's bounds |
| number | GetCollision | Gets this Actor's collision type |
| number | GetID | Gets the universal network ID of this Actor |
| Vector | GetLocation | Gets this Actor's location in the game world |
| Rotator | GetRotation | Gets this Actor's angle in the game world |
| Vector | GetForce | Gets this Actor's scale |
| Vector | GetScale | Gets this Actor's scale |
| string | GetType | Gets the type of this Actor |
| any | GetValue | Gets a value stored on this Actor at the given key |
| Vector | GetVelocity | Returns this Actor's current velocity |
| string | AddActorTag | Adds an Unreal Actor Tag to this Actor |
| string | RemoveActorTag | Remove an Unreal Actor Tag from this Actor |
| table | GetActorTags | Gets all Unreal Actor Tags from this Actor |
| function | Subscribe | Subscribes to an Event |
| Unsubscribe | Unsubscribes from an Event |
Inherited Paintable Functions
| Returns | Name | Description | |
|---|---|---|---|
| SetMaterial | Sets the material at the specified index of this Actor | |
| SetMaterialFromWebUI | Sets the material at the specified index of this Actor to a WebUI object | |
| SetMaterialFromSceneCapture | Sets the material at the specified index of this Actor to a SceneCapture object | |
| ResetMaterial | Resets the material from the specified index to the original one | |
| SetMaterialColorParameter | Sets a Color parameter in this Actor’s material | |
| SetMaterialScalarParameter | Sets a scalar parameter in this Actor’s material | |
| SetMaterialTextureParameter | Sets a texture parameter in this Actor's material to an image on disk | |
| SetMaterialVectorParameter | Sets a Vector parameter in this Actor’s material | |
| SetPhysicalMaterial | Overrides this Actor's Physical Material with a new one |
| Returns | Name | Description |
|---|---|---|
CallBlueprintEvent | Calls a Blueprint Event or Function |
CallBlueprintEvent
Calls a Blueprint Event or Function
my_blueprint:CallBlueprintEvent(event_name, parameters...)
| Type | Parameter | Default Value | Description |
|---|---|---|---|
| string | event_name | Event or Function name | |
| any | parameters... | nil | Sequence of parameters to call |