QtCraft API C++ classes QML types Handbook

QcSoundKeys Namespace

Names of the sounds the game plays for blocks, creatures and the player. More...

Header: #include <common/content/registry/QcSoundKeys.h>

Variables

const char *const ambientCave
const char *const ambientWater
const char *const ambientWind
const char *const defaultMaterial
const char *const flintAndSteel
const char *const itemPickup
const char *const lavaPop
const char *const machineActive
const char *const mobDeath
const char *const mobHurt
const char *const playerBubblePop
const char *const playerDeath
const char *const playerDrink
const char *const playerEat
const char *const playerHurt
const char *const uiClick
const char *const waterSplash
const char *const waterSwim

Functions

QString actionName(QcBlockSoundAction action)
QString blockSound(const QcBlockDefinition &block, QcBlockSoundAction action)
QString defaultMaterialFor(const QcBlockDefinition &block)

Detailed Description

Blocks name a sound material; the sound of an action is "<namespace>:block.<material>.<action>" unless the block gives an explicit key for that action.

Variable Documentation

const char *const QcSoundKeys::ambientCave

The cave ambience loop.

const char *const QcSoundKeys::ambientWater

The water ambience loop.

const char *const QcSoundKeys::ambientWind

The wind ambience loop.

const char *const QcSoundKeys::defaultMaterial

Material of blocks that do not name one and are not obviously wood, earth, glass or plants.

const char *const QcSoundKeys::flintAndSteel

Flint and steel striking a fire (decision E-393).

const char *const QcSoundKeys::itemPickup

An item picked up.

const char *const QcSoundKeys::lavaPop

Lava near the listener now and then.

const char *const QcSoundKeys::machineActive

A working machine, for machines that name no own sound.

const char *const QcSoundKeys::mobDeath

A creature dying, for creatures that name no own sound.

const char *const QcSoundKeys::mobHurt

A creature taking damage, for creatures that name no own sound.

const char *const QcSoundKeys::playerBubblePop

A bubble of air that goes under water (decision E-955), played by the client itself.

const char *const QcSoundKeys::playerDeath

The player dying.

const char *const QcSoundKeys::playerDrink

The player drinking.

const char *const QcSoundKeys::playerEat

The player eating.

const char *const QcSoundKeys::playerHurt

The player taking damage.

const char *const QcSoundKeys::uiClick

A click in the user interface.

const char *const QcSoundKeys::waterSplash

The player falling into water.

const char *const QcSoundKeys::waterSwim

A swimming stroke while the player moves through water.

Function Documentation

QString QcSoundKeys::actionName(QcBlockSoundAction action)

Returns the name of action in sound keys: "break", "place", "step" or "hit".

QString QcSoundKeys::blockSound(const QcBlockDefinition &block, QcBlockSoundAction action)

Returns the sound of action on block: its explicit key for the action, otherwise "<namespace>:block.<material>.<action>"; empty when the block has no material.

QString QcSoundKeys::defaultMaterialFor(const QcBlockDefinition &block)

Returns the material block gets when it names no "sound": none for invisible blocks and liquids, otherwise derived from its tool, shape and render layer.