Files
sbox-public/engine/Sandbox.Engine/Scene/GameObject/GameObject.Flags.cs
James King 81d0ce69ca Movie Maker: Support ITagSet and flag enums, fixing first person recordings (#5313)
* Record tags and flags as bool tracks
* Capture GameObject.Tags, Camera.Render[Exclude]Tags
* Capture GameObject absolute transform flag
2026-07-13 13:05:31 +02:00

123 lines
2.8 KiB
C#

namespace Sandbox;
[Flags, Expose]
public enum GameObjectFlags
{
None = 0,
/// <summary>
/// Hide this object in hierarchy/inspector
/// </summary>
Hidden = 1,
/// <summary>
/// Don't save this object to disk, or when duplicating
/// </summary>
NotSaved = 2,
/// <summary>
/// Auto created - it's a bone, driven by animation
/// </summary>
Bone = 4,
/// <summary>
/// Auto created - it's an attachment
/// </summary>
Attachment = 8,
/// <summary>
/// There's something wrong with this
/// </summary>
Error = 16,
/// <summary>
/// Loading something
/// </summary>
Loading = 32,
/// <summary>
/// Is in the process of deserializing
/// </summary>
Deserializing = 64,
/// <summary>
/// When loading a new scene, keep this gameobject active
/// </summary>
DontDestroyOnLoad = 128,
/// <summary>
/// Keep local - don't network this object as part of the scene snapshot
/// </summary>
NotNetworked = 256,
/// <summary>
/// In the process of refreshing from the network
/// </summary>
[Obsolete]
Refreshing = 512,
/// <summary>
/// Stops animation stomping the bone, will use the bone's local position
/// </summary>
ProceduralBone = 1024,
/// <summary>
/// Only exists in the editor. Don't spawn it in game.
/// </summary>
EditorOnly = 2048,
/// <summary>
/// Ignore the parent transform. Basically, position: absolute for gameobjects.
/// </summary>
Absolute = 4096,
/// <summary>
/// The position of this object is controlled by by physics - usually via a RigidBody component
/// </summary>
PhysicsBone = 8192,
/// <summary>
/// Stops this object being interpolated, either via the network system or the physics system
/// </summary>
NoInterpolation = 16384,
/// <summary>
/// This object never moves during gameplay. Applies to children too.
/// Lets rendering, physics and navmesh make static optimizations.
/// </summary>
Static = 32768,
}
public partial class GameObject
{
public GameObjectFlags Flags { get; set; } = GameObjectFlags.None;
/// <summary>
/// True if this GameObject is being deserialized right now
/// </summary>
public bool IsDeserializing => Flags.Contains( GameObjectFlags.Deserializing );
/// <summary>
/// This object never moves during gameplay, letting rendering, physics and navmesh
/// make static optimizations. Children inherit this via <see cref="GameObjectFlags.Static"/>
/// on any ancestor.
/// </summary>
public bool IsStatic
{
get => HasFlagOrParent( GameObjectFlags.Static );
set => Flags = Flags.WithFlag( GameObjectFlags.Static, value );
}
/// <summary>
/// Do we or our ancestor have this flag
/// </summary>
internal bool HasFlagOrParent( GameObjectFlags f )
{
if ( Flags.Contains( f ) ) return true;
if ( Parent is null ) return false;
return Parent.HasFlagOrParent( f );
}
}