From 5522bc443dbd7bc006730d1a16cf6bed88ddc525 Mon Sep 17 00:00:00 2001
From: Cenk Ergen <57065323+Cenngo@users.noreply.github.com>
Date: Thu, 3 Mar 2022 03:02:12 +0300
Subject: [PATCH] Create Complex Params Docs (#2160)

* create complex params docs

* Update docs/guides/int_framework/intro.md

Co-authored-by: Quin Lynch <49576606+quinchs@users.noreply.github.com>
---
 docs/guides/int_framework/intro.md            | 15 ++++++++
 .../samples/intro/complexparams.cs            | 37 +++++++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100644 docs/guides/int_framework/samples/intro/complexparams.cs

diff --git a/docs/guides/int_framework/intro.md b/docs/guides/int_framework/intro.md
index 0a5cc19f1..764a100fe 100644
--- a/docs/guides/int_framework/intro.md
+++ b/docs/guides/int_framework/intro.md
@@ -143,6 +143,21 @@ In this case, user can only input Stage Channels and Text Channels to this param
 
 You can specify the permitted max/min value for a number type parameter using the [MaxValueAttribute] and [MinValueAttribute].
 
+#### Complex Parameters
+
+This allows users to create slash command options using an object's constructor allowing complex objects to be created which cannot be infered from only one input value.
+Constructor methods support every attribute type that can be used with the regular slash commands ([Autocomplete], [Summary] etc. ).
+Preferred constructor of a Type can be specified either by passing a `Type[]` to the `[ComplexParameterAttribute]` or tagging a type constructor with the `[ComplexParameterCtorAttribute]`. If nothing is specified, the InteractionService defaults to the only public constructor of the type.
+TypeConverter pattern is used to parse the constructor methods objects.
+
+[!code-csharp[Complex Parameter](samples/intro/usercommand.cs)]
+
+Interaction service complex parameter constructors are prioritized in the following order:
+
+1. Constructor matching the signature provided in the `[ComplexParameter(Type[])]` overload.
+2. Constuctor tagged with `[ComplexParameterCtor]`.
+3. Type's only public constuctor.
+
 ## User Commands
 
 A valid User Command must have the following structure:
diff --git a/docs/guides/int_framework/samples/intro/complexparams.cs b/docs/guides/int_framework/samples/intro/complexparams.cs
new file mode 100644
index 000000000..72c0616cc
--- /dev/null
+++ b/docs/guides/int_framework/samples/intro/complexparams.cs
@@ -0,0 +1,37 @@
+public class Vector3
+{
+    public int X {get;}
+    public int Y {get;}
+    public int Z {get;}
+
+    public Vector3()
+    {
+        X = 0;
+        Y = 0;
+        Z = 0;
+    }
+
+    [ComplexParameterCtor]
+    public Vector3(int x, int y, int z)
+    {
+        X = x;
+        Y = y;
+        Z = z;
+    }
+}
+
+// Both of the commands below are displayed to the users identically.
+
+// With complex parameter
+[SlashCommand("create-vector", "Create a 3D vector.")]
+public async Task CreateVector([ComplexParameter]Vector3 vector3)
+{
+    ...
+}
+
+// Without complex parameter
+[SlashCommand("create-vector", "Create a 3D vector.")]
+public async Task CreateVector(int x, int y, int z)
+{
+    ...
+}
\ No newline at end of file