S&box Wiki
Home
/
Edit Hammer API
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
Hammer API
<cat>Code.Editor</cat> <title>Hammer API</title> <note>This stuff isn't as mature as our games API, so this stuff will end up changing a fair amount as we figure out the best way to do things.</note> # Hammer API Tool addons can extend the capabilities of Hammer by using these APIs, you can interact with selected [map nodes](https://asset.party/api/Editor.MapDoc.MapNode) or procedurally create new map nodes. These nodes can be a [MapMesh](https://asset.party/api/Editor.MapDoc.MapMesh) which can procedurally create a mesh, [MapEntity](https://asset.party/api/Editor.MapDoc.MapEntity) for placing map entities and setting key values, or more. ## Map Nodes Map nodes can be created in the current map simply by calling their constructors. ```csharp // Create new map entity MapEntity entity = new(); entity.ClassName = "info_player_start"; entity.Position = Vector3.Up * 32.0f; ``` ## Selection You can get all the selected map nodes, or set the selection with the [Selection](https://asset.party/api/Editor.MapEditor.Selection) static class. ```csharp // Get the first selected map node MapNode node = Selection.All.FirstOrDefault(); // You can pattern match MapNodes if ( node is MapMesh mesh ) { // ... } // Create a new entity and add it to the selection Selection.Add( new MapEntity() ); ``` ## Traces The [Trace](https://asset.party/api/Editor.Trace) API lets you ray cast within map worlds, there's options to only hit meshes or skip tools materials. This primarily has usage for pickers, but could be used to snap things down or some crazy procedural stuff. ```csharp view.BuildRay( out Vector3 rayStart, out Vector3 rayEnd ); var tr = Trace.Ray( rayStart, rayEnd ).Run( view.MapDoc.World ); var entity = new MapEntity(); entity.ClassName = classname; entity.Position = tr.HitPosition; Selection.Set( entity ); ``` ## Map View Context Menu You can extend the context menu in Hammer with the `hammer.mapview.contextmenu` event. ```csharp [Event( "hammer.mapview.contextmenu" )] static void OnMapViewContextMenu( Menu menu, MapView view ) { menu.AddSeparator(); var submenu = menu.AddMenu( "Create Point Entity" ); // ... } ``` <upload src="a5727/8daba681b65ea31.png" size="182702" name="image.png" /> ## Adding Menu Bar Menus can be added to the menu bar in Hammer the same as other tools ```csharp [Menu( "Hammer", "My Cool Stuff/Log Selected", "info" )] public static void LogSelected() { Log.Info( Selection.All.First() ); } ``` ## Primitive Builders You can add new primitives to the block tool. ```csharp [Title( "Rect" ), Icon( "rectangle" )] class RectPrimitive : PrimitiveBuilder { [Browsable( false )] public BBox BBox { get; set; } public override void SetFromBox( BBox box ) => BBox = box; public override void Build( PolygonMesh mesh ) { var mins = BBox.Mins; var maxs = BBox.Maxs; mesh.AddFace( new Vector3( mins.x, mins.y, maxs.z ), new Vector3( maxs.x, mins.y, maxs.z ), new Vector3( maxs.x, maxs.y, maxs.z ), new Vector3( mins.x, maxs.y, maxs.z ) ); } } ``` ## Map Drop Targets Map drop targets enable you to create handlers for your own asset types. Here's how we enable you to drop soundscapes into maps: ```csharp [CanDrop( "sndscape" )] class SoundscapeDropTarget : IMapViewDropTarget { MapEntity SoundEntity { get; set; } public void DragEnter( Asset asset, MapView view ) { SoundEntity = new MapEntity(); SoundEntity.ClassName = "snd_soundscape"; SoundEntity.SetKeyValue( "soundscape", asset.Path ); } public void DragMove( MapView view ) { view.BuildRay( out Vector3 rayStart, out Vector3 rayEnd ); var tr = Trace.Ray( rayStart, rayEnd ).Run( view.MapDoc.World ); SoundEntity.Position = tr.HitPosition; } } ```
S&box Wiki
Development
Developer Overview
6
Editor Overview
General FAQ
System Requirements
The s&box wiki
Troubleshooting
Useful Links
The Project System
4
Adding Assets
Creating a Game Project
Project Settings Window - Games
Project Types
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
7
Cordons
Hotspot Materials
Selection Sets
Standard Mapping Dimensions
Tool Materials
Tools Visualisation Modes
Using Entities That Require a Mesh
Mapping Entities
2
Creating a Door
Light Entities
Advanced Mapping Techniques
8
Collaborating With Prefabs and Git
Instances
Prefabs
Quixel Bridge Plugin
Tilesets
Tilesets-Advanced
Tilesets-Proxies
VIS Optimizations
Models & Animation
Getting Started with Modeldoc
7
Automatic Model Setup
Breakpieces
Creating a Model
Guide to Models
Importing Rust Weapons
LODs
ModelDoc FAQ & best practices
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
7
Custom Fonts
Embedding Websites
Enabling Pointer Events
Events and Input
Localization
UI Basics
UI with Components
Styles & Stylesheets
1
Video Backgrounds
Razor Templates
4
A Razor Overview
Aliases and SetProperty Attributes
Generic Components
Templates
Game Menus
1
Making a Custom Pause Screen
Materials & Shaders
Materials
5
Guide to Materials
Material Attributes
Material Resources
Texture Settings
Using Dynamic Expressions
Built In Shaders
2
Foliage Shader
Glass Shader
Shaders
4
Compute Shaders
Constant Buffers
Material API
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
Guide to Sounds
Sound Events
Sound Occlusion
Soundscapes
Particles
5
Creating animated sprites
Creating your first particle effect
Understanding Particle Editor
Using custom sprites
Using particle systems from C#
Coding
Getting Started
5
Cheat Sheet
Learning Resources
Setting up Rider
Setting up Visual Studio
Setting up Visual Studio Code
Making Games
2
Components
GameObjects
Input
4
Commands
ConVars
Input System
Speech Recognition
Networking
7
Auth Tokens
Http Requests
Lobby System
Networked Types
Networking Basics
RPCs
WebSockets
Physics
5
Collisions
Hitboxes
Joints
Traces
Triggers
Rendering
3
Render Tags
RenderHooks
Scenes
Editor & Tools
7
Creating a Tool
Custom Asset Types
Guide to Widgets
Hammer API
Hammer Gizmos
Hotload Performance
Widget Docking
VR
3
Getting Started
VR Input
VR Overlays
Misc
13
Asset Types
Attributes and Component Properties
Backend API
Cloud Assets in code
Code Accesslist
CPU Performance Profiling
DisplayInfo
FileSystem
Mounting assets at runtime
package/find
Setting Up A Navigation Mesh
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