Skip to content

Commit

Permalink
v4 source commit
Browse files Browse the repository at this point in the history
  • Loading branch information
James committed Oct 12, 2023
1 parent 46e98fb commit 32be85f
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/api/engine/framework/canaryengineclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ Gets the players current character model; if it doesn't exist the thread will yi

**Returns**

* **[Future](https://util.redblox.dev/future.html#methods)<[Character](/api/engine/types#character)>**
* **[Character](/api/engine/types#character)**
27 changes: 25 additions & 2 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,37 @@ keywords: [roblox, game, framework, changelog, updates]

This is the changelog which is changed every update, and we follow semver. To see what we're working on, head to our [Trello](https://trello.com/b/fTJOmMua/canaryengine) board.

## 4.0.0

(Includes rc1-2)

---

### Added

* Rewrote plugin features
* Add package manager to plugin
* Add ability to add custom packages to manager
* Add `Snacky` to Canary Suite

### Improvements

* Improves internal API, should be significantly faster
* Improves networking / signal APIs, tuples are now allowed
* Improves default structure, changed names of all folders to fit developers' needs
* Improve UIShelf, adds text icons + improved menus

### Removed

* Deprecated functions

## 4.0.0-rc2

### Added

* Adds `Red`, revamped the networking system once again and for the last time
* Adds `NetworkController:FireFilter`
* Adds `CanaryEngine.ImportPackagesInOrder`
* Adds `CanaryEngine.ImportPackagesInOrder`2
* Finish API documentation

### Improvements
Expand Down Expand Up @@ -43,7 +67,6 @@ This is the changelog which is changed every update, and we follow semver. To se
* Improves EasyProfile ([#3](https://github.com/canary-development/CanaryEngine/pull/3), [koxx12](https://github.com/koxx12-dev))
* Renames `CanaryEngineFramework` instance to `Framework`
* Renames `CanaryEngine` module to `Init`
* Fixed TS support, back on roblox-ts!
* Small bug fixes
* QOL fixes
* Most yielding functions now make usage of Futures
Expand Down
26 changes: 12 additions & 14 deletions plugin/src/json/structure.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"EngineClient": {
"Client": {
"Packages": {},
"Assets": {
"Models": {},
Expand All @@ -10,7 +10,7 @@
},
"Scripts": {}
},
"EngineReplicated": {
"Replicated": {
"Packages": {},
"Assets": {
"Sounds": {},
Expand All @@ -19,21 +19,19 @@
"Effects": {}
}
},
"EngineReplicatedFirst": {
"Framework": {
"EngineLoader": {
"Init": {
"$className": "ModuleScript",
"$properties": {
"Source": "https://raw.githubusercontent.com/canary-development/CanaryEngine/main/src/lua/framework/Vendor/Libraries/EngineLoader/init.luau"
}
},
"Vendor": "EngineLoaderAssets"
}
"PriorityLoad": {
"FrameworkLoader": {
"Init": {
"$className": "ModuleScript",
"$properties": {
"Source": "https://raw.githubusercontent.com/canary-development/CanaryEngine/main/src/lua/framework/Vendor/Libraries/EngineLoader/init.luau"
}
},
"Vendor": "EngineLoaderAssets"
},
"Scripts": {}
},
"EngineServer": {
"Server": {
"Packages": {},
"Assets": {
"Models": {},
Expand Down
7 changes: 3 additions & 4 deletions src/lua/framework/init.luau
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,9 @@ end

-- Context Specific Functions

function CanaryEngineClient.GetPlayerCharacter(): Future.Future<Types.Character>
return Future.new(function(player)
return player.Character or player.CharacterAdded:Wait()
end, PlayerService.LocalPlayer)
function CanaryEngineClient.GetPlayerCharacter(): Types.Character
local Player = PlayerService.LocalPlayer
return Player.Character or Player.CharacterAdded:Wait()
end

CanaryEngineClient.CreateNetworkController = CreateNetworkController :: (controllerName: string) -> (Network.Client<...any>)
Expand Down

0 comments on commit 32be85f

Please sign in to comment.