Skip to main content
Version: bleeding-edge 🩸

📽️ SceneCapture

Scene Capture is an Actor which captures a fully dynamic image of the scene into a Texture. It captures the scene from its view frustum, stores that view as an image, which is then used within a Material.


💂Authority
This class can only be spawned on 🟧 Client side.
👪Inheritance
This class shares methods and events from Base Entity, Base Actor.
🧑‍💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

🎒 Examples

Client/Index.lua
local scene_capture = SceneCapture(
Vector(0, 0, 200),
Rotator(-15, 0, 0),
256,
256,
0,
5000,
100
)

-- Paints the Prop with the SceneCapture output
local my_prop = Prop(Vector(200, 200, 100), Rotator(), "nanos-world::SM_Cube")
my_prop:SetMaterialFromSceneCapture(scene_capture)
Client/Index.lua
local scene_capture = SceneCapture(
Vector(0, 0, 200),
Rotator(-15, 0, 0),
256,
256,
0,
5000,
100
)

-- Make a SceneCapture to only render a specific actor
local my_prop = Prop(Vector(200, 200, 100), Rotator(), "nanos-world::SM_Cube")
scene_capture:AddRenderActor(my_prop)
scene_capture:SetShowFlag("Atmosphere", false)
tip

You can use the output Texture from a SceneCapture with :SetMaterialFromSceneCapture() method!

🛠 Constructors

Default Constructor

local my_scenecapture = SceneCapture(location?, rotation?, width?, height?, render_rate?, view_distance?, fov_angle?, enable_distance_optimization?)
TypeNameDefaultDescription
VectorlocationVector(0, 0, 0)Location
RotatorrotationRotator(0, 0, 0)Rotation
integerwidth128Width of the generated Texture (max is 4096)
integerheight128Height of the generated Texture (max is 4096)
floatrender_rate0.033Render Rate (how frequent is the capture)
floatview_distance5000Maximum distance of capturing
floatfov_angle90FOV
booleanenable_distance_optimizationtrueReduces the rendering frequency if the entities with this Material are too far or not visible. Disable it to always render at the render_rate
note

Scene Captures capture a scene in real time, this means every tick it will re-render the scene from scratch. Please consider reducing the width/height and even the render_rate to improve it's performance.

We've worked hard to make SceneCapture as performatic as possible! Some techniques were applied for optimization and reducing the render_rate automatically when you are far and when the generated texture is out of the screen.

🗿 Static Functions

Inherited Entity Static Functions
SceneCapture inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/Entity
ReturnsNameDescription
table of Base EntityGetAllReturns a table containing all Entities of the class this is called on
Base EntityGetByIndexReturns a specific Entity of this class at an index
integerGetCountReturns how many Entities of this class exist
table of tableGetInheritedClassesGets a list of all directly inherited classes from this Class created with the Inheriting System
iteratorGetPairsReturns an iterator with all Entities of this class to be used with pairs()
table or nilGetParentClassGets the parent class if this Class was created with the Inheriting System
tableInheritInherits this class with the Inheriting System
booleanIsChildOfGets if this Class is child of another class if this Class was created with the Inheriting System
functionSubscribeSubscribes to an Event for all entities of this Class
functionSubscribeRemoteSubscribes to a custom event called from server
UnsubscribeUnsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed
This class doesn't have own static functions.

🦠 Functions

