Skip to content

Commit 5ee4597

Browse files
adriengivryadriengivry
committed
Added examples, fixed links, added lua type in page name
1 parent 2aa3fe7 commit 5ee4597

49 files changed

Lines changed: 386 additions & 203 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Documentation/content/lua/components/AmbientBoxLight.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
+++
2+
title = 'AmbientBoxLight'
3+
+++
4+
15
### Description
26
Represents an ambient light with a box shape
37

4-
- C++ related class: [`OvCore::ECS::Components::CAmbientBoxLight`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAmbientBoxLight.h)
5-
- Inherits from lua usertype: [`Light`](Light)
8+
- C++ related class: [`OvCore::ECS::Components::CAmbientBoxLight`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAmbientBoxLight.h)
9+
- Inherits from lua usertype: [`Light`](../Light)
610

711
### Variables
812
_This usertype has no variables_

‎Documentation/content/lua/components/AmbientSphereLight.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
+++
2+
title = 'AmbientSphereLight'
3+
+++
4+
15
### Description
26
Represents an ambient light with a sphere shape
37

4-
- C++ related class: [`OvCore::ECS::Components::CAmbientSphereLight`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAmbientSphereLight.h)
5-
- Inherits from lua usertype: [`Light`](Light)
8+
- C++ related class: [`OvCore::ECS::Components::CAmbientSphereLight`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAmbientSphereLight.h)
9+
- Inherits from lua usertype: [`Light`](../Light)
610

711
### Variables
812
_This usertype has no variables_

‎Documentation/content/lua/components/AudioListener.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
+++
2+
title = 'AudioListener'
3+
+++
4+
15
### Description
26
Represents an audio listener. The distance between audio sources and audio listener will affect the sound
37
attenuation of spatialized sounds
48

5-
- C++ related class: [`OvCore::ECS::Components::CAudioListener`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAudioListener.h)
6-
- Inherits from lua usertype: [`Component`](Component)
9+
- C++ related class: [`OvCore::ECS::Components::CAudioListener`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAudioListener.h)
10+
- Inherits from lua usertype: [`Component`](../Component)
711

812
### Variables
913
_This usertype has no variables_

‎Documentation/content/lua/components/AudioSource.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
+++
2+
title = 'AudioSource'
3+
+++
4+
15
### Description
26
Represents an audio source. Its position in the world is important if the spatial sound settings is on
37

4-
- C++ related class: [`OvCore::ECS::Components::CAudioSource`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAudioSource.h)
5-
- Inherits from lua usertype: [`Component`](Component)
8+
- C++ related class: [`OvCore::ECS::Components::CAudioSource`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAudioSource.h)
9+
- Inherits from lua usertype: [`Component`](../Component)
610

711
### Variables
812
_This usertype has no variables_

‎Documentation/content/lua/components/Camera.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
+++
2+
title = 'Camera'
3+
+++
4+
15
### Description
26
Represents a camera entity. Its position will determine its view matrix
37

4-
- C++ related class: [`OvCore::ECS::Components::CCamera`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CCamera.h)
5-
- Inherits from lua usertype: [`Component`](Component)
8+
- C++ related class: [`OvCore::ECS::Components::CCamera`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CCamera.h)
9+
- Inherits from lua usertype: [`Component`](../Component)
610

711
### Variables
812
_This usertype has no variables_

‎Documentation/content/lua/components/Component.md‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1+
+++
2+
title = 'Component'
3+
+++
4+
15
### Description
26
A component is a set of data and behaviours (Entity-Component without systems) that is interpreted by the engine (Or the user)
37

