PlushEngine type index#

API home · Gameplay guides

All public types a script may use: PlushEngine, which every script imports, and the area namespaces (PlushEngine.Physics, .Physics2D, .Animation, .Audio, .Effects, .Matter, .Navigation), each needing its using line. Pages are filed by area under types/: Gameplay, Rendering, Physics, Navigation, 2D, Animation, Audio, Effects, Matter. Start with the API home for the gameplay entry points. Members inherited from a base type are documented on that type. Record constructor parameters also declare public properties; compiler-generated record equality, deconstruction and printing members are omitted.

Gameplay#

types/gameplay/ · 87 types

Type	Kind	Namespace
Achievements	class
AssemblyBlueprint	record
AssemblyInput	record
AssemblyInputTarget	record
AssemblyReference	record struct
AvailableBox	record
Calc	class
Canvas	class
CanvasMode	enum
CollisionLayerReference	record struct
ContentSource	enum
CoroutineHandle	class
CoroutineState	enum
DataBlock	class
DataCatalog	class
DataRecord	record
DataReference	record struct
Ease	enum
EventSubscription	class
FixedStepSimulation	class
GameKey	enum
GameSaves	class
GameSceneHost	class
GameSession	class
Gamepad	class
GamepadAxis	enum
InputActions	class
LibraryItem	record
Lifetime	class
LoadedBox	record
Log	class
LogEntry	record
LogLevel	enum
Mat3	struct
Midi	class
MidiNoteEvent	record struct
Projectile	class
RangeAttribute	class
RuntimeCollection	class
RuntimeCollectionDefinition	record
RuntimeEntity	class
RuntimeScene	class
RuntimeSceneBuilder	class
RuntimeScriptProperties	class
RuntimeScriptProperty	record
RuntimeWorld	record
SaveReadResult	record
SaveReadStatus	enum
SaveResult	record
SceneAssetReference	record struct
SceneBoxes	class
SceneCoroutines	class
SceneEntityDefinition	record
SceneEvents	class
SceneHierarchyNode	record
SceneLibrary	class
SceneReference	record struct
SceneResidency	class
SceneSpace	class
SceneTimers	class
SceneTunnel	record
SceneTunnelCrossing	record struct
SceneTunnelTraveller	class
SceneTunnelView	class
SceneUse	class
SceneUses	class
Script	class
ScriptDefinition	record
ScriptFault	record
ScriptQuery	struct
ScriptQuery.Enumerator	struct
SpaceConnection	class
SpaceTrace	record struct
SpaceTraveller	class
SpriteBorder	record struct
SpritePixels	record
Stats	class
TextureUsage	record struct
TimeClock	enum
TimerHandle	class
Tweens	class
Viewer	class
ViewerCamera	class
ViewerEyes	class
ViewerGaze	class
ViewerTarget	enum
Wait	struct

Rendering#

types/rendering/ · 37 types

Type	Kind	Namespace
CameraView	record struct
Decal	record
DecalMode	enum
DirectionalLight	record
EditorOverlay3D	class
EnvironmentMap	class
EnvironmentSettings	record
FogSettings	record
FontResource	record
Frustum	struct
Graphics	class
GraphicsSettings	class
InstanceKey	record struct
LocalLight	record
MapChannel	enum
Material	record
MeshAsset	class
MeshInstancing	class
OrganicMotion	enum
OrganicPattern	enum
PerspectiveCamera	record
PostProcessPass	enum
PostProcessPipeline	class
PostProcessSettings	record
ProceduralSkySettings	record
RadianceHdr	class
ReflectionProbe	record
Shader	record
ShaderParameter	record
ShaderParameterKind	enum
ShaderRenderMode	enum
SphericalHarmonics	class
SurfaceDomain	enum
SurfaceModel	record
SurfaceSound	enum
TextDescription	record
Transform	record

Physics#

types/physics/ · 20 types

Type	Kind	Namespace
CharacterController	class	`PlushEngine.Physics`
CollisionLayerInfo	record	`PlushEngine.Physics`
CollisionLayers	record	`PlushEngine.Physics`
Connection	class	`PlushEngine.Physics`
Contact	record struct	`PlushEngine.Physics`
JointDescription	record	`PlushEngine.Physics`
JointKind	enum	`PlushEngine.Physics`
PhysicsBodyDescription	record	`PlushEngine.Physics`
PhysicsMaterial	record	`PlushEngine.Physics`
PhysicsMotion	enum	`PlushEngine.Physics`
PhysicsPose	record struct	`PlushEngine.Physics`
PhysicsShape	record struct	`PlushEngine.Physics`
PhysicsShapeKind	enum	`PlushEngine.Physics`
Ragdoll	class	`PlushEngine.Physics`
RagdollRig	enum	`PlushEngine.Physics`
RaycastHit	record struct	`PlushEngine.Physics`
Rope	class	`PlushEngine.Physics`
RopeChain	class	`PlushEngine.Physics`
RopeLine	class	`PlushEngine.Physics`
Vehicle	class	`PlushEngine.Physics`

types/navigation/ · 7 types

Type	Kind	Namespace
NavigationAgent	class	`PlushEngine.Navigation`
NavigationAgentState	enum	`PlushEngine.Navigation`
NavigationMeshData	record	`PlushEngine.Navigation`
NavigationPath	record	`PlushEngine.Navigation`
NavigationPathStatus	enum	`PlushEngine.Navigation`
NavigationProfile	record	`PlushEngine.Navigation`
SceneNavigation	class	`PlushEngine.Navigation`

2D#

types/2d/ · 29 types

