ScopeLens.cs

The ScopeLens component handles the camera view for a scope. It renders the camera view into a texture and optionally aligns the camera zero distance along the weapon's muzzle axis.

using Sandbox;
using System;

public sealed class ScopeLens : Component
{
	[RequireComponent] public ModelRenderer Renderer { get; set; }
	/// <summary>Scope camera that renders into the lens texture.</summary>
	[Property] public CameraComponent Camera { get; set; }

	/// <summary>Aim the scope camera at the muzzle zero distance on start.</summary>
	[Property, Group( "Zeroing" )] public bool ApplyZeroing { get; set; }

	/// <summary>Zero distance in meters; camera looks at that point along the muzzle.</summary>
	[Property, Group( "Zeroing" ), ShowIf( nameof( ApplyZeroing ), true )] public float Range { get; set; } = 100f;

	/// <summary>Muzzle transform used for zeroing direction and roll alignment.</summary>
	[Property, Group( "Zeroing" ), ShowIf( nameof( ApplyZeroing ), true )] public GameObject Muzzle;

	private Texture RenderTarget;

	protected override void OnStart()
	{
		SetupRenderTarget();

		if ( ApplyZeroing )
		{
			ApplyZero();
		}
	}

	private void SetupRenderTarget()
	{
		RenderTarget = Texture.CreateRenderTarget().WithDynamicUsage().WithSize( 1024, 1024 ).Create();
		Camera.RenderTarget = RenderTarget;
		var material = Renderer.MaterialOverride;
		material.Set( "Color", RenderTarget );
		Renderer.MaterialOverride = material;
	}

	private void ApplyZero()
	{
		Vector3 zeroPoint = Muzzle.WorldPosition +
					Muzzle.WorldRotation.Forward * MathX.MeterToInch( Range );

		// Use muzzle up so roll matches the weapon even if it starts on its side.
		// World up would bake a twisted local rotation that stays crooked when picked up.
		Camera.WorldRotation = Rotation.LookAt(
			zeroPoint - Camera.WorldPosition,
			Muzzle.WorldRotation.Up
		);
	}
}