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
| To | Kind | API |
|---|---|---|
| Make your character the player that Logic moves, teleports and freezes | slot | IRaptorLocalPlayer, RaptorLocalPlayers |
| Run Logic on your own host | slot | RaptorLogicHosts |
| Connect your Use input, weapon hits and break effects | helper | RaptorLogicLocalHost |
| Check which Logic entries need a module the project may not have | helper | LogicModules |
| Set the player the Player Reference represents | registry | IRaptorPlayerProfile, RaptorPlayerProfiles |
| Take over the Play button in some scenes | registry | IRaptorPlaytestProvider, RaptorPlaytest |
Walk-through: Your own character.
Your module's place in the project
| To | Kind | API |
|---|---|---|
| Show a row on Settings → Modules | registry | RaptorModules, RaptorModule, RaptorModuleKind |
| Find an optional package without referencing it | helper | RaptorDeps |
| Locate your module's files and data folders | registry | RaptorPaths |
| Store per-user choices | helper | RaptorPrefs |
| Store project-wide values, with a section in Project Settings | registry | RaptorProjectSettings, RaptorSettingsSection |
| Change project settings only after the user approves it | registry | RaptorProjectChanges, RaptorProjectChange |
| Credit a third-party part you ship | registry | RaptorCredits, RaptorCredit |
| Set the wordmark font, version and edition labels | slot | RaptorBrand |
The window
| To | Kind | API |
|---|---|---|
| Read RAPTOR's state and run its actions | helper | RaptorSuiteApi |
| Add a panel | registry | RaptorSuiteRegistry, RaptorSuitePanelDescriptor, RaptorSuitePanel |
| Show a dialog inside RAPTOR | base class | RaptorSuiteModuleDialog |
| Add a button to a panel's header or the top bar | slot | RaptorSuitePaneHeaderSlots, RaptorSuiteTopBarSlots |
| Open a window outside RAPTOR from a RAPTOR button | registry | RaptorSuiteBrowsers |
| Show a short message at the bottom of the window | helper | RaptorSuiteToast |
Tools and menus
| To | Kind | API |
|---|---|---|
| Add a tool to the toolbar | registry | RaptorSuiteExternalTools, RaptorSuiteExternalTool |
| Let your tool take every click in the 3D view | registry | RaptorSuiteExclusivePick |
| Add Inspector rows | registry | RaptorSuiteInspectorBlocks, RaptorSuiteInspectorBlock |
| Draw Inspector rows in RAPTOR's style | helper | RaptorPropertiesUI, RaptorStepRule |
| Add rows to the Model menu or the selection's right-click menu | registry | RaptorSuiteModelMenuItems, RaptorSuiteSelectionMenu |
| Add a row to a view's menu, or a view switch | registry | RaptorSuiteDisplayMenuItems, RaptorSuiteViewToggles |
| Add a switch to Settings | registry | RaptorSuiteSettingsSwitches |
| List your hotkeys on Settings → Hotkeys | registry | RaptorSuiteShortcutRows, RaptorSuiteShortcutRow |
| Handle edit commands such as Delete and Paste before RAPTOR does | registry | RaptorSuiteCommandHooks |
| Leave an object's edits to its owner, or hand project components to a project tool | registry | RaptorSuitePropertyEdits |
The 3D view and scene objects
| To | Kind | API |
|---|---|---|
| Draw in the 3D view | registry | RaptorSuiteViewportOverlays |
| Draw a label in RAPTOR's style | helper | RaptorSuiteViewTags |
| Pick what is under the mouse the way RAPTOR does | helper | RaptorSuitePicking |
| Add a new kind of scene object, with picking, framing, Hierarchy rows, moving and copying | registry | RaptorSuiteGizmoTargets |
| Draw a box with RAPTOR's three-click gesture | helper | RaptorSuiteBoxDraw |
| Decide where a new object goes | helper | RaptorModelTargets, RaptorGameplayContainers |
| Add a rule for dropping rows in the Hierarchy | registry | RaptorSuiteHierarchyDrag |
| Keep the Player Reference visible | registry | RaptorSuitePlayerReference |
Walk-through: Tool extension points.
Blocks
| To | Kind | API |
|---|---|---|
| Change how a Block is built | registry | IRaptorBlockModifier, RaptorBlockModifiers, RaptorBlockDisplay |
| Edit Blocks as one undo step | helper | RaptorBlockEdits |
| Read a Block's mesh and the current selection | helper | RaptorMeshQueries |
| Store settings on a Block | data | RaptorBlockModifierData, RaptorMesh |
Walk-through: Block extension points.
Models
| To | Kind | API |
|---|---|---|
| Save, load and rename models through another storage system | slot | RaptorModelStorageSlots, RaptorModelStore |
| Respond to model lifecycle events with your module's data | registry | RaptorModelLifecycle |
| Add a switch to a model's Output rows | registry | RaptorModelOptions, RaptorModelOption |
| Choose where a new model goes, and which names it can take | registry | RaptorModelPlacement, RaptorModelNameReservers |
| Name copies made with Duplicate as variant | registry | RaptorModelVariantNamers, IRaptorModelVariantNamer |
| Make a nested model a separate bake unit or a moving part | interface | IRaptorModelBoundary, IRaptorMovingPart, RaptorMovingParts |
Walk-through: Model storage.
Materials and hotspots
| To | Kind | API |
|---|---|---|
| Add material packs from code | registry | RaptorLibrary, IRaptorPackProvider, RaptorPackEntry |
| Add behaviour to the Materials drawer | registry | RaptorMaterialsDrawer, IRaptorDockExtension |
| Read and change hotspot fits | helper | RaptorHotspotApi, RaptorHotspotLocks |
| Pick the shader a generated material gets | registry | RaptorShaderProfile |
| Read RAPTOR's baked light volume in a custom shader | contract | Shader API |
Lighting and rendering
| To | Kind | API |
|---|---|---|
| Add a light type the Lights tool can place | registry | IRaptorLightBackend, RaptorLightBackends |
| Add a baker for Render → Bake lighting | registry | IRaptorBakeBackend, RaptorBakeBackends |
| Hook a custom lighting pipeline into bakes | slot | RaptorBakeHooks |
| Add a light to the Ray-traced preview | registry | IRaptorRtLightSource, RaptorRtLightSources |
| Add a post effect switch to the Ray-traced preview | registry | RaptorRtPostToggles |
Props and entities
| To | Kind | API |
|---|---|---|
| Fill the Props drawer from your catalogue, or add placement modes | slot | RaptorPropTool, RaptorPropMode |
| Add a body option, such as Breakable | registry | RaptorEntityBodyProviders, RaptorEntityBodyProvider |
| Add behaviour to liquid volumes | slot | RaptorLiquidTool |
Drawing your tool
To match the rest of RAPTOR, use the controls, theme and icons in the UI kit.