Type	Kind	Namespace
AnimationBlend2D	record	`PlushEngine.Animation`
AnimationBlendSample2D	record	`PlushEngine.Animation`
AnimationBlendSpace2D	class	`PlushEngine.Animation`
BodyType2D	enum	`PlushEngine.Physics2D`
Bounds2D	record struct	`PlushEngine.Physics2D`
Camera2D	class
CameraFit2D	enum
CameraFrame2D	record struct
CameraMode2D	enum
ClipRect2D	record struct
ColliderDescription2D	record
ColliderHit2D	record struct	`PlushEngine.Physics2D`
Collision2D	class	`PlushEngine.Physics2D`
CollisionWorld2D	class	`PlushEngine.Physics2D`
Contact2D	record struct	`PlushEngine.Physics2D`
Layer2D	record struct
Layout2D	record
MaskRect2D	record
Motion2D	class	`PlushEngine.Physics2D`
MotionResponse2D	enum	`PlushEngine.Physics2D`
PhysicsSettings2D	class	`PlushEngine.Physics2D`
PhysicsWorld2D	class	`PlushEngine.Physics2D`
PrimitiveGeometry2D	class	`PlushEngine.Physics2D`
RenderDescription2D	record
RigidBody2D	class	`PlushEngine.Physics2D`
Style2D	record
SweepHit2D	record struct	`PlushEngine.Physics2D`
Transform2D	record struct
WheelJoint2D	class	`PlushEngine.Physics2D`

Animation#

types/animation/ · 23 types

Type	Kind	Namespace
AnimationBinding	record
AnimationBlend1D	record	`PlushEngine.Animation`
AnimationBlendSample	record	`PlushEngine.Animation`
AnimationBlendWeights	record struct	`PlushEngine.Animation`
AnimationBoneMask	record	`PlushEngine.Animation`
AnimationClipInfo	record	`PlushEngine.Animation`
AnimationClipReference	record struct
AnimationLayerDefinition	record	`PlushEngine.Animation`
AnimationMaskEntry	record	`PlushEngine.Animation`
AnimationNodeInfo	record	`PlushEngine.Animation`
AnimationPlayback	class	`PlushEngine.Animation`
AnimationPoseSampler	class	`PlushEngine.Animation`
AnimationSocket	record	`PlushEngine.Animation`
AnimationStateDefinition	record
GarmentSimulation	class	`PlushEngine.Animation`
MotionClipRange	record	`PlushEngine.Animation`
MotionDefinition	record	`PlushEngine.Animation`
MotionProfile	record	`PlushEngine.Animation`
MotionWarp	class	`PlushEngine.Animation`
MotionWarpPose	record struct	`PlushEngine.Animation`
NamedAnimationBlend1D	record
SkeletalAnimation	class	`PlushEngine.Animation`
SkinnedMeshPart	record	`PlushEngine.Animation`

Audio#

types/audio/ · 27 types

Type	Kind	Namespace
AhdsrModulator	record	`PlushEngine.Audio`
AudioEffect	record	`PlushEngine.Audio`
AudioEmitterUse	record
DelayEffect	record	`PlushEngine.Audio`
EffectChain	class	`PlushEngine.Audio`
FilterEffect	record	`PlushEngine.Audio`
FilterMode	enum	`PlushEngine.Audio`
GainerEffect	record	`PlushEngine.Audio`
MixerEffects	record	`PlushEngine.Audio`
ModulationChain	class	`PlushEngine.Audio`
ModulationTarget	enum	`PlushEngine.Audio`
Modulator	record	`PlushEngine.Audio`
Note	struct
ReverbEffect	record	`PlushEngine.Audio`
SequenceCell	record struct	`PlushEngine.Audio`
SequencePattern	class	`PlushEngine.Audio`
SequencePlayback	class	`PlushEngine.Audio`
SequenceReference	record struct
SequenceTrack	class	`PlushEngine.Audio`
SoundAsset	class
SoundGroup	enum
SoundReference	record struct
SoundRolloff	enum	`PlushEngine.Audio`
SoundSequence	class	`PlushEngine.Audio`
SoundSettings	record
SoundVoice	class
SoundZone	record

Effects#

types/effects/ · 12 types

Type	Kind	Namespace
Blackbody	class	`PlushEngine.Effects`
EffectAsset	record
EffectElement	record
EffectModel	record	`PlushEngine.Effects`
EffectOccurrence	class
EffectParameter	record	`PlushEngine.Effects`
EffectParameterKind	enum	`PlushEngine.Effects`
EffectReference	record struct
EffectUse	record
Noise3D	class
SceneEffects	class
SplatMath	class	`PlushEngine.Effects`

Matter#

types/matter/ · 14 types

Type	Kind	Namespace
MatterBake	record	`PlushEngine.Matter`
MatterBakeCache	class	`PlushEngine.Matter`
MatterBuild	record	`PlushEngine.Matter`
MatterConstruction	enum	`PlushEngine.Matter`
MatterDamage	class	`PlushEngine.Matter`
MatterDust	class	`PlushEngine.Matter`
MatterFracture	class	`PlushEngine.Matter`
MatterFractureEvent	record	`PlushEngine.Matter`
MatterFracturePattern	enum	`PlushEngine.Matter`
MatterImpact	record struct	`PlushEngine.Matter`
MatterMobility	enum	`PlushEngine.Matter`
MatterRepresentation	enum	`PlushEngine.Matter`
MatterResponseProfile	record	`PlushEngine.Matter`
MatterStructure	class	`PlushEngine.Matter`