S&box Wiki
Home
/
Edit Custom ModelDoc nodes
View
Edit
History
No Category
Developer Overview
The Project System
Publishing To Asset Party
Getting Started With Hammer
Mapping Basics
Mapping Entities
Advanced Mapping Techniques
Getting Started with Modeldoc
Animgraph & Animation
Physics
Modeldoc Nodes
Advanced Modelling
UI Basics
Styles & Stylesheets
Razor Templates
Game Menus
Materials
Built In Shaders
Shaders
Shader Reference
Sounds & Audio
Particles
Getting Started
Making Games
Input
Networking
Physics
Rendering
Editor & Tools
VR
Misc
Playing Guides
Console Commands & Variables
Dedicated Server
Log in to edit
Custom ModelDoc nodes
<cat>Model.Nodes</cat><title>Custom ModelDoc nodes</title> This page describes how you can create custom ModelDoc nodes. This is useful for any gamemode-specific data you may want to attach to specific models. There are currently 2 types of custom ModelDoc nodes you can create: Generic Game Data and Break Commands. # Generic Game Data Generic Game Data nodes are just that - a node that can carry arbitrary data on the model and then retrieved in code when needed. Here's the process for registering and using a custom game data node: 1. Define a struct or class. Add the `ModelDoc.GameData` attribute. ``` /// <summary> /// Spawn a particle when the model is used on an entity. Support for this depends on the entity. /// </summary> [ModelDoc.GameData( "particle", AllowMultiple = true )] public class ModelParticle { [DisplayName( "Particle" ), ResourceType( "vpcf") ] public string Name { get; set; } [JsonPropertyName( "attachment_point" ), FGDType( "model_attachment" )] public string AttachmentPoint { get; set; } [JsonPropertyName( "attachment_type" )] public ParticleAttachment AttachmentType { get; set; } = ParticleAttachment.AttachmentFollow; [JsonPropertyName( "attachment_offset" )] public Vector3 AttachmentOffset { get; set; } } ``` 2. Let the gamemode (re)compile. This will make the new nodes appear in ModelDoc. 3. Assign the node in ModelDoc to the `GameDataList` parent node, or use the node wizard if the node is not present. If you wish to know more, you can read <page text="this guide on importing a model">Importing_a_new_model</page>. <upload src="70c/8dac70f747e77f7.png" size="12354" name="image.png" /> 4. Compile the model. 5. Now you can use this data in code like so. ``` // Get the custom data on the a model. Will return null if it not present on the model ModelParticle[] modelParticles = Model.GetData<ModelParticle[]>(); // Or like so if ( Model.TryGetData( out ModelParticle[] modelParticles ) { // Data exists on this model, use it.. } ``` # Break Commands Break commands are a more specific alternative to GenericGameData which allows code to be ran when an entity with a model that has a given node breaks via the [Breakables](https://asset.party/api/Sandbox.Breakables) class, such as doors, physics props and others. They work identically to GenericGameData but the class markup looks a little different: ``` /// <summary> /// Spawn a particle system when this model breaks. /// </summary> [Library( "break_create_particle" )] public class ModelBreakParticle : IModelBreakCommand { /// <summary> /// The particle to spawn when the model breaks. /// </summary> [JsonPropertyName( "name" ), ResourceType( "vpcf" )] public string Particle { get; set; } // ... public void OnBreak( Sandbox.Breakables.Result res ) { if ( !(res.Source is ModelEntity ent) ) return; var part = Particles.Create( Particle, ent.Position ); // ... } } ``` The `OnBreak` callback will be called automatically when an entity breaks and has a model with (in this case) `break_create_particle` break command. # Other things you can do with this There are multiple attributes that you can use in order to make your own custom designers/helpers for your custom nodes: - `ModelDoc.Axis` - `ModelDoc.Box` - `ModelDoc.Sphere` - `ModelDoc.Capsule` - `ModelDoc.Cylinder` - `ModelDoc.Line` - `ModelDoc.HandPose` - `ModelDoc.EditorWidget`
S&box Wiki
Development
Developer Overview
7
Community Council
Editor Overview
General FAQ
System Requirements
The s&box wiki
Troubleshooting
Useful Links
The Project System
4
Adding Assets
Creating a Project
Project Settings Window - Games
Project Templates
Publishing To Asset Party
2
Uploading assets
Uploading projects
Hammer
Getting Started With Hammer
3
Getting Started With Hammer
Making Your First Map
Mapping Resources
Mapping Basics
6
Cordons
Hotspot Materials
Selection Sets
Standard Mapping Dimensions
Tool Materials
Tools Visualisation Modes
Mapping Entities
1
Light Entities
Advanced Mapping Techniques
7
Collaborating With Prefabs and Git
Instances
Prefabs
Tilesets
Tilesets-Advanced
Tilesets-Proxies
VIS Optimizations
Models & Animation
Getting Started with Modeldoc
7
Automatic Model Setup
Breakpieces
Creating a Model
Importing Rust Weapons
LODs
ModelDoc FAQ & best practices
Overview of Models
Animgraph & Animation
4
Animations without Animgraph
AnimEvents, AnimGraph Tags, Attachments
Animgraph
Delta Animations
Physics
3
Cloth Physics
Collisions, Physics & Surface Types
Jiggle Bones
Modeldoc Nodes
1
Custom ModelDoc nodes
Advanced Modelling
6
Bodygroups
Citizen
First Person
IKChains and Stride Retargeting
Morphs
Vertex Normals
User Interface
UI Basics
5
Custom Fonts
Embedding Websites
Enabling Pointer Events
Events and Input
UI Tips & Tricks
Styles & Stylesheets
1
Video Backgrounds
Razor Templates
2
A Razor Overview
Aliases and SetProperty Attributes
Game Menus
1
Making a Custom Pause Screen
Materials & Shaders
Materials
5
Material Attributes
Material Resources
Overview of Materials
Texture Settings
Using Dynamic Expressions
Built In Shaders
2
Foliage Shader
Glass Shader
Shaders
5
Compute Shaders
Constant Buffers
Material API
Shader Learning Resources
Shading Model
Shader Reference
5
Anatomy of Shader Files
Getting rid of Tex2D macros
Shader Reference
Shader States
Texture Format Cheat-Sheet
Other Assets
Sounds & Audio
4
Overview of Sounds
Overview of Soundscapes
Sound Events
Sound Occlusion
Particles
5
Creating animated sprites
Creating your first particle effect
Understanding Particle Editor
Using custom sprites
Using particle systems from C#
Coding
Getting Started
4
Learning Resources
Setting up Rider
Setting up Visual Studio
Setting up Visual Studio Code
Making Games
2
Components
GameObjects
Input
2
Input System
Speech Recognition
Networking
3
Lobby System
Networking Basics
Networking Cheat Sheet
Physics
5
Collisions
Hitboxes
Joints
Traces
Triggers
Rendering
3
Render Tags
RenderHooks
Scenes
Editor & Tools
7
Hammer API
Hammer Gizmos
Hotload Performance
NavigationView
Overview of DebugOverlay
Overview of Widgets
Widget Docking
VR
3
Getting Started
VR Input
VR Overlays
Misc
8
Asset Types
Attributes and Component Properties
Backend API
Code Accesslist
CPU Performance Profiling
package/find
Threaded Tasks
TypeLibrary
Playing
Playing Guides
3
Default Keybinds
Proton
s&box on macOS (Experimental)
Console Commands & Variables
1
Launch Arguments
Dedicated Server
1
Dedicated Servers