oliverbooth/VpSharp
1
0
Fork 0
mirror of https://github.com/oliverbooth/VpSharp synced 2024-11-23 00:28:48 +00:00
Code Issues Wiki

Use custom Optional<T> rather than T? for optional properties

Browse Source
This commit is contained in:
Oliver Booth 2022-12-04 19:49:08 +00:00
parent a9a613f424
commit 56e68dd619
No known key found for this signature in database
GPG Key ID: 32A00B35503AF634
3 changed files with 179 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
VpSharp/src/Entities/VirtualParadiseModelObjectBuilder.cs
View File

@ -24,19 +24,19 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
/// Gets or sets the value of this object's <c>Action</c> field. /// Gets or sets the value of this object's <c>Action</c> field.
/// </summary> /// </summary>
/// <value>The value of this object's <c>Action</c> field, or <see langword="null" /> to leave unchanged.</value> /// <value>The value of this object's <c>Action</c> field, or <see langword="null" /> to leave unchanged.</value>
public string? Action { get; set; } public Optional<string> Action { get; set; }
/// <summary> /// <summary>
/// Gets or sets the value of this object's <c>Description</c> field. /// Gets or sets the value of this object's <c>Description</c> field.
/// </summary> /// </summary>
/// <value>The value of this object's <c>Description</c> field, or <see langword="null" /> to leave unchanged.</value> /// <value>The value of this object's <c>Description</c> field, or <see langword="null" /> to leave unchanged.</value>
public string? Description { get; set; } public Optional<string> Description { get; set; }
/// <summary> /// <summary>
/// Gets or sets the value of this object's <c>Model</c> field. /// Gets or sets the value of this object's <c>Model</c> field.
/// </summary> /// </summary>
/// <value>The value of this object's <c>Model</c> field, or <see langword="null" /> to leave unchanged.</value> /// <value>The value of this object's <c>Model</c> field, or <see langword="null" /> to leave unchanged.</value>
public string? Model { get; set; } public Optional<string> Model { get; set; }
/// <summary> /// <summary>
/// Gets or sets the date and time at which this object was last modified. /// Gets or sets the date and time at which this object was last modified.
@ -48,7 +48,7 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
/// This property may only be set during an object load, and will throw <see cref="InvalidOperationException" /> at /// This property may only be set during an object load, and will throw <see cref="InvalidOperationException" /> at
/// any other point. /// any other point.
/// </remarks> /// </remarks>
public DateTimeOffset? ModificationTimestamp { get; set; } public Optional<DateTimeOffset> ModificationTimestamp { get; set; }
/// <summary> /// <summary>
/// Gets or sets the owner of this object. /// Gets or sets the owner of this object.
@ -58,26 +58,26 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
/// This property may only be set during an object load, and will throw <see cref="InvalidOperationException" /> at /// This property may only be set during an object load, and will throw <see cref="InvalidOperationException" /> at
/// any other point. /// any other point.
/// </remarks> /// </remarks>
public VirtualParadiseUser? Owner { get; set; } public Optional<VirtualParadiseUser> Owner { get; set; }
/// <summary> /// <summary>
/// Gets or sets the position of the object. /// Gets or sets the position of the object.
/// </summary> /// </summary>
/// <value>The position of the object, or <see langword="null" /> to leave unchanged.</value> /// <value>The position of the object, or <see langword="null" /> to leave unchanged.</value>
public Vector3d? Position { get; set; } public Optional<Vector3d> Position { get; set; }
/// <summary> /// <summary>
/// Gets or sets the rotation of the object. /// Gets or sets the rotation of the object.
/// </summary> /// </summary>
/// <value>The rotation of the object, or <see langword="null" /> to leave unchanged.</value> /// <value>The rotation of the object, or <see langword="null" /> to leave unchanged.</value>
public Quaternion? Rotation { get; set; } public Optional<Quaternion> Rotation { get; set; }
/// <summary> /// <summary>
/// Sets the value of this object's <c>Action</c> field. /// Sets the value of this object's <c>Action</c> field.
/// </summary> /// </summary>
/// <param name="action">The new value of the <c>Action</c> field, or <see langword="null" /> to leave unchanged.</param> /// <param name="action">The new value of the <c>Action</c> field, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance of this builder.</returns> /// <returns>The current instance of this builder.</returns>
public VirtualParadiseModelObjectBuilder WithAction(string? action) public VirtualParadiseModelObjectBuilder WithAction(Optional<string> action)
{ {
Action = action; Action = action;
return this; return this;
@ -90,7 +90,7 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
/// The new value of the <c>Description</c> field, or <see langword="null" /> to leave unchanged. /// The new value of the <c>Description</c> field, or <see langword="null" /> to leave unchanged.
/// </param> /// </param>
/// <returns>The current instance of this builder.</returns> /// <returns>The current instance of this builder.</returns>
public VirtualParadiseModelObjectBuilder WithDescription(string? description) public VirtualParadiseModelObjectBuilder WithDescription(Optional<string> description)
{ {
Description = description; Description = description;
return this; return this;
@ -101,7 +101,7 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
/// </summary> /// </summary>
/// <param name="model">The new value of the <c>Model</c> field, or <see langword="null" /> to leave unchanged.</param> /// <param name="model">The new value of the <c>Model</c> field, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance of this builder.</returns> /// <returns>The current instance of this builder.</returns>
public VirtualParadiseModelObjectBuilder WithModel(string? model) public VirtualParadiseModelObjectBuilder WithModel(Optional<string> model)
{ {
Model = model; Model = model;
return this; return this;
@ -112,13 +112,13 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
nint handle = Client.NativeInstanceHandle; nint handle = Client.NativeInstanceHandle;
var targetObject = (VirtualParadiseModelObject)TargetObject; var targetObject = (VirtualParadiseModelObject)TargetObject;
vp_string_set(handle, StringAttribute.ObjectModel, Model ?? targetObject.Model); vp_string_set(handle, StringAttribute.ObjectModel, Model.HasValue ? Model.Value! : targetObject.Model);
vp_string_set(handle, StringAttribute.ObjectDescription, Description ?? targetObject.Description); vp_string_set(handle, StringAttribute.ObjectDescription, Description.HasValue ? Description.Value! : targetObject.Description);
vp_string_set(handle, StringAttribute.ObjectAction, Action ?? targetObject.Action); vp_string_set(handle, StringAttribute.ObjectAction, Action.HasValue ? Action.Value! : targetObject.Action);
if (Position is { } position) if (Position.HasValue)
{ {
(double x, double y, double z) = position; (double x, double y, double z) = Position.Value;
_ = vp_double_set(handle, FloatAttribute.ObjectX, x); _ = vp_double_set(handle, FloatAttribute.ObjectX, x);
_ = vp_double_set(handle, FloatAttribute.ObjectY, y); _ = vp_double_set(handle, FloatAttribute.ObjectY, y);
_ = vp_double_set(handle, FloatAttribute.ObjectZ, z); _ = vp_double_set(handle, FloatAttribute.ObjectZ, z);
@ -135,18 +135,18 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
_ = vp_double_set(handle, FloatAttribute.ObjectZ, z); _ = vp_double_set(handle, FloatAttribute.ObjectZ, z);
} }
if (Rotation is null && Mode == ObjectBuilderMode.Create) if (!Rotation.HasValue && Mode == ObjectBuilderMode.Create)
{ {
Rotation = Quaternion.Identity; Rotation = Quaternion.Identity;
} }
if (Rotation is { } rotation) if (Rotation.HasValue)
{ {
(double x, double y, double z) = Vector3d.Zero; (double x, double y, double z) = Vector3d.Zero;
double angle = double.PositiveInfinity; double angle = double.PositiveInfinity;
if (rotation != Quaternion.Identity) if (Rotation.Value != Quaternion.Identity)
{ {
rotation.ToAxisAngle(out Vector3d axis, out angle); Rotation.Value.ToAxisAngle(out Vector3d axis, out angle);
(x, y, z) = axis; (x, y, z) = axis;
} }
@ -164,28 +164,28 @@ public sealed class VirtualParadiseModelObjectBuilder : VirtualParadiseObjectBui
_ = vp_double_set(handle, FloatAttribute.ObjectRotationAngle, angle); _ = vp_double_set(handle, FloatAttribute.ObjectRotationAngle, angle);
} }
if (ModificationTimestamp is { } modificationTimestamp) if (ModificationTimestamp.HasValue)
{ {
if (Mode != ObjectBuilderMode.Load) if (Mode != ObjectBuilderMode.Load)
{ {
throw new InvalidOperationException("Modification timestamp can only be assigned during an object load."); throw new InvalidOperationException("Modification timestamp can only be assigned during an object load.");
} }
_ = vp_int_set(handle, IntegerAttribute.ObjectTime, (int)modificationTimestamp.ToUnixTimeSeconds()); _ = vp_int_set(handle, IntegerAttribute.ObjectTime, (int)ModificationTimestamp.Value.ToUnixTimeSeconds());
} }
else else
{ {
_ = vp_int_set(handle, IntegerAttribute.ObjectTime, (int)targetObject.ModificationTimestamp.ToUnixTimeSeconds()); _ = vp_int_set(handle, IntegerAttribute.ObjectTime, (int)targetObject.ModificationTimestamp.ToUnixTimeSeconds());
} }
if (Owner is { } owner) if (Owner.HasValue)
{ {
if (Mode != ObjectBuilderMode.Load) if (Mode != ObjectBuilderMode.Load)
{ {
throw new InvalidOperationException("Owner can only be assigned during an object load."); throw new InvalidOperationException("Owner can only be assigned during an object load.");
} }
_ = vp_int_set(handle, IntegerAttribute.ObjectUserId, owner.Id); _ = vp_int_set(handle, IntegerAttribute.ObjectUserId, Owner.Value!.Id);
} }
else else
{ {

96
VpSharp/src/Entities/VirtualParadiseParticleEmitterObjectBuilder.cs
View File

@ -29,7 +29,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The maximum acceleration, or <see langword="null" /> to leave unchanged.</value> /// <value>The maximum acceleration, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("acceleration_max")] [SerializationKey("acceleration_max")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? AccelerationMax { get; set; } public Optional<Vector3d> AccelerationMax { get; set; }
/// <summary> /// <summary>
/// Gets or sets the minimum acceleration. /// Gets or sets the minimum acceleration.
@ -37,7 +37,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The minimum acceleration, or <see langword="null" /> to leave unchanged.</value> /// <value>The minimum acceleration, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("acceleration_min")] [SerializationKey("acceleration_min")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? AccelerationMin { get; set; } public Optional<Vector3d> AccelerationMin { get; set; }
/// <summary> /// <summary>
/// Gets or sets the blend mode. /// Gets or sets the blend mode.
@ -45,7 +45,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The blend mode, or <see langword="null" /> to leave unchanged.</value> /// <value>The blend mode, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("blend")] [SerializationKey("blend")]
[ValueConverter(typeof(StringToEnumConverter<ParticleBlendMode>))] [ValueConverter(typeof(StringToEnumConverter<ParticleBlendMode>))]
public ParticleBlendMode? BlendMode { get; set; } public Optional<ParticleBlendMode> BlendMode { get; set; }
/// <summary> /// <summary>
/// Gets or sets the maximum color. /// Gets or sets the maximum color.
@ -53,7 +53,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The maximum color, or <see langword="null" /> to leave unchanged.</value> /// <value>The maximum color, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("color_max")] [SerializationKey("color_max")]
[ValueConverter(typeof(HexToColorConverter))] [ValueConverter(typeof(HexToColorConverter))]
public Color? ColorMax { get; set; } public Optional<Color> ColorMax { get; set; }
/// <summary> /// <summary>
/// Gets or sets the minimum color. /// Gets or sets the minimum color.
@ -61,7 +61,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The minimum color, or <see langword="null" /> to leave unchanged.</value> /// <value>The minimum color, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("color_min")] [SerializationKey("color_min")]
[ValueConverter(typeof(HexToColorConverter))] [ValueConverter(typeof(HexToColorConverter))]
public Color? ColorMin { get; set; } public Optional<Color> ColorMin { get; set; }
/// <summary> /// <summary>
/// Gets or sets the emitter lifespan. /// Gets or sets the emitter lifespan.
@ -69,7 +69,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The emitter lifespan, or <see langword="null" /> to leave unchanged.</value> /// <value>The emitter lifespan, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("emitter_lifespan")] [SerializationKey("emitter_lifespan")]
[ValueConverter(typeof(MillisecondToTimeSpanConverter))] [ValueConverter(typeof(MillisecondToTimeSpanConverter))]
public TimeSpan? EmitterLifespan { get; set; } public Optional<TimeSpan> EmitterLifespan { get; set; }
/// <summary> /// <summary>
/// Gets or sets a value indicating whether this emitter interpolates its values. /// Gets or sets a value indicating whether this emitter interpolates its values.
@ -80,14 +80,14 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </value> /// </value>
[SerializationKey("interpolate")] [SerializationKey("interpolate")]
[ValueConverter(typeof(IntToBoolConverter))] [ValueConverter(typeof(IntToBoolConverter))]
public bool? Interpolate { get; set; } public Optional<bool> Interpolate { get; set; }
/// <summary> /// <summary>
/// Gets or sets the opacity. /// Gets or sets the opacity.
/// </summary> /// </summary>
/// <value>The opacity, or <see langword="null" /> to leave unchanged.</value> /// <value>The opacity, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("opacity")] [SerializationKey("opacity")]
public double? Opacity { get; set; } public Optional<double> Opacity { get; set; }
/// <summary> /// <summary>
/// Gets or sets the particle lifespan. /// Gets or sets the particle lifespan.
@ -95,7 +95,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The particle lifespan, or <see langword="null" /> to leave unchanged.</value> /// <value>The particle lifespan, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("particle_lifespan")] [SerializationKey("particle_lifespan")]
[ValueConverter(typeof(MillisecondToTimeSpanConverter))] [ValueConverter(typeof(MillisecondToTimeSpanConverter))]
public TimeSpan? ParticleLifespan { get; set; } public Optional<TimeSpan> ParticleLifespan { get; set; }
/// <summary> /// <summary>
/// Gets or sets the particle type. /// Gets or sets the particle type.
@ -103,14 +103,14 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The particle type, or <see langword="null" /> to leave unchanged.</value> /// <value>The particle type, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("particle_type")] [SerializationKey("particle_type")]
[ValueConverter(typeof(StringToEnumConverter<ParticleType>))] [ValueConverter(typeof(StringToEnumConverter<ParticleType>))]
public ParticleType? ParticleType { get; set; } public Optional<ParticleType> ParticleType { get; set; }
/// <summary> /// <summary>
/// Gets or sets the release count. /// Gets or sets the release count.
/// </summary> /// </summary>
/// <value>The release count, or <see langword="null" /> to leave unchanged.</value> /// <value>The release count, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("release_count")] [SerializationKey("release_count")]
public int? ReleaseCount { get; set; } public Optional<int> ReleaseCount { get; set; }
/// <summary> /// <summary>
/// Gets or sets the release time. /// Gets or sets the release time.
@ -118,7 +118,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The release time, or <see langword="null" /> to leave unchanged.</value> /// <value>The release time, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("release_time")] [SerializationKey("release_time")]
[ValueConverter(typeof(MillisecondToTimeSpanConverter))] [ValueConverter(typeof(MillisecondToTimeSpanConverter))]
public TimeSpan? ReleaseTime { get; set; } public Optional<TimeSpan> ReleaseTime { get; set; }
/// <summary> /// <summary>
/// Gets or sets the maximum size. /// Gets or sets the maximum size.
@ -126,7 +126,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The maximum size, or <see langword="null" /> to leave unchanged.</value> /// <value>The maximum size, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("size_max")] [SerializationKey("size_max")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? SizeMax { get; set; } public Optional<Vector3d> SizeMax { get; set; }
/// <summary> /// <summary>
/// Gets or sets the minimum size. /// Gets or sets the minimum size.
@ -134,7 +134,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The minimum size, or <see langword="null" /> to leave unchanged.</value> /// <value>The minimum size, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("size_min")] [SerializationKey("size_min")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? SizeMin { get; set; } public Optional<Vector3d> SizeMin { get; set; }
/// <summary> /// <summary>
/// Gets or sets the maximum speed. /// Gets or sets the maximum speed.
@ -142,7 +142,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The maximum speed, or <see langword="null" /> to leave unchanged.</value> /// <value>The maximum speed, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("speed_max")] [SerializationKey("speed_max")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? SpeedMax { get; set; } public Optional<Vector3d> SpeedMax { get; set; }
/// <summary> /// <summary>
/// Gets or sets the minimum speed. /// Gets or sets the minimum speed.
@ -150,7 +150,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The minimum speed, or <see langword="null" /> to leave unchanged.</value> /// <value>The minimum speed, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("speed_min")] [SerializationKey("speed_min")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? SpeedMin { get; set; } public Optional<Vector3d> SpeedMin { get; set; }
/// <summary> /// <summary>
/// Gets or sets the maximum spin. /// Gets or sets the maximum spin.
@ -158,7 +158,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The maximum spin, or <see langword="null" /> to leave unchanged.</value> /// <value>The maximum spin, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("spin_max")] [SerializationKey("spin_max")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? SpinMax { get; set; } public Optional<Vector3d> SpinMax { get; set; }
/// <summary> /// <summary>
/// Gets or sets the minimum spin. /// Gets or sets the minimum spin.
@ -166,7 +166,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The minimum spin, or <see langword="null" /> to leave unchanged.</value> /// <value>The minimum spin, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("spin_min")] [SerializationKey("spin_min")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? SpinMin { get; set; } public Optional<Vector3d> SpinMin { get; set; }
/// <summary> /// <summary>
/// Gets or sets the maximum start angle. /// Gets or sets the maximum start angle.
@ -174,7 +174,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The maximum start angle, or <see langword="null" /> to leave unchanged.</value> /// <value>The maximum start angle, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("start_angle_max")] [SerializationKey("start_angle_max")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? StartAngleMax { get; set; } public Optional<Vector3d> StartAngleMax { get; set; }
/// <summary> /// <summary>
/// Gets or sets the minimum start angle. /// Gets or sets the minimum start angle.
@ -182,7 +182,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The minimum start angle, or <see langword="null" /> to leave unchanged.</value> /// <value>The minimum start angle, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("start_angle_min")] [SerializationKey("start_angle_min")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? StartAngleMin { get; set; } public Optional<Vector3d> StartAngleMin { get; set; }
/// <summary> /// <summary>
/// Gets or sets the maximum volume. /// Gets or sets the maximum volume.
@ -190,7 +190,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The maximum volume, or <see langword="null" /> to leave unchanged.</value> /// <value>The maximum volume, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("volume_max")] [SerializationKey("volume_max")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? VolumeMax { get; set; } public Optional<Vector3d> VolumeMax { get; set; }
/// <summary> /// <summary>
/// Gets or sets the minimum volume. /// Gets or sets the minimum volume.
@ -198,28 +198,28 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <value>The minimum volume, or <see langword="null" /> to leave unchanged.</value> /// <value>The minimum volume, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("volume_min")] [SerializationKey("volume_min")]
[ValueConverter(typeof(Vector3dConverter))] [ValueConverter(typeof(Vector3dConverter))]
public Vector3d? VolumeMin { get; set; } public Optional<Vector3d> VolumeMin { get; set; }
/// <summary> /// <summary>
/// Gets or sets the tag. /// Gets or sets the tag.
/// </summary> /// </summary>
/// <value>The tag, or <see langword="null" /> to leave unchanged.</value> /// <value>The tag, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("tag")] [SerializationKey("tag")]
public string? Tag { get; set; } public Optional<string> Tag { get; set; }
/// <summary> /// <summary>
/// Gets or sets the texture. /// Gets or sets the texture.
/// </summary> /// </summary>
/// <value>The texture, or <see langword="null" /> to leave unchanged.</value> /// <value>The texture, or <see langword="null" /> to leave unchanged.</value>
[SerializationKey("texture")] [SerializationKey("texture")]
public string? Texture { get; set; } public Optional<string> Texture { get; set; }
/// <summary> /// <summary>
/// Sets the maximum volume. /// Sets the maximum volume.
/// </summary> /// </summary>
/// <param name="value">The maximum volume, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The maximum volume, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithAccelerationMax(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithAccelerationMax(Optional<Vector3d> value)
{ {
AccelerationMax = value; AccelerationMax = value;
return this; return this;
@ -230,7 +230,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The minimum acceleration, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The minimum acceleration, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithAccelerationMin(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithAccelerationMin(Optional<Vector3d> value)
{ {
AccelerationMin = value; AccelerationMin = value;
return this; return this;
@ -241,7 +241,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The blend mode, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The blend mode, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithBlendMode(ParticleBlendMode? value) public VirtualParadiseParticleEmitterObjectBuilder WithBlendMode(Optional<ParticleBlendMode> value)
{ {
BlendMode = value; BlendMode = value;
return this; return this;
@ -252,7 +252,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The maximum color, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The maximum color, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithColorMax(Color? value) public VirtualParadiseParticleEmitterObjectBuilder WithColorMax(Optional<Color> value)
{ {
ColorMax = value; ColorMax = value;
return this; return this;
@ -263,7 +263,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The minimum color, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The minimum color, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithColorMin(Color? value) public VirtualParadiseParticleEmitterObjectBuilder WithColorMin(Optional<Color> value)
{ {
ColorMin = value; ColorMin = value;
return this; return this;
@ -274,7 +274,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The emitter lifespan, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The emitter lifespan, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithEmitterLifespan(TimeSpan? value) public VirtualParadiseParticleEmitterObjectBuilder WithEmitterLifespan(Optional<TimeSpan> value)
{ {
EmitterLifespan = value; EmitterLifespan = value;
return this; return this;
@ -288,7 +288,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// <see langword="null" /> to leave unchanged. /// <see langword="null" /> to leave unchanged.
/// </param> /// </param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithInterpolation(bool? value) public VirtualParadiseParticleEmitterObjectBuilder WithInterpolation(Optional<bool> value)
{ {
Interpolate = value; Interpolate = value;
return this; return this;
@ -299,7 +299,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The opacity, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The opacity, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithOpacity(double? value) public VirtualParadiseParticleEmitterObjectBuilder WithOpacity(Optional<double> value)
{ {
Opacity = value; Opacity = value;
return this; return this;
@ -310,7 +310,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The particle lifespan, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The particle lifespan, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithParticleLifespan(TimeSpan? value) public VirtualParadiseParticleEmitterObjectBuilder WithParticleLifespan(Optional<TimeSpan> value)
{ {
ParticleLifespan = value; ParticleLifespan = value;
return this; return this;
@ -321,7 +321,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The particle type, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The particle type, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithParticleType(ParticleType? value) public VirtualParadiseParticleEmitterObjectBuilder WithParticleType(Optional<ParticleType> value)
{ {
ParticleType = value; ParticleType = value;
return this; return this;
@ -332,7 +332,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The release count, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The release count, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithReleaseCount(int? value) public VirtualParadiseParticleEmitterObjectBuilder WithReleaseCount(Optional<int> value)
{ {
ReleaseCount = value; ReleaseCount = value;
return this; return this;
@ -343,7 +343,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The release time, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The release time, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithReleaseTime(TimeSpan? value) public VirtualParadiseParticleEmitterObjectBuilder WithReleaseTime(Optional<TimeSpan> value)
{ {
ReleaseTime = value; ReleaseTime = value;
return this; return this;
@ -354,7 +354,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The maximum size, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The maximum size, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithSizeMax(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithSizeMax(Optional<Vector3d> value)
{ {
SizeMax = value; SizeMax = value;
return this; return this;
@ -365,7 +365,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The minimum size, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The minimum size, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithSizeMin(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithSizeMin(Optional<Vector3d> value)
{ {
SizeMin = value; SizeMin = value;
return this; return this;
@ -376,7 +376,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The maximum speed, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The maximum speed, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithSpeedMax(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithSpeedMax(Optional<Vector3d> value)
{ {
SpeedMax = value; SpeedMax = value;
return this; return this;
@ -387,7 +387,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The minimum speed, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The minimum speed, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithSpeedMin(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithSpeedMin(Optional<Vector3d> value)
{ {
SpeedMin = value; SpeedMin = value;
return this; return this;
@ -398,7 +398,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The maximum spin, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The maximum spin, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithSpinMax(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithSpinMax(Optional<Vector3d> value)
{ {
SpinMax = value; SpinMax = value;
return this; return this;
@ -409,7 +409,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The minimum spin, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The minimum spin, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithSpinMin(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithSpinMin(Optional<Vector3d> value)
{ {
SpinMin = value; SpinMin = value;
return this; return this;
@ -420,7 +420,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The maximum start angle, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The maximum start angle, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithStartAngleMax(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithStartAngleMax(Optional<Vector3d> value)
{ {
StartAngleMax = value; StartAngleMax = value;
return this; return this;
@ -431,7 +431,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The minimum start angle, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The minimum start angle, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithStartAngleMin(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithStartAngleMin(Optional<Vector3d> value)
{ {
StartAngleMin = value; StartAngleMin = value;
return this; return this;
@ -442,7 +442,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The maximum volume, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The maximum volume, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithVolumeMax(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithVolumeMax(Optional<Vector3d> value)
{ {
VolumeMax = value; VolumeMax = value;
return this; return this;
@ -453,7 +453,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The minimum volume, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The minimum volume, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithVolumeMin(Vector3d? value) public VirtualParadiseParticleEmitterObjectBuilder WithVolumeMin(Optional<Vector3d> value)
{ {
VolumeMin = value; VolumeMin = value;
return this; return this;
@ -464,7 +464,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The tag, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The tag, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithTag(string? value) public VirtualParadiseParticleEmitterObjectBuilder WithTag(Optional<string> value)
{ {
Tag = value; Tag = value;
return this; return this;
@ -475,7 +475,7 @@ public sealed class VirtualParadiseParticleEmitterObjectBuilder : VirtualParadis
/// </summary> /// </summary>
/// <param name="value">The texture, or <see langword="null" /> to leave unchanged.</param> /// <param name="value">The texture, or <see langword="null" /> to leave unchanged.</param>
/// <returns>The current instance.</returns> /// <returns>The current instance.</returns>
public VirtualParadiseParticleEmitterObjectBuilder WithTexture(string? value) public VirtualParadiseParticleEmitterObjectBuilder WithTexture(Optional<string> value)
{ {
Texture = value; Texture = value;
return this; return this;

108
VpSharp/src/Optional.cs Normal file
View File

@ -0,0 +1,108 @@
namespace VpSharp;
#pragma warning disable CA1716
#pragma warning disable CA2225
/// <summary>
/// Represents an optional value.
/// </summary>
/// <typeparam name="T">The type of the value.</typeparam>
public readonly struct Optional<T> : IEquatable<Optional<T>>
{
private readonly T? _value;
/// <summary>
/// Initializes a new instance of the <see cref="Optional{T}" /> struct.
/// </summary>
/// <param name="value"></param>
public Optional(T? value)
{
HasValue = true;
_value = value;
}
/// <summary>
/// Gets a value indicating whether this <see cref="Optional{T}" /> has a value.
/// </summary>
/// <value><see langword="true" /> if a value is defined; otherwise, <see langword="false" />.</value>
public bool HasValue { get; }
/// <summary>
/// Gets the underlying value of this optional.
/// </summary>
/// <value>The value.</value>
public T? Value
{
get
{
if (!HasValue)
{
throw new InvalidOperationException("Cannot access the value of a valueless optional.");
}
return _value;
}
}
/// <summary>
/// Returns a value indicating whether two instances of <see cref="Optional{T}" /> are equal.
/// </summary>
/// <param name="left">The first <see cref="Optional{T}" />.</param>
/// <param name="right">The second <see cref="Optional{T}" />.</param>
/// <value><see langword="true" /> if the two instances are equal; otherwise, <see langword="false" />.</value>
public static bool operator ==(Optional<T> left, Optional<T> right)
{
return left.Equals(right);
}
/// <summary>
/// Returns a value indicating whether two instances of <see cref="Optional{T}" /> are not equal.
/// </summary>
/// <param name="left">The first <see cref="Optional{T}" />.</param>
/// <param name="right">The second <see cref="Optional{T}" />.</param>
/// <value><see langword="true" /> if the two instances are not equal; otherwise, <see langword="false" />.</value>
public static bool operator !=(Optional<T> left, Optional<T> right)
{
return !left.Equals(right);
}
/// <summary>
/// Implicitly converts a value to a new instance of <see cref="Optional{T}" />.
/// </summary>
/// <returns>A new instance of <see cref="Optional{T}" />, wrapping <paramref name="value" />.</returns>
public static implicit operator Optional<T>(T? value)
{
return new Optional<T>(value);
}
/// <summary>
/// Implicitly converts a value to a new instance of <see cref="Optional{T}" />.
/// </summary>
/// <returns>A new instance of <see cref="Optional{T}" />, wrapping <paramref name="value" />.</returns>
public static explicit operator T?(Optional<T?> value)
{
return value.Value;
}
/// <summary>
/// Returns a value indicating whether this <see cref="Optional{T}" /> and another <see cref="Optional{T}" /> are equal.
/// </summary>
/// <param name="other">The other <see cref="Optional{T}" />.</param>
/// <value><see langword="true" /> if the two instances are equal; otherwise, <see langword="false" />.</value>
public bool Equals(Optional<T> other)
{
return HasValue == other.HasValue && EqualityComparer<T?>.Default.Equals(Value, other._value);
}
/// <inheritdoc />
public override bool Equals(object? obj)
{
return obj is Optional<T> other && Equals(other);
}
/// <inheritdoc />
public override int GetHashCode()
{
return HashCode.Combine(HasValue, Value);
}
}