Inherited Entity Functions
SceneCapture inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/Entity
ReturnsNameDescription
BroadcastRemoteEventCalls a custom remote event directly on this entity to all Players
CallRemoteEventCalls a custom remote event directly on this entity to a specific Player
CallRemoteEventCalls a custom remote event directly on this entity
DestroyDestroys this Entity
table of stringGetAllValuesKeysGets a list of all values keys
tableGetClassGets the class of this entity
integerGetIDGets the universal network ID of this Entity (same on both client and server)
anyGetValueGets a Value stored on this Entity at the given key
booleanIsARecursively checks if this entity is inherited from a Class
booleanIsValidReturns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
SetValueSets a Value in this Entity
functionSubscribeSubscribes to an Event on this specific entity
functionSubscribeRemoteSubscribes to a custom event called from server on this specific entity
UnsubscribeUnsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed
Inherited Actor Functions
SceneCapture inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/Actor
ReturnsNameDescription
AddActorTagAdds an Unreal Actor Tag to this Actor
AddImpulseApplies a force in world world to this Actor
AttachToAttaches this Actor to any other Actor, optionally at a specific bone
DetachDetaches this Actor from AttachedTo Actor
table of stringGetActorTagsGets all Unreal Actor Tags on this Actor
table of Base ActorGetAttachedEntitiesGets all Actors attached to this Actor
Base Actor or nilGetAttachedToGets the Actor this Actor is attached to
tableGetBoundsGets this Actor's bounds
CollisionTypeGetCollisionGets this Actor's collision type
integerGetDimensionGets this Actor's dimension
floatGetDistanceFromCameraGets the distance of this Actor from the Camera
VectorGetForceGets this Actor's force (set by SetForce())
VectorGetLocationGets this Actor's location in the game world
Player or nilGetNetworkAuthorityGets this Actor's Network Authority Player
VectorGetRelativeLocationGets this Actor's Relative Location if it's attached
RotatorGetRelativeRotationGets this Actor's Relative Rotation if it's attached
RotatorGetRotationGets this Actor's angle in the game world
VectorGetScaleGets this Actor's scale
floatGetScreenPercentageGets the percentage of this Actor size in the screen
VectorGetVelocityGets this Actor's current velocity
booleanHasAuthorityGets if this Actor was spawned by the client side
booleanHasNetworkAuthorityReturns true if the local Player is currently the Network Authority of this Actor
booleanIsBeingDestroyedReturns true if this Actor is being destroyed
booleanIsGravityEnabledReturns true if gravity is enabled on this Actor
booleanIsInWaterReturns true if this Actor is in water
booleanIsNetworkDistributedReturns true if this Actor is currently network distributed
booleanIsVisibleReturns true if this Actor is visible
RemoveActorTagRemoves an Unreal Actor Tag from this Actor
RotateToSmoothly rotates this actor to an angle over a certain time
SetCollisionSets this Actor's collision type
SetDimensionSets this Actor's Dimension
SetForceAdds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
SetGravityEnabledSets whether gravity is enabled on this Actor
SetHighlightEnabledSets whether the highlight is enabled on this Actor, and which highlight index to use
SetLifeSpanSets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
SetLocationSets this Actor's location in the game world
SetNetworkAuthoritySets the Player to have network authority over this Actor
SetNetworkAuthorityAutoDistributedSets if this Actor will auto distribute the network authority between players
SetOutlineEnabledSets whether the outline is enabled on this Actor, and which outline index to use
SetRelativeLocationSets this Actor's relative location in local space (only if this actor is attached)
SetRelativeRotationSets this Actor's relative rotation in local space (only if this actor is attached)
SetRotationSets this Actor's rotation in the game world
SetScaleSets this Actor's scale
SetVisibilitySets whether the actor is visible or not
TranslateToSmoothly moves this actor to a location over a certain time
booleanWasRecentlyRenderedGets if this Actor was recently rendered on screen
ReturnsNameDescription
AddRenderActorAdds an Actor to the Render Only list
ClearRenderActorsClears the Render Only list
stringEncodeToBase64Takes a snapshot of the SceneCapture and returns a Base64 of it
EncodeToBase64AsyncTakes a snapshot of the SceneCapture and returns a Base64 of it (asynchronously)
RemoveRenderActorRemoves an Actor from the Render Only list
ResizeChange the output Texture size Note: too high texture will make the capture slower and will affect game performance
SetDistanceOptimizationEnabledEnables or not the rendering frequency optimization if the entities with this Material are too far
SetFOVAngleSets the FOV
SetFreezeStops or Restore Capturing
SetRenderRateSet how frequent is the capture Note: Setting to 0 will make it capture every frame
SetShowFlagEnables/Disables rendering features from being captured

