Get RAPTOR

Extension points

Every place your code can plug into RAPTOR, grouped by task.

An extension point is where RAPTOR accepts code from a module. Most are registries, which hold every entry registered with them. Some are slots, which hold one handler; the last one set wins. A few are helpers that your code calls.

Register from an [InitializeOnLoad] static constructor. See Writing a module.

Play and Logic

ToKindAPI
Make your character the player that Logic moves, teleports and freezesslotIRaptorLocalPlayer, RaptorLocalPlayers
Run Logic on your own hostslotRaptorLogicHosts
Connect your Use input, weapon hits and break effectshelperRaptorLogicLocalHost
Check which Logic entries need a module the project may not havehelperLogicModules
Set the player the Player Reference representsregistryIRaptorPlayerProfile, RaptorPlayerProfiles
Take over the Play button in some scenesregistryIRaptorPlaytestProvider, RaptorPlaytest

Walk-through: Your own character.

Your module's place in the project

ToKindAPI
Show a row on Settings → ModulesregistryRaptorModules, RaptorModule, RaptorModuleKind
Find an optional package without referencing ithelperRaptorDeps
Locate your module's files and data foldersregistryRaptorPaths
Store per-user choiceshelperRaptorPrefs
Store project-wide values, with a section in Project SettingsregistryRaptorProjectSettings, RaptorSettingsSection
Change project settings only after the user approves itregistryRaptorProjectChanges, RaptorProjectChange
Credit a third-party part you shipregistryRaptorCredits, RaptorCredit
Set the wordmark font, version and edition labelsslotRaptorBrand

The window

ToKindAPI
Read RAPTOR's state and run its actionshelperRaptorSuiteApi
Add a panelregistryRaptorSuiteRegistry, RaptorSuitePanelDescriptor, RaptorSuitePanel
Show a dialog inside RAPTORbase classRaptorSuiteModuleDialog
Add a button to a panel's header or the top barslotRaptorSuitePaneHeaderSlots, RaptorSuiteTopBarSlots
Open a window outside RAPTOR from a RAPTOR buttonregistryRaptorSuiteBrowsers
Show a short message at the bottom of the windowhelperRaptorSuiteToast

Tools and menus

ToKindAPI
Add a tool to the toolbarregistryRaptorSuiteExternalTools, RaptorSuiteExternalTool
Let your tool take every click in the 3D viewregistryRaptorSuiteExclusivePick
Add Inspector rowsregistryRaptorSuiteInspectorBlocks, RaptorSuiteInspectorBlock
Draw Inspector rows in RAPTOR's stylehelperRaptorPropertiesUI, RaptorStepRule
Add rows to the Model menu or the selection's right-click menuregistryRaptorSuiteModelMenuItems, RaptorSuiteSelectionMenu
Add a row to a view's menu, or a view switchregistryRaptorSuiteDisplayMenuItems, RaptorSuiteViewToggles
Add a switch to SettingsregistryRaptorSuiteSettingsSwitches
List your hotkeys on Settings → HotkeysregistryRaptorSuiteShortcutRows, RaptorSuiteShortcutRow
Handle edit commands such as Delete and Paste before RAPTOR doesregistryRaptorSuiteCommandHooks
Leave an object's edits to its owner, or hand project components to a project toolregistryRaptorSuitePropertyEdits

The 3D view and scene objects

ToKindAPI
Draw in the 3D viewregistryRaptorSuiteViewportOverlays
Draw a label in RAPTOR's stylehelperRaptorSuiteViewTags
Pick what is under the mouse the way RAPTOR doeshelperRaptorSuitePicking
Add a new kind of scene object, with picking, framing, Hierarchy rows, moving and copyingregistryRaptorSuiteGizmoTargets
Draw a box with RAPTOR's three-click gesturehelperRaptorSuiteBoxDraw
Decide where a new object goeshelperRaptorModelTargets, RaptorGameplayContainers
Add a rule for dropping rows in the HierarchyregistryRaptorSuiteHierarchyDrag
Keep the Player Reference visibleregistryRaptorSuitePlayerReference

Walk-through: Tool extension points.

Blocks

ToKindAPI
Change how a Block is builtregistryIRaptorBlockModifier, RaptorBlockModifiers, RaptorBlockDisplay
Edit Blocks as one undo stephelperRaptorBlockEdits
Read a Block's mesh and the current selectionhelperRaptorMeshQueries
Store settings on a BlockdataRaptorBlockModifierData, RaptorMesh

Walk-through: Block extension points.

Models

ToKindAPI
Save, load and rename models through another storage systemslotRaptorModelStorageSlots, RaptorModelStore
Respond to model lifecycle events with your module's dataregistryRaptorModelLifecycle
Add a switch to a model's Output rowsregistryRaptorModelOptions, RaptorModelOption
Choose where a new model goes, and which names it can takeregistryRaptorModelPlacement, RaptorModelNameReservers
Name copies made with Duplicate as variantregistryRaptorModelVariantNamers, IRaptorModelVariantNamer
Make a nested model a separate bake unit or a moving partinterfaceIRaptorModelBoundary, IRaptorMovingPart, RaptorMovingParts

Walk-through: Model storage.

Materials and hotspots

ToKindAPI
Add material packs from coderegistryRaptorLibrary, IRaptorPackProvider, RaptorPackEntry
Add behaviour to the Materials drawerregistryRaptorMaterialsDrawer, IRaptorDockExtension
Read and change hotspot fitshelperRaptorHotspotApi, RaptorHotspotLocks
Pick the shader a generated material getsregistryRaptorShaderProfile
Read RAPTOR's baked light volume in a custom shadercontractShader API

Lighting and rendering

ToKindAPI
Add a light type the Lights tool can placeregistryIRaptorLightBackend, RaptorLightBackends
Add a baker for Render → Bake lightingregistryIRaptorBakeBackend, RaptorBakeBackends
Hook a custom lighting pipeline into bakesslotRaptorBakeHooks
Add a light to the Ray-traced previewregistryIRaptorRtLightSource, RaptorRtLightSources
Add a post effect switch to the Ray-traced previewregistryRaptorRtPostToggles

Props and entities

ToKindAPI
Fill the Props drawer from your catalogue, or add placement modesslotRaptorPropTool, RaptorPropMode
Add a body option, such as BreakableregistryRaptorEntityBodyProviders, RaptorEntityBodyProvider
Add behaviour to liquid volumesslotRaptorLiquidTool

Drawing your tool

To match the rest of RAPTOR, use the controls, theme and icons in the UI kit.