4-
- C++ related class: [`OvCore::ECS::Components::AComponent`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/AComponent.h)
8+
- C++ related class: [`OvCore::ECS::Components::AComponent`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/AComponent.h)
59
- Inherited by lua usertypes:
6-
- [`Transform`](Transform)
7-
- [`Camera`](Camera)
8-
- [`MaterialRenderer`](MaterialRenderer)
9-
- [`ModelRenderer`](ModelRenderer)
10-
- [`Light`](Light)
11-
- [`PhysicalObject`](PhysicalObject)
12-
- [`AudioListener`](AudioListener)
13-
- [`AudioSource`](AudioSource)
14-
- [`PostProcessStack`](PostProcessStack)
15-
- [`ReflectionProbe`](ReflectionProbe)
10+
- [`Transform`](../Transform)
11+
- [`Camera`](../Camera)
12+
- [`MaterialRenderer`](../MaterialRenderer)
13+
- [`ModelRenderer`](../ModelRenderer)
14+
- [`Light`](../Light)
15+
- [`PhysicalObject`](../PhysicalObject)
16+
- [`AudioListener`](../AudioListener)
17+
- [`AudioSource`](../AudioSource)
18+
- [`PostProcessStack`](../PostProcessStack)
19+
- [`ReflectionProbe`](../ReflectionProbe)
1620

1721
### Variables
1822
_This usertype has no variables_

‎Documentation/content/lua/components/DirectionalLight.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
+++
2+
title = 'DirectionalLight'
3+
+++
4+
15
### Description
26
A simple light that has no attenuation and that has a direction
37

4-
- C++ related class: [`OvCore::ECS::Components::CDirectionalLight`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CDirectionalLight.h)
5-
- Inherits from lua usertype: [`Light`](Light)
8+
- C++ related class: [`OvCore::ECS::Components::CDirectionalLight`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CDirectionalLight.h)
9+
- Inherits from lua usertype: [`Light`](../Light)
610

711
### Variables
812
_This usertype has no variables_

‎Documentation/content/lua/components/Light.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1+
+++
2+
title = 'Light'
3+
+++
4+
15
### Description
26
Base class for any light
37

4-
- C++ related class: [`OvCore::ECS::Components::CLight`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CLight.h)
8+
- C++ related class: [`OvCore::ECS::Components::CLight`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CLight.h)
59
- Inherits from lua usertype: [`Component`](Component)
610
- Inherited by lua usertypes:
7-
- [`PointLight`](PointLight)
8-
- [`SpotLight`](SpotLight)
9-
- [`DirectionalLight`](DirectionalLight)
10-
- [`AmbientBoxLight`](AmbientBoxLight)
11-
- [`AmbientSphereLight`](AmbientSphereLight)
11+
- [`PointLight`](../PointLight)
12+
- [`SpotLight`](../SpotLight)
13+
- [`DirectionalLight`](../DirectionalLight)
14+
- [`AmbientBoxLight`](../AmbientBoxLight)
15+
- [`AmbientSphereLight`](../AmbientSphereLight)
1216

1317

1418
### Variables

‎Documentation/content/lua/components/MaterialRenderer.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
+++
2+
title = 'MaterialRenderer'
3+
+++
4+
15
### Description
26
A component that handle a material list, necessary for model rendering
37

4-
- C++ related class: [`OvCore::ECS::Components::CMaterialRenderer`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CMaterialRenderer.h)
5-
- Inherits from lua usertype: [`Component`](Component)
8+
- C++ related class: [`OvCore::ECS::Components::CMaterialRenderer`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CMaterialRenderer.h)
9+
- Inherits from lua usertype: [`Component`](../Component)
610

711
### Variables
812
_This usertype has no variables_

‎Documentation/content/lua/components/ModelRenderer.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
+++
2+
title = 'ModelRenderer'
3+
+++
4+
15
### Description
2-
A ModelRenderer is necessary in combination with a MaterialRenderer to render a model in the world
6+
A `ModelRenderer` is necessary in combination with a `MaterialRenderer` to render a model in the world
37

4-
- C++ related class: [`OvCore::ECS::Components::CModelRenderer`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CModelRenderer.h)
5-
- Inherits from lua usertype: [`Component`](Component)
8+
- C++ related class: [`OvCore::ECS::Components::CModelRenderer`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CModelRenderer.h)
9+
- Inherits from lua usertype: [`Component`](../Component)
610

711
### Variables
812
_This usertype has no variables_

0 commit comments

Comments
 (0)