Skip to content

Commit

Permalink
Information about naming convention in C_MUSICTHEME and oCZoneMusic
Browse files Browse the repository at this point in the history
  • Loading branch information
muczc1wek authored and kamilkrzyskow committed Jun 11, 2024
1 parent 1235346 commit 7c7fe66
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion docs/zengin/scripts/classes/c_musictheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,10 @@ const INT TRANSITION_SUB_TYPE_MEASURE = 3; // Gradual transition
```

## Name features
The musical themes of the game are played depending on the game situation. By default, the theme with the `_STD` (standard) suffix is played. In case of a threat, the `_THR` (threat) theme will be played. During the combat the `_FGT` (fight) theme plays.
The musical themes of the game are played depending on the game situation. By default, the theme with the `_STD` (standard) suffix is played. In case of a threat, the `_THR` (threat) theme will be played. During the combat the `_FGT` (fight) theme plays.

!!! Danger
Make sure that you use proper naming convention for MusicThemes and [`oCZoneMusic`](../../worlds/Classes/zCVob/zCZone/oCZoneMusic/index.md) vobs. The theme with `OC_` prefix will play in a zone with name like `OLDCAMP_OC` or any other ending with `_OC`

```dae
instance WOO_DAY_STD(C_MUSICTHEME_STANDARD)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A VObject which defines the music to be played within its bounding box. Music zo
music zone applies. If no music zone applies the music defined in the optional [`oCZoneMusicDefault`](oCZoneMusicDefault.md)
is used.

The name of the music theme to be played is defined by the [`vobName`](../../index.md#vobname).
The name of the music theme to be played is defined by the [`vobName`](../../index.md#vobname). Notice that end of the name is taken as a [C_MUSICTHEME](../../../../../scripts/classes/c_musictheme.md) prefix. For example zone `OLDCAMP_OC` will play theme starting with `OC_`.

!!! tip
If the suffix `_NCI` or `_NCO` is added to the end of the zone name, it snows instead of rains in the zone.
Expand Down

0 comments on commit 7c7fe66

Please sign in to comment.