Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Information about naming convention in C_MUSICTHEME and oCZoneMusic #115

Merged
merged 1 commit into from
Jun 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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