Updated docs
This commit is contained in:
bluefireoly
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: KSpigotSound -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[KSpigotSound](-k-spigot-sound.md)
|
||||
|
||||
|
||||
|
||||
# KSpigotSound
|
||||
[jvm]
|
||||
Content
|
||||
fun [KSpigotSound](-k-spigot-sound.md)(sound: Sound, volume: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), pitch: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), category: SoundCategory?)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: component1 -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[component1](component1.md)
|
||||
|
||||
|
||||
|
||||
# component1
|
||||
[jvm]
|
||||
Content
|
||||
operator fun [component1](component1.md)(): Sound
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: component2 -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[component2](component2.md)
|
||||
|
||||
|
||||
|
||||
# component2
|
||||
[jvm]
|
||||
Content
|
||||
operator fun [component2](component2.md)(): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: component3 -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[component3](component3.md)
|
||||
|
||||
|
||||
|
||||
# component3
|
||||
[jvm]
|
||||
Content
|
||||
operator fun [component3](component3.md)(): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: component4 -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[component4](component4.md)
|
||||
|
||||
|
||||
|
||||
# component4
|
||||
[jvm]
|
||||
Content
|
||||
operator fun [component4](component4.md)(): SoundCategory?
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: copy -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[copy](copy.md)
|
||||
|
||||
|
||||
|
||||
# copy
|
||||
[jvm]
|
||||
Content
|
||||
fun [copy](copy.md)(sound: Sound, volume: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), pitch: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), category: SoundCategory?): [KSpigotSound](index.md)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: KSpigotSound -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)
|
||||
|
||||
|
||||
|
||||
# KSpigotSound
|
||||
[jvm] data class [KSpigotSound](index.md)(**sound**: Sound, **volume**: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), **pitch**: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), **category**: SoundCategory?)
|
||||
|
||||
|
||||
## Functions
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [component1](component1.md)| [jvm] <br>Content <br>operator fun [component1](component1.md)(): Sound <br><br><br>
|
||||
| [component2](component2.md)| [jvm] <br>Content <br>operator fun [component2](component2.md)(): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) <br><br><br>
|
||||
| [component3](component3.md)| [jvm] <br>Content <br>operator fun [component3](component3.md)(): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) <br><br><br>
|
||||
| [component4](component4.md)| [jvm] <br>Content <br>operator fun [component4](component4.md)(): SoundCategory? <br><br><br>
|
||||
| [copy](copy.md)| [jvm] <br>Content <br>fun [copy](copy.md)(sound: Sound, volume: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), pitch: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), category: SoundCategory?): [KSpigotSound](index.md) <br><br><br>
|
||||
| [equals](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/)| [jvm] <br>Content <br>open operator override fun [equals](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) <br><br><br>
|
||||
| [hashCode](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/hashCode/#/PointingToDeclaration/)| [jvm] <br>Content <br>open override fun [hashCode](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/hashCode/#/PointingToDeclaration/)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) <br><br><br>
|
||||
| [playAt](play-at.md)| [jvm] <br>Brief description <br><br><br>Plays the sound at the location. It will be audible for everyone near it.<br><br> <br>Content <br>fun [playAt](play-at.md)(loc: Location) <br><br><br>
|
||||
| [playFor](play-for.md)| [jvm] <br>Brief description <br><br><br>Plays the sound at the location of the player. It will be only audible for the player.<br><br> <br>Content <br>fun [playFor](play-for.md)(player: Player) <br><br><br>
|
||||
| [toString](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/toString/#/PointingToDeclaration/)| [jvm] <br>Content <br>open override fun [toString](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/toString/#/PointingToDeclaration/)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) <br><br><br>
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [category](index.md#net.axay.kspigot.sound/KSpigotSound/category/#/PointingToDeclaration/)| [jvm] var [category](index.md#net.axay.kspigot.sound/KSpigotSound/category/#/PointingToDeclaration/): SoundCategory? <br>
|
||||
| [pitch](index.md#net.axay.kspigot.sound/KSpigotSound/pitch/#/PointingToDeclaration/)| [jvm] var [pitch](index.md#net.axay.kspigot.sound/KSpigotSound/pitch/#/PointingToDeclaration/): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) <br>
|
||||
| [sound](index.md#net.axay.kspigot.sound/KSpigotSound/sound/#/PointingToDeclaration/)| [jvm] val [sound](index.md#net.axay.kspigot.sound/KSpigotSound/sound/#/PointingToDeclaration/): Sound <br>
|
||||
| [volume](index.md#net.axay.kspigot.sound/KSpigotSound/volume/#/PointingToDeclaration/)| [jvm] var [volume](index.md#net.axay.kspigot.sound/KSpigotSound/volume/#/PointingToDeclaration/): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) <br>
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: playAt -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[playAt](play-at.md)
|
||||
|
||||
|
||||
|
||||
# playAt
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Plays the sound at the location. It will be audible for everyone near it.
|
||||
|
||||
|
||||
Content
|
||||
fun [playAt](play-at.md)(loc: Location)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: playFor -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.sound](../index.md)/[KSpigotSound](index.md)/[playFor](play-for.md)
|
||||
|
||||
|
||||
|
||||
# playFor
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Plays the sound at the location of the player. It will be only audible for the player.
|
||||
|
||||
|
||||
Content
|
||||
fun [playFor](play-for.md)(player: Player)
|
||||
|
||||
|
||||
|
||||
23
docs/-k-spigot/net.axay.kspigot.sound/index.md
Normal file
23
docs/-k-spigot/net.axay.kspigot.sound/index.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: net.axay.kspigot.sound -
|
||||
---
|
||||
//[KSpigot](../index.md)/[net.axay.kspigot.sound](index.md)
|
||||
|
||||
|
||||
|
||||
# Package net.axay.kspigot.sound
|
||||
|
||||
|
||||
## Types
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [KSpigotSound](-k-spigot-sound/index.md)| [jvm] <br>Content <br>data class [KSpigotSound](-k-spigot-sound/index.md)(**sound**: Sound, **volume**: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), **pitch**: [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html), **category**: SoundCategory?) <br><br><br>
|
||||
|
||||
|
||||
## Functions
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [sound](sound.md)| [jvm] <br>Brief description <br><br><br>Accesses the sound builder.<br><br> <br>Content <br>fun [sound](sound.md)(sound: Sound, builder: [KSpigotSound](-k-spigot-sound/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [KSpigotSound](-k-spigot-sound/index.md) <br><br><br>[jvm] <br>Brief description <br><br><br>Accesses the sound builder and then immediately plays the sound at the given location.<br><br> <br>Content <br>fun Location.[sound](sound.md)(sound: Sound, builder: [KSpigotSound](-k-spigot-sound/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)?) <br><br><br>[jvm] <br>Brief description <br><br><br>Accesses the sound builder and then immediately plays the sound for the player.<br><br> <br>Content <br>fun Player.[sound](sound.md)(sound: Sound, builder: [KSpigotSound](-k-spigot-sound/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)?) <br><br><br>
|
||||
|
||||
72
docs/-k-spigot/net.axay.kspigot.sound/sound.md
Normal file
72
docs/-k-spigot/net.axay.kspigot.sound/sound.md
Normal file
@@ -0,0 +1,72 @@
|
||||
---
|
||||
title: sound -
|
||||
---
|
||||
//[KSpigot](../index.md)/[net.axay.kspigot.sound](index.md)/[sound](sound.md)
|
||||
|
||||
|
||||
|
||||
# sound
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Accesses the sound builder.
|
||||
|
||||
|
||||
|
||||
## See also
|
||||
|
||||
jvm
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [KSpigotSound](-k-spigot-sound/index.md)| <br><br><br><br>
|
||||
|
||||
|
||||
Content
|
||||
fun [sound](sound.md)(sound: Sound, builder: [KSpigotSound](-k-spigot-sound/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [KSpigotSound](-k-spigot-sound/index.md)
|
||||
|
||||
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Accesses the sound builder and then immediately plays the sound at the given location.
|
||||
|
||||
|
||||
|
||||
## See also
|
||||
|
||||
jvm
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [KSpigotSound](-k-spigot-sound/index.md)| <br><br><br><br>
|
||||
|
||||
|
||||
Content
|
||||
fun Location.[sound](sound.md)(sound: Sound, builder: [KSpigotSound](-k-spigot-sound/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)?)
|
||||
|
||||
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Accesses the sound builder and then immediately plays the sound for the player.
|
||||
|
||||
|
||||
|
||||
## See also
|
||||
|
||||
jvm
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [KSpigotSound](-k-spigot-sound/index.md)| <br><br><br><br>
|
||||
|
||||
|
||||
Content
|
||||
fun Player.[sound](sound.md)(sound: Sound, builder: [KSpigotSound](-k-spigot-sound/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)?)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user