BptBackground

API reference for BptBackground — parameters, event callbacks, and related configuration.

Home / Documentation / BptBackground
Images & Animation

BptBackground

Open demo →

Parameters

NameTypeFlagsDescription
ChildContentRenderFragmentNullable
StyleBptBackgroundStyle
Animatedbool
Speeddouble
Scaledouble
Intensitydouble
Seedint
BackgroundColorstring
ColorsList<string>
Rendererstring
Targetstring
ImageSrcstringNullable
ImageBehaviorBptBackgroundImageBehavior
ParallaxSpeeddouble
FollowSelectorstringNullable
ConfigstringNullable

Event callbacks

NameTypeFlagsDescription
OnRendererChangedEventCallback<string>
OnConfigChangedEventCallback<string>

Related configuration

BptBackgroundConfig
Property Type Description
Style string
Animated bool
Speed double
Scale double
Intensity double
Seed int
BackgroundColor string
Colors List<string>
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please reload the page.