s&
API Reference

Attributes

174 types

Type Name Description
class ActionGraphExposeWhenCachedAttribute Sandbox Don't cache instances of this type when serializing action graph references, force them to be always serialized separate
class ActionGraphIgnoreAttribute Sandbox
class ActionGraphIncludeAttribute Sandbox
class ActionGraphNodeAttribute Sandbox
class ActionGraphOperatorAttribute Sandbox Display this node as an operator, with no header or socket labels, and a big icon in the middle.
class ActionGraphPropertyAttribute Sandbox In ActionGraph, this parameter should only be configurable in the inspector as a property and not have a dedicated input
class ActionGraphTargetAttribute Sandbox
class ActionNodeAttribute Sandbox
class AdvancedAttribute Sandbox Some properties are not meant for the average user, hide them unless they really want to see them.
class AliasAttribute Alternate class name(s) for this type to the one specified via LibraryAttribute. This info can then be retrieved via Dis
class AlwaysInvokedAttribute Facepunch.ActionGraphs
class AssetAttribute Automatically addeded to a type as a result of using Cloud.Model etc inside.
class AssetPathAttribute Sandbox When added to a string property, will becomes a selector for AssetTypeExtension
class AssetPreviewAttribute Editor
class AssetTypeAttribute Sandbox Should be applied to a class that inherits from GameResource. Makes the class able to be stored as an asset on disk.
class AudioDistanceFloatAttribute Sandbox.Audio
class AuthorityAttribute Sandbox Marks a method as being an RPC specifically targeted to the owner of the GameObject, or the host if the GameObject doesn
class AutoGenerateAttribute Sandbox Indicates that this type should generate meta data. Tagging your asset with this will mean that the .asset file is autom
class AxisAttribute Sandbox.ModelEditor Draws 3 line axis visualization, which can set up to be manipulated via gizmos. You can have multiple of these.
class BaseAttribute
class BaseModelDocAttribute Sandbox.ModelEditor.Internal
class BaseTransformAttribute Sandbox.ModelEditor.Internal
class BitFlagsAttribute Sandbox This choices type is bitflags, so we should be able to choose more than one option at a time.
class BlendIndices
class BlendWeight
class BodyGroupMaskAttribute Used to mark properties as a body group mask, so the correct editor can be used
class BoxAttribute Sandbox.ModelEditor Draws a box, which can be manipulated via gizmos. You can have multiple of these.
class BroadcastAttribute Marks a method as being an RPC. It will be called for everyone.
class BroadcastAttribute Sandbox Marks a method as being an RPC that when invoked will be called for all connected clients including the host. The state
class ButtonAttribute Sandbox When added to a method - the inspector will show a button for it.
class CanDropAttribute Editor.MapEditor
class CanEditAttribute Editor
class CapsuleAttribute Sandbox.ModelEditor Draws a capsule, which can be manipulated via gizmos. You can have multiple of these.
class CascadingParameterAttribute Sandbox.UI A panel's property will be inherited from its parent.
class CategoryAttribute Sets the category or the group of a type or a type member. This info can then be retrieved via DisplayInfo library.
class ChangeAttribute Sandbox This will invoke a method when the property changes. It can be used with any property but is especially useful when comb
class ClassFileLocationAttribute Sandbox.Internal Automatically added to codegenerated classes to let them determine their location This helps when looking for resources
class ClassNameAttribute Set the class name for this type or member. This info can then be retrieved via DisplayInfo library.
class ClientEditableAttribute Sandbox Indicates that this propery can be edited by the client, in a game like Sandbox Mode. In reality this is used however th
class CodeGeneratorAttribute Sandbox An attribute that can be added to a custom Attribute class for special code generation behavior. They'll then be applied
class Color
class ColorUsageAttribute Sandbox When applied to a Color property, allows you to specify whether the color should have an alpha channel and/or be in HDR.
class ConCmdAttribute Sandbox
class ConditionalVisibilityAttribute Hide a property if a condition matches.
class ConVarAttribute Sandbox Console variable
class ConvertAttribute To allow redirecting in the case where a class has both a string and StringToken version of a method. We should be able
class CustomEditorAttribute Sandbox
class CustomEmbeddedEditorAttribute Sandbox
class CylinderAttribute Sandbox.ModelEditor Draws a cylinder, which can be manipulated via gizmos. You can have multiple of these.
class DefaultMovieRecorderOptionsAttribute Sandbox.MovieMaker Call this static method when building Default. The method must have exactly one parameter, of type MovieRecorderOptions,
class DefaultValueAttribute Sometimes with CodeGen we want reflection to be able to get the original initial value of a property (which is set with
class DescriptionAttribute Sets the description of a type or a type member. This attribute is usually applied automatically by codegen based on the
class DescriptionAttribute Facepunch.ActionGraphs
class DockAttribute Editor
class EditorAppAttribute Editor
class EditorAttribute Tell the tools or gameui property editor which editor we should be using for this property or type.
class EditorForAssetTypeAttribute Editor Used in conjunction with IAssetEditor to declare a window that can edit an asset type
class EditorHandleAttribute Sandbox When applied to a component, the editor will draw a selectable handle sprite for the gameobject in scene
class EditorModelAttribute Declare a model to represent this entity in editor. This is a common attribute so it's leaked out of the Editor namespac
class EditorWidgetAttribute Sandbox.ModelEditor Adds a custom editor widget to the game data node. Currently only 1 option is available - "HandPosePairEditor"
class EnableColorAlphaAttribute Editor If used on a Color or Color32 property, enables alpha modification in editors.
class EnumButtonGroupAttribute Sandbox Forces an enum property to be shown as a group of buttons.
class EventAttribute Sandbox A generic event listener. You are probably looking for Sandbox.Event.* attributes.
class ExposeWhenCachedAttribute Facepunch.ActionGraphs
class ExpressionNodeAttribute Sandbox
class FeatureAttribute Sandbox Sets the category or the group of a type or a type member. This info can then be retrieved via DisplayInfo library.
class FeatureEnabledAttribute Sandbox Mark a boolean property as a feature toggle
class FGDTypeAttribute Sandbox Overrides the auto generated FGD type.
class FieldMetaDataAttribute Editor Base attribute which allows adding metadata to properties.
class FilePathAttribute Sandbox When added to a string property, will become a file picker for the given extension (or all by default)
class FontNameAttribute Sandbox When applied to a string property, uses a font name selector.
class FrameAttribute Called every frame for tools
class GameDataAttribute Sandbox.ModelEditor Indicates that this class/struct should be available as GenericGameData node in ModelDoc
class GameResourceAttribute Sandbox
class GroupAttribute Sets the category or the group of a type or a type member. This info can then be retrieved via DisplayInfo library.
class GroupAttribute Facepunch.ActionGraphs
class HandPoseAttribute Sandbox.ModelEditor A helper used for VR hand purposes.
class HasConversionFromAttribute Sandbox.ActionGraphs
class HasImplementationAttribute Sandbox In ActionGraph, this type parameter can only be satisfied by a type TArg, such that there exists at least one non-abstra
class HeaderAttribute Sandbox Add a header above this property
class HelpUrlAttribute Sandbox Add a link to some documentation for this component, or
class HiddenAttribute Facepunch.ActionGraphs
class HideAttribute Sandbox Hide this in tools/editors.
class HideIfAttribute Hide this property if a given property within the same class has the given value. Used typically in the Editor Inspector
class HideInEditorAttribute Hide this in tools/editors.
class HidePropertyAttribute Editor A way to hide properties from parent classes in tools.
class HingeJointAttribute Sandbox.ModelEditor A helper that draws axis of rotation and angle limit of a hinge joint.
class HostAttribute Marks a method as being an RPC. It will only be called on the host.
class HostSyncAttribute Sandbox Automatically synchronize a property of a networked object from the host to other clients. Obsolete: 11/12/2024
class HotloadAttribute
class IconAttribute Sets the icon of a type or a type member. Colors are expected in HTML formats, like "rgb(255,255,255)" or "#FFFFFF". Thi
class IconAttribute Facepunch.ActionGraphs
class IconNameAttribute Sandbox When applied to a string property, uses a Material Icon selector.
class ImageAssetPathAttribute Sandbox When added to a string property, will become an image string selector
class ImpureAttribute Sandbox
class ImpureAttribute Facepunch.ActionGraphs
class InfoBoxAttribute Sandbox Draw a box with information above this property
class InlineEditorAttribute Sandbox Tell the editor to try to display inline editing for this property, rather than hiding it behind a popup etc.
class InputActionAttribute Sandbox When applied to a string property, use an input action selector.
class InputAttribute Sandbox Makes this method available as a Map Logic Input, for use in the Hammer Editor. This is only applicable to entities.
class InspectorAttribute Editor
class InspectorVisibilityAttribute Sandbox Hide a property if a condition matches.
class JsonUpgraderAttribute Sandbox An attribute that describes a version update for a JSON object.
class KeyPropertyAttribute Sandbox Mark this property as the key property - which means that it can represent the whole object in a single line, while usua
class LibraryAttribute Sandbox
class LineAttribute Sandbox.ModelEditor
class MakeDirtyAttribute Sandbox
class MapAssetPathAttribute Sandbox When added to a string property, will become a map string selector
class MapViewContextMenu Called when the map view is right clicked, Menu is passed.
class MaterialGroupAttribute Used to mark a property as a material group, for the editor
class MaterialOverrideAttribute Used to mark a property as a material material override dictionary, for the editor
class MenuAttribute Editor
class MetaDataAttribute Editor Base attribute which allows adding FGD metadata to classes.
class MethodArgumentsAttribute Sandbox Specify the types of arguments a method should have. Typically used with event attributes to throw an exception if an ev
class MethodBodyChangeAttribute Sandbox
class MinMaxAttribute Mark property as having a minimum and maximum value.
class NodeAttribute Facepunch.ActionGraphs
class NodeDefinitionAttribute Facepunch.ActionGraphs
class Normal
class NormalAttribute Sandbox When applied to a Vector property, provides normal selection tools.
class OrderAttribute Visual order of this member for UI purposes. This info can then be retrieved via DisplayInfo library.
class OwnerAttribute Marks a method as being an RPC. It will only be called on owner of this object.
class PanelEventAttribute Sandbox.UI Add an event listener to a Panel event with the given name. See Single}).
class PlaceholderAttribute Add placeholder text, typically displayed for string properties when the text entry field is empty. This info can then b
class Position
class PropertyAccessorBodyChangeAttribute Sandbox
class PropertyAttribute Sandbox
class PropertyAttribute Facepunch.ActionGraphs
class PureAttribute Sandbox
class PureAttribute Facepunch.ActionGraphs
class RangeAttribute Sandbox Mark this property as a ranged float/int. In inspector we'll be able to create a slider instead of a text entry.
class ReadOnlyAttribute Sandbox Display this in the inspector - but don't let anyone edit it
class RequireComponentAttribute Sandbox When added to a property on a Component, we'll try to make that component value non null. We will first look on the Game
class ResourceIdentityAttribute Mark a ResourceCompiler. This is used to identify the compiler for a specific file extension, or compiler.
class ResourceTypeAttribute Sandbox Allows you to specify a string property as a resource type. This will give the property a resource finder. Type should b
class RouteAttribute Microsoft.AspNetCore.Components
class RpcAttribute Sandbox Marks a method as being an RPC. This means that it can be called over the network.
class ScaleBoneRelativeAttribute Sandbox.ModelEditor Scales the vector with the "ScaleAndMirror" node, relative to associated bone.
class ScaleWorldAttribute Sandbox.ModelEditor Scales the vector with the "ScaleAndMirror" node.
class SelectionBaseAttribute Sandbox Apply this attribute to a component class to mark its GameObject as a selection base for Scene View picking. For example
class SelectionChanged Called when the user selects / deselects any object in the map and is changed.
class ShortcutAttribute Editor
class ShowIfAttribute Show this property if a given property within the same class has the given value. Used typically in the Editor Inspector
class SingleActionAttribute Sandbox Force a delegate-type property to only have a single attached Action Graph.
class SkipHotloadAttribute Sandbox Skip processing a specific field, or any fields in a type marked by this attribute. Field processing will still occur if
class SourceLocationAttribute Sandbox.Internal Automatically added to classes and their members to let them determine their location This helps when looking for resour
class SpaceAttribute Sandbox Add a space above this property
class SpawnableAttribute This entity is expected to be spawnable in-game, like from Sandbox's spawnmenu.
class SphereAttribute Sandbox.ModelEditor Draws a sphere, which can be manipulated via gizmos. You can have multiple of these.
class StackLineHandlerAttribute Editor Marks a method as a custom handler for stack trace lines matching a certain pattern. The method must take in a Match par
class StepAttribute Sandbox Mark this property as a stepped value, where the value can only be set to multiples of the step value.
class StringLiteralOnlyAttribute Sandbox Ask codegen to shit itself if the parameter isn't passed in as a string literal
class StyleSheetAttribute Sandbox.UI Will automatically apply the named stylesheet to the Panel.
class SupportsILHotloadAttribute Sandbox
class SuppressNullKeyWarningAttribute Sandbox When applied to a member with Dictionary`2 or HashSet`1 type, don't warn if the key of an item becomes null during a hot
class SyncAttribute Sandbox Automatically synchronize a property of a networked object from the owner to other clients.
class TagAttribute Adds a single or multiple tags for this type or member. Tags can then be retrieved via DisplayInfo library.
class TagsAttribute Facepunch.ActionGraphs
class Tangent
class TargetAttribute Facepunch.ActionGraphs
class TargetTypeAttribute Sandbox When applied to a Type property, allows you to specify a Type that the property's value must derive from.
class TexCoord
class TextAreaAttribute Sandbox When applied to a string property, show a multi-line text box instead of a single line.
class TextureImagePathAttribute Sandbox When added to a string property, will allow selection of anything that a Texture can be
class ThumbnailRendererAttribute Should target a static method like `public static Pixmap RenderThumbnail( Asset thumbnail )` where the method returns a
class TimeRangeAttribute For use with Curves, allows you to define a custom range for the time
class TintAttribute Sandbox
class TitleAttribute Sets the title or a "nice name" of a type or a type member. This info can then be retrieved via DisplayInfo library.
class TitleAttribute Facepunch.ActionGraphs
class ToggleGroupAttribute Very much like a GroupAttribute, except we're indicating that the group can be toggle on and off using the named propert
class TypeHintAttribute Hint that this type is expected to be this. This is used internally for the editor UX to hint that a type of a value sho
class ValidateAttribute Validates a property using a method.
class ValueRangeAttribute For use with Curves, allows you to define a custom range for the value
class WideModeAttribute Sandbox Expand the value editor to fill the next line in the inspector, leaving the title above it