Merge pull request #10 from wad4444/v2

Release 2.0.0

Author: wad4444

.gitignore

@@ -2,4 +2,6 @@
 /out
 /include
 *.tsbuildinfo
-/testing/out
+/testing/out
+/testing/include
+flamework.build

README.md

@@ -1,12 +1,10 @@
-## WCS - A combat system framework
-
-**WCS** is a *handy framework* that provides *useful abstraction* for your *combat systems*. It allows you to create **any kind of combat system** with **ease**, providing *tools* and *covering basic and tedious stuff*, like *replication*, *skill creation*, side effects, requests to server.*
-
-**WCS** is made utilizing **[Typescript](<https://typescriptlang.org/>)** and compiled to luau using **[roblox-ts](<https://roblox-ts.com/>)**. It provides support for
-[roblox-ts](<https://roblox-ts.com/>) users and [luau](<https://luau-lang.org/>) users,
-by providing type definitions for both languages.
-
-Please give feedback
-
-[**Documentation**](<https://wad4444.github.io/WCS/>)
-[**GitHub Repository**](<https://github.com/wad4444/WCS>)
+<div align="center">
+	<img src="docs/static/img/logo.svg" alt="WCS" width="150" />
+	<br>
+	<h style="font-size:2em;"><strong>WCS - A combat system framework<strong/></h>
+	<br>
+	<a style="font-size: 1.5em" href="https://wad4444.github.io/WCS/"><strong>View docs &rarr;</strong></a>
+  <br><br><br>
+
+  Made with love by [@wAD](https://github.com/wad4444)❤️
+</div>

default.project.json

@@ -12,6 +12,9 @@
 				"$className": "Folder",
 				"@rbxts": {
 					"$path": "node_modules/@rbxts"
+				},
+				"@flamework": {
+					"$path": "node_modules/@flamework"
 				}
 			}
 		}

docs/docs/api/character.md

@@ -43,9 +43,11 @@ Retrieves the character associated with the given instance.
 ## Fields
 
 ### `Instance` **@readonly**
-
 An instance *Character* object is attached to.
 
+### `DisableSkills`
+A boolean value. Character's skills cannot be started if true.
+
 ### `Humanoid` **@readonly**
 A [Humanoid](https://create.roblox.com/docs/reference/engine/classes/Humanoid) associated with character's *instance*.
 
@@ -66,6 +68,18 @@ Retrieved internally by `Players:GetPlayerFromCharacter(self.Instance)`.
 **`Parameters:`**
 * Skill: `Skill` - [A skill](./skill.md) that got removed.
 
+### `SkillStarted`
+**An event**. Gets fired when [a skill](./skill.md) that is assigned to the character starts.
+
+**`Parameters:`**
+* Skill: `Skill` - [A skill](./skill.md) that got started.
+
+### `SkillEnded`
+**An event**. Gets fired when [a skill](./skill.md) that is assigned to the character ends.
+
+**`Parameters:`**
+* Skill: `Skill` - [A skill](./skill.md) that got ended.
+
 ### `StatusEffectAdded`
 **An event**. Gets fired when [a status effect](./statusEffect.md) gets added to the character.
 
@@ -78,6 +92,18 @@ Gets fired when [a status effect](./statusEffect.md) gets removed from the chara
 **`Parameters:`**
 * Status: `StatusEffect` - [A status effect](./skill.md) that got removed.
 
+### `StatusEffectStarted`
+**An event**. Gets fired when [a status effect](./statusEffect.md) that is assigned to the character starts.
+
+**`Parameters:`**
+* Status: `StatusEffect` - [A status effect](./skill.md) that got started.
+
+### `StatusEffectEnded`
+Gets fired when [a status effect](./statusEffect.md) that is assigned to the character ends.
+
+**`Parameters:`**
+* Status: `StatusEffect` - [A status effect](./skill.md) that got ended.
+
 ### `HumanoidPropertiesUpdated`
 Gets fired when character's [humanoid data](../tutorial/statuses/humanoid-data.md) gets updated.
 
@@ -150,7 +176,7 @@ Returns the calculated damage.
 Sets default humanoid properties of the character.
 
 **`Parameters:`**
-* Properties: `AffectableHumanoidProps` - A map of a `PropertyName` and it's `Value`.
+* Properties: `AffectableHumanoidProps` - A map of a `PropertyName` and its `Value`.
 
 <Tabs groupId="languages">
 <TabItem value="TypeScript" default>
@@ -177,7 +203,13 @@ Char:SetDefaultProps({
 Retrieves the default humanoid properties of the character.
 
 **`Returns`**
- * Properties: `AffectableHumanoidProps` - A map of a `PropertyName` and it's `Value`.
+ * Properties: `AffectableHumanoidProps` - A map of a `PropertyName` and its `Value`.
+
+### `GetAppliedProps()`
+Retrieves the currently applied humanoid properties, depending on current `HumanoidData`.
+
+**`Returns`**
+ * Properties: `AffectableHumanoidProps` - A map of a `PropertyName` and its `Value`.
 
 ### `GetAllStatusEffect()`
 Retrieves all status effects.
@@ -243,6 +275,12 @@ Applies a [Moveset] to the character.
 * Moveset: `Moveset | string` - A [Moveset] object or it's name.
 
 ### `GetMoveset()`
+Returns the current [Moveset].
+
+**`Returns`**
+ * Moveset: `Moveset?`
+
+### `GetMovesetName()`
 Returns the current [Moveset]'s name.
 
 **`Returns`**

docs/docs/api/skill.md

@@ -19,23 +19,23 @@ import TOCInline from "@theme/TOCInline";
 
 ## Fields
 
-### `Janitor` @readonly
+### `Janitor` **@readonly**
 A [Janitor] object. Cleans up everything after skill ends.
 
-### `CooldownTimer` @readonly
+### `CooldownTimer` **@readonly**
 A [Timer] object. Starts, when `ApplyCooldown()` gets invoked on server. Does not sync to client.
 
-### `Character` @readonly
+### `Character` **@readonly**
 A [Character] object this skill is tied with.
 
-### `Player` @readonly
+### `Player` **@readonly**
 A [Player](https://create.roblox.com/docs/reference/engine/classes/Player) object the skill is associated with.
 Retrieved internally by `Players:GetPlayerFromCharacter(self.Character.Instance)`.
 
-### `Name` @readonly
+### `Name` **@readonly**
 A string value.
 
-### `ConstructorArguments` @readonly
+### `ConstructorArguments` **@readonly**
 A table of arguments provided after the [Character] in `.new()`.
 
 ### `CheckOthersActive`
@@ -44,6 +44,9 @@ A boolean value. Checks whenever other skills should be non active for :Start()
 ### `CheckedByOthers`
 A boolean value. Determines if other skills should check if the skill is active to proceed.
 
+### `ParamValidators`
+An array of `Validator` functions that validate your starter params.
+
 ### `MutualExclusives`
 `Constructor<AnyStatus>[]`. An array of [Status Effect] constructors. If any of them is applied to [Character] object whenever `Start()` is called,
 it will not proceed further and skill will not be started.
@@ -106,6 +109,9 @@ Returns true if the skill is destroyed / removed from the [Character].
 ### `End()`
 Force end the skill. This is automatically called after OnStartServer() is completed.
 
+### `Stop()` @alias
+Ends the skill. Alias for `End()`.
+
 ### `GetSkillType()`
 Retrieves the skill type.
 

docs/docs/api/statusEffect.md

@@ -12,13 +12,21 @@ import TOCInline from "@theme/TOCInline";
 [Character]: ../api/character.md
 [Timer]: https://www.npmjs.com/package/@rbxts/timer
 [Metadata]: ../tutorial/extras/metadata.md
+[Janitor]: https://howmanysmall.github.io/Janitor/
 
 ## Fields
 
-### `Character` @readonly
+### `Character` **@readonly**
 A [Character] object this status effect is tied with.
 
-### `ConstructorArguments` @readonly
+### `Janitor` **@readonly**
+A [Janitor] object. Cleans up everything after skill ends.
+
+### `Player` **@readonly**
+A [Player](https://create.roblox.com/docs/reference/engine/classes/Player) object the skill is associated with.
+Retrieved internally by `Players:GetPlayerFromCharacter(self.Character.Instance)`.
+
+### `ConstructorArguments` **@readonly**
 A table of arguments provided after the [Character] in `.new()`.
 
 ### `DestroyOnEnd`
@@ -76,11 +84,11 @@ Starts the status effect.
 **`Parameters:`**
 * Time: `number?`
 
-### `Stop()`
-Stops the status effect.
+### `End()` 
+Ends the status effect. 
 
-### `End()` @alias
-Stops the status effect. Alias for `Stop()`.
+### `Stop()` @alias
+Ends the status effect. Alias for `End()`.
 
 ### `Pause()`
 Pauses the internal status effect [Timer].

docs/docs/api/wcs.md

@@ -19,104 +19,65 @@ If called more than once returns the same [server](./server.md) object.
 **`Returns:`**
 * [Server](./server.md)
 
-<Tabs groupId="languages">
-<TabItem value="TypeScript" default>
-
-```ts
-const Server = CreateServer();
-```
-
-</TabItem>
-<TabItem value="Luau">
-
-```lua
-local Server = WCS.CreateServer()
-```
-
-</TabItem>
-</Tabs>
-
 ## `CreateClient()`
 Creates a [Client](./client.md) object and returns it.
 If called more than once returns the same [client](./client.md) object.
 
-<Tabs groupId="languages">
-<TabItem value="TypeScript" default>
-
-```ts
-const Client = CreateClient();
-```
-
-</TabItem>
-<TabItem value="Luau">
-
-```lua
-local Client = WCS.CreateClient()
-```
-
-</TabItem>
-</Tabs>
-
 **`Returns:`**
 * [Client](./client.md)
 
-## `RegisterStatusEffect(name)`
+## `RegisterStatusEffect(name, extendsFrom)`
 Registers a new [status effect](./statusEffect.md) with name specified in an argument.
 
 **`Parameters:`**
 * Name: `string`
+* ExtendsFrom: `StatusEffectImpl` 
 
 **`Returns:`**
 * [StatusEffect](./statusEffect.md)
 
-```lua
-local SpeedBoost = WCS.RegisteredStatusEffect("SpeedBoost")
-```
-
-## `RegisterSkill(name)`
+## `RegisterSkill(name, extendsFrom)`
 Registers a new [skill](./skill.md) with name specified in an argument.
 
 **`Parameters:`**
 * Name: `string`
+* ExtendsFrom: `Skill` 
 
 **`Returns:`**
 * [Skill](./skill.md)
 
-```lua
-local Attack = WCS.RegisterSkill("Attack")
-```
+## `RegisterHoldableSkill(name, extendsFrom)`
+Registers a new [holdable skill](../tutorial/skills/holdable.md) with name specified in an argument.
+
+**`Parameters:`**
+* Name: `string`
+* ExtendsFrom: `Skill` 
 
-## `Character`
-An exported [character](./character.md) class. Cannot be changed.
+**`Returns:`**
+* [Holdable Skill](../tutorial/skills/holdable.md)
+
+## `DefineMessage(fn, config)`
+Registers a [message](../tutorial/messages/intro.md).
+
+**`Parameters:`**
+* Function: `function`
+* Config: `MessageConfig`
+
+## `Character` **@readonly**
+An exported [character](./character.md) class.
 
-## `CreateMoveset(name, skills)`
+## `CreateMoveset(name, skills, constructorArgs)`
 Creates a [Moveset] object and returns it.
 Accepts the name and array of skills.
 
 **`Parameters:`**
 * Name: `string`
 * Skills: ```{AnySkillConstructor}```
+* ConstructorArguments: ```{[string | SkillImpl]: any[]}``` - an object that contains array of `ConstructorArguments` that skill should get instantiated with.
 
 **`Returns:`**
 * [Moveset]
 
-<Tabs groupId="languages">
-<TabItem value="TypeScript" default>
-
-```ts
-const Moveset = CreateMoveset("Mage", [Attack]);
-```
-
-</TabItem>
-<TabItem value="Luau">
-
-```lua
-local Client = WCS.CreateMoveset("Mage", {Attack})
-```
-
-</TabItem>
-</Tabs>
-
 ## `GetMovesetObjectByName(name)`
 Retrieves [Moveset] object by its name if registered.
 
@@ -126,27 +87,9 @@ Retrieves [Moveset] object by its name if registered.
 **`Returns:`**
 * Moveset: [`Moveset?`](../tutorial/extras/movesets.md)
 
-<Tabs groupId="languages">
-<TabItem value="TypeScript" default>
-
-```ts
-const Moveset = GetMovesetObjectByName("Mage");
-```
-
-</TabItem>
-<TabItem value="Luau">
-
-```lua
-local Moveset = WCS.GetMovesetObjectByName("Mage")
-```
-
-</TabItem>
-</Tabs>
-
 ## `SkillType`
 An exported skill type enum.
 
-
 `Members:`
 ```
 Default,

docs/docs/tutorial/basics/client-server.md

@@ -89,9 +89,9 @@ local WCS = require(ReplicatedStorage.WCS)
 
 local Client = WCS.CreateClient()
 
-Client:RegisterDirectory(ReplicatedStorage.TS.movesets)
-Client:RegisterDirectory(ReplicatedStorage.TS.skills)
-Client:RegisterDirectory(ReplicatedStorage.TS.statusEffects)
+Client:RegisterDirectory(ReplicatedStorage.movesets)
+Client:RegisterDirectory(ReplicatedStorage.skills)
+Client:RegisterDirectory(ReplicatedStorage.statusEffects)
 
 Client:Start()
 ```