AddRenderActor

Adds an Actor to the Render Only list

Note: adding one actor to this will make the SceneCapture only to render those Actors.

my_scenecapture:AddRenderActor(actor)
TypeParameterDefaultDescription
Base Actoractor Required parameter No description provided

See also RemoveRenderActor, ClearRenderActors.


ClearRenderActors

Clears the Render Only list

my_scenecapture:ClearRenderActors()

See also AddRenderActor, RemoveRenderActor.


EncodeToBase64

Takes a snapshot of the SceneCapture and returns a Base64 of it

— Returns string.

local ret = my_scenecapture:EncodeToBase64(image_format?)
TypeParameterDefaultDescription
ImageFormatimage_format?ImageFormat.JPEGWhich format to generate - JPEG is fastest but discards Alpha channel

See also EncodeToBase64Async.


EncodeToBase64Async

Takes a snapshot of the SceneCapture and returns a Base64 of it (asynchronously)

my_scenecapture:EncodeToBase64Async(image_format?, callback)
TypeParameterDefaultDescription
ImageFormatimage_format?ImageFormat.JPEGWhich format to generate - JPEG is fastest but discards Alpha channel
functioncallback Required parameter Callback with this format

See also EncodeToBase64.


RemoveRenderActor

Removes an Actor from the Render Only list

my_scenecapture:RemoveRenderActor(actor)
TypeParameterDefaultDescription
Base Actoractor Required parameter No description provided

See also AddRenderActor, ClearRenderActors.


Resize

Change the output Texture size Note: too high texture will make the capture slower and will affect game performance

my_scenecapture:Resize(width, height)
TypeParameterDefaultDescription
integerwidth Required parameter No description provided
integerheight Required parameter No description provided

SetDistanceOptimizationEnabled

Enables or not the rendering frequency optimization if the entities with this Material are too far

my_scenecapture:SetDistanceOptimizationEnabled(enabled)
TypeParameterDefaultDescription
booleanenabled Required parameter No description provided

SetFOVAngle

Sets the FOV

my_scenecapture:SetFOVAngle(angle)
TypeParameterDefaultDescription
floatangle Required parameter No description provided

SetFreeze

Stops or Restore Capturing

my_scenecapture:SetFreeze(freeze)
TypeParameterDefaultDescription
booleanfreeze Required parameter No description provided

SetRenderRate

Set how frequent is the capture Note: Setting to 0 will make it capture every frame

my_scenecapture:SetRenderRate(render_rate)
TypeParameterDefaultDescription
floatrender_rate Required parameter No description provided

SetShowFlag

Enables/Disables rendering features from being captured
A complete list of available flags can be found in the Official Unreal Documentation

my_scenecapture:SetShowFlag(flag, enable)
TypeParameterDefaultDescription
stringflag Required parameter No description provided
booleanenable Required parameter No description provided

🚀 Events

Inherited Entity Events
SceneCapture inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/Entity
NameDescription
ClassRegisterTriggered when a new Class is registered with the Inheriting System
DestroyTriggered when an Entity is destroyed
SpawnTriggered when an Entity is spawned/created
ValueChangeTriggered when an Entity has a value changed with :SetValue()
Inherited Actor Events
SceneCapture inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/Actor
NameDescription
DimensionChangeTriggered when an Actor changes it's dimension
NameDescription
CaptureTriggered when this SceneCapture does an update/renders a frame

Capture

Triggered when this SceneCapture does an update/renders a frame
SceneCapture.Subscribe("Capture", function(self)
-- Capture was called
end)
TypeArgumentDescription
SceneCaptureselfNo description provided