Skip to content

Commit

Permalink
Update links to the API
Browse files Browse the repository at this point in the history
  • Loading branch information
willeastcott committed Jan 31, 2024
1 parent dd3abb8 commit 2b3baea
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
20 changes: 10 additions & 10 deletions _posts/2014-01-16-new-math-api-a-transition-guide.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -101,20 +101,20 @@ We strongly urge you to check out the API reference pages for the new API. We've

Reference pages can be found here:

- [`pc.Vec2`](https://developer.playcanvas.com/en/api/pc.Vec2.html) - A 2-dimensional vector
- [`pc.Vec3`](https://developer.playcanvas.com/en/api/pc.Vec3.html) - A 3-dimensional vector
- [`pc.Vec4`](https://developer.playcanvas.com/en/api/pc.Vec4.html) - A 4-dimensional vector
- [`pc.Mat4`](https://developer.playcanvas.com/en/api/pc.Mat4.html) - A 4x4 matrix
- [`pc.Quat`](https://developer.playcanvas.com/en/api/pc.Vec2.html) - A quaternion
- [`pc.Vec2`](https://api.playcanvas.com/classes/Engine.Vec2.html) - A 2-dimensional vector
- [`pc.Vec3`](https://api.playcanvas.com/classes/Engine.Vec3.html) - A 3-dimensional vector
- [`pc.Vec4`](https://api.playcanvas.com/classes/Engine.Vec4.html) - A 4-dimensional vector
- [`pc.Mat4`](https://api.playcanvas.com/classes/Engine.Mat4.html) - A 4x4 matrix
- [`pc.Quat`](https://api.playcanvas.com/classes/Engine.Quat.html) - A quaternion

### Unrelated Changes

Since we have made such sweeping API changes, we have also taken the opportunity to remove some deprecated functions. The following are no longer in the engine:

- `pc.fw.RigidBodyComponent#get/setLinearVelocity` - use [`linearVelocity`](https://developer.playcanvas.com/en/api/pc.RigidBodyComponent.html#linearVelocity) property
- `pc.fw.RigidBodyComponent#get/setAngularVelocity` - use [`angularVelocity`](https://developer.playcanvas.com/en/api/pc.RigidBodyComponent.html#angularVelocity) property
- `pc.fw.RigidBodyComponent#get/setLinearFactor` - use [`linearFactor`](https://developer.playcanvas.com/en/api/pc.RigidBodyComponent.html#linearFactor) property
- `pc.fw.RigidBodyComponent#get/setAngularFactor` - use [`angularFactor`](https://developer.playcanvas.com/en/api/pc.RigidBodyComponent.html#angularFactor) property
- `pc.scene.Scene#get/setGlobalAmbient` - use [`ambientLight`](https://developer.playcanvas.com/en/api/pc.Scene.html#ambientLight) property
- `pc.fw.RigidBodyComponent#get/setLinearVelocity` - use [`linearVelocity`](https://api.playcanvas.com/classes/Engine.RigidBodyComponent.html#linearVelocity) property
- `pc.fw.RigidBodyComponent#get/setAngularVelocity` - use [`angularVelocity`](https://api.playcanvas.com/classes/Engine.RigidBodyComponent.html#angularVelocity) property
- `pc.fw.RigidBodyComponent#get/setLinearFactor` - use [`linearFactor`](https://api.playcanvas.com/classes/Engine.RigidBodyComponent.html#linearFactor) property
- `pc.fw.RigidBodyComponent#get/setAngularFactor` - use [`angularFactor`](https://api.playcanvas.com/classes/Engine.RigidBodyComponent.html#angularFactor) property
- `pc.scene.Scene#get/setGlobalAmbient` - use [`ambientLight`](https://api.playcanvas.com/classes/Engine.Scene.html#ambientLight) property

We hope you like the new interface!
2 changes: 1 addition & 1 deletion _posts/2014-06-04-playcanvas-goes-open-source.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The entire runtime engine is available right now on [GitHub](https://github.com/

Ever since we started the engine open source was always on our mind. We've never hidden the source code from developers. Minified versions are available for performance reasons, but during development users always have had full access to the un-mangled engine. This is critical for debugging and fulfilling our mantra to _make game development easier_.

In reality the engine has been open source since the get go. Officially open sourcing the project was just a matter of time, and the time is now. The engine is mature enough that we've established the basic structure, style and functionality but contributors will still be able to make a meaningful contributions to the engine. And of course we've now found the time to lay down the foundations of the [developer documentation](https://developer.playcanvas.com), the [API reference](https://developer.playcanvas.com/en/api/), the [samples](https://playcanvas.github.io) and all the other stuff that makes game development a joy not a chore.
In reality the engine has been open source since the get go. Officially open sourcing the project was just a matter of time, and the time is now. The engine is mature enough that we've established the basic structure, style and functionality but contributors will still be able to make a meaningful contributions to the engine. And of course we've now found the time to lay down the foundations of the [developer documentation](https://developer.playcanvas.com), the [API reference](https://api.playcanvas.com), the [samples](https://playcanvas.github.io) and all the other stuff that makes game development a joy not a chore.

For developers who just want to hack on the code with the overhead of the tools this news is great. Simply download the engine, open up your text editor and get cracking. For those of you who want more structure, and higher level tools, the [PlayCanvas platform](https://playcanvas.com) is a perfect addition to accelerate your game production.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The feedback we've been getting is that your projects are continuing to grow. Mo

[![tags](/assets/media/tags.gif)](/assets/media/tags.gif)

To search for Assets, we have introduced a new [pc.Tags API](https://developer.playcanvas.com/en/api/pc.Tags.html). Let's quickly look at some examples:
To search for Assets, we have introduced a new [pc.Tags API](https://api.playcanvas.com/classes/Engine.Tags.html). Let's quickly look at some examples:

```javascript
// Return all assets tagged by 'level-1'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ These features open up a whole bunch of doors with what you can do with audio in

[![analyzer-thin](/assets/media/analyser-thin1.jpg)](/assets/media/analyser-thin1.jpg)

To help you get up to speed with all the new features, we've update the [documentation](https://developer.playcanvas.com/en/user-manual/packs/components/sound/) and the [reference api](https://developer.playcanvas.com/en/api/pc.SoundComponent.html).
To help you get up to speed with all the new features, we've update the [documentation](https://developer.playcanvas.com/en/user-manual/packs/components/sound/) and the [reference api](https://api.playcanvas.com/classes/Engine.SoundComponent.html).

But we've also created a few tutorials to show you how it all works.

Expand Down
2 changes: 1 addition & 1 deletion _posts/2016-11-08-webvr-support-in-playcanvas.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ It's still early days for WebVR which means it's not yet supported on all platfo

### Tutorials and Documentation

PlayCanvas is renowned for its extensive documentation and VR is no different. [Basic instructions](https://developer.playcanvas.com/en/user-manual/xr/vr/), [API reference](https://developer.playcanvas.com/en/api/pc.XrManager.html) and [specific optimization tips](https://developer.playcanvas.com/en/user-manual/xr/optimizing-webxr/), we've got it all.
PlayCanvas is renowned for its extensive documentation and VR is no different. [Basic instructions](https://developer.playcanvas.com/en/user-manual/xr/vr/), [API reference](https://api.playcanvas.com/classes/Engine.XrManager.html) and [specific optimization tips](https://developer.playcanvas.com/en/user-manual/xr/optimizing-webxr/), we've got it all.

### Samples and Starter Kits

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tags:
- examples
---

PlayCanvas has a rich JavaScript API that allows you to build just about any type of interactive content imaginable - games, playable ads, product configurators, AR, VR and more! But learning a new API can be tough. Reading [API reference documentation](https://developer.playcanvas.com/en/api/) is all well and good, but many people prefer to learn by experimentation. And by examining the code of real world examples. This led the PlayCanvas team to build a new application: the Engine Examples Browser.
PlayCanvas has a rich JavaScript API that allows you to build just about any type of interactive content imaginable - games, playable ads, product configurators, AR, VR and more! But learning a new API can be tough. Reading [API reference documentation](https://api.playcanvas.com) is all well and good, but many people prefer to learn by experimentation. And by examining the code of real world examples. This led the PlayCanvas team to build a new application: the Engine Examples Browser.

{% include youtube.html id="vv6Hyy8ohMc" %}

Expand Down

0 comments on commit 2b3baea

Please sign in to comment.