Do another round of improvement on actor comment headers (#462)

* Update actor descriptions as of 11/3/2021

* Fix headers for everything I messed up

* Update headers as of 11/8/2021

* Update descriptions

* Update business scrub descriptions

* Respond to engineer's feedback

* Clean up Ruto description

* Mark chikuwa as unused

* Update description of blockstop

* Responding to Elliptic's review

* bigpi -> bigpo

* Update Trt2 description to be a little more clear

* Impove mu_pict description

* Add description for horse_game_check
This commit is contained in:
Tom Overton 2021-12-06 18:01:51 -08:00 committed by GitHub
parent 22c72301dc
commit 93d7fe080b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
169 changed files with 183 additions and 183 deletions

View File

@ -1,7 +1,7 @@
/*
* File: z_bg_dkjail_ivy.c
* Overlay: ovl_Bg_Dkjail_Ivy
* Description: Ivy in Deku Jail
* Description: Cuttable Ivy wall (beneath Woodfall Temple, Swamp Spider House)
*/
#include "z_bg_dkjail_ivy.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_bg_f40_swlift.c
* Overlay: ovl_Bg_F40_Swlift
* Description:
* Description: Unused Stone Tower vertically-oscillating platform
*/
#include "z_bg_f40_swlift.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_bg_fu_mizu.c
* Overlay: ovl_Bg_Fu_Mizu
* Description:
* Description: Water in Honey and Darling's Second Day game
*/
#include "z_bg_fu_mizu.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_bg_ikana_dharma.c
* Overlay: ovl_Bg_Ikana_Dharma
* Description: Ikana Castle - Punchable Pillar Segments
* Description: Stone Tower Temple - Punchable Pillar Segments
*/
#include "z_bg_ikana_dharma.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_bg_market_step.c
* Overlay: ovl_Bg_Market_Step
* Description: West Clocktown - Stairs
* Description: West Clocktown - most scenery
*/
#include "z_bg_market_step.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_bg_open_shutter.c
* Overlay: ovl_Bg_Open_Shutter
* Description:
* Description: Sliding doors in opening dungeon
*/
#include "z_bg_open_shutter.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_demo_effect.c
* Overlay: ovl_Demo_Effect
* Description: Obtaining Masks (?)
* Description: Various cutscene effects (blue warp in, Great Fairy vanish, etc.)
*/
#include "z_demo_effect.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_demo_getitem.c
* Overlay: ovl_Demo_Getitem
* Description:
* Description: Cutscene object for Great Fairy's Mask and Great Fairy's Sword
*/
#include "z_demo_getitem.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_demo_syoten.c
* Overlay: ovl_Demo_Syoten
* Description:
* Description: Ikana Canyon Cleansing Cutscene Effects
*/
#include "z_demo_syoten.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_dm_char00.c
* Overlay: ovl_Dm_Char00
* Description: Tatl (cutscene)
* Description: Tatl and Tael (cutscene)
*/
#include "z_dm_char00.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_dm_char01.c
* Overlay: ovl_Dm_Char01
* Description: Tatl and Tael (cutscene)
* Description: Woodfall scene objects (temple, water, walls, etc)
*/
#include "z_dm_char01.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_dm_char02.c
* Overlay: ovl_Dm_Char02
* Description:
* Description: Ocarina of Time (dropped from Skull Kid's hand)
*/
#include "z_dm_char02.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_dm_char04.c
* Overlay: ovl_Dm_Char04
* Description:
* Description: Unused(?) Tatl and Tael actors
*/
#include "z_dm_char04.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_dm_char06.c
* Overlay: ovl_Dm_Char06
* Description: Some unseen Mountain Village cutscene actor?
* Description: Mountain Village Snowy landscape fadeout in post-Snowhead thawing cutscene
*/
#include "z_dm_char06.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_dm_sa.c
* Overlay: ovl_Dm_Sa
* Description:
* Description: Glitched early version of Skull Kid stuck in a T-pose
*/
#include "z_dm_sa.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_dm_statue.c
* Overlay: ovl_Dm_Statue
* Description: Elegy of Emptiness - Beam of Light When Creating Statue
* Description: Pillars of water in Giant's Chamber
*/
#include "z_dm_statue.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_eff_change.c
* Overlay: ovl_Eff_Change
* Description:
* Description: Elegy of Emptiness - Beam of Light When Creating Statue
*/
#include "z_eff_change.h"

View File

@ -1,5 +1,5 @@
/*
* File z_eff_dust.c
* File: z_eff_dust.c
* Overlay: ovl_Eff_Dust
* Description: Dust effects
*/

View File

@ -1,5 +1,5 @@
/*
* File z_eff_kamejima_wave.c
* File: z_eff_kamejima_wave.c
* Overlay: ovl_Eff_Kamejima_Wave
* Description: Wave Created by Turtle Awakening
*/

View File

@ -1,5 +1,5 @@
/*
* File z_eff_lastday.c
* File: z_eff_lastday.c
* Overlay: ovl_Eff_Lastday
* Description: Moon Crash Cutscene Fire Wall
*/

View File

@ -1,5 +1,5 @@
/*
* File z_eff_stk.c
* File: z_eff_stk.c
* Overlay: ovl_Eff_Stk
* Description: Skullkid Effects (calling down moon / cursing Link)
*/

View File

@ -1,7 +1,7 @@
/*
* File z_eff_zoraband.c
* File: z_eff_zoraband.c
* Overlay: ovl_Eff_Zoraband
* Description:
* Description: Indigo-Go's (Mikau's healing cutscene)
*/
#include "z_eff_zoraband.h"

View File

@ -1,5 +1,5 @@
/*
* File z_elf_msg.c
* File: z_elf_msg.c
* Overlay: ovl_Elf_Msg
* Description: Tatl Hint (proximity-activated C-up hint?)
*/

View File

@ -1,5 +1,5 @@
/*
* File z_elf_msg2.c
* File: z_elf_msg2.c
* Overlay: ovl_Elf_Msg2
* Description: Tatl Hint (Z-target-activated C-up hint?)
*/

View File

@ -1,5 +1,5 @@
/*
* File z_elf_msg3.c
* File: z_elf_msg3.c
* Overlay: ovl_Elf_Msg3
* Description: Tatl Message (Proximity-activated dialogue?)
*/

View File

@ -1,5 +1,5 @@
/*
* File z_elf_msg4.c
* File: z_elf_msg4.c
* Overlay: ovl_Elf_Msg4
* Description: Tatl Hint (another proximity-activated C-up hint?)
*/

View File

@ -1,5 +1,5 @@
/*
* File z_elf_msg5.c
* File: z_elf_msg5.c
* Overlay: ovl_Elf_Msg5
* Description: Tatl Message (Another proximity-activated dialogue?)
*/

View File

@ -1,5 +1,5 @@
/*
* File z_elf_msg6.c
* File: z_elf_msg6.c
* Overlay: ovl_Elf_Msg6
* Description: Tatl Hint (another proximity-activated C-up hint?)
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_ah.c
* File: z_en_ah.c
* Overlay: ovl_En_Ah
* Description: Anju's Mother
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_akindonuts.c
* File: z_en_akindonuts.c
* Overlay: ovl_En_Akindonuts
* Description: Woodfall - Business Scrub
* Description: Trade quest Business Scrubs
*/
#include "z_en_akindonuts.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_al.c
* File: z_en_al.c
* Overlay: ovl_En_Al
* Description: Madame Aroma
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_am.c
* File: z_en_am.c
* Overlay: ovl_En_Am
* Description: Armos
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_an.c
* File: z_en_an.c
* Overlay: ovl_En_An
* Description: Anju
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_and.c
* File: z_en_and.c
* Overlay: ovl_En_And
* Description: Anju in Wedding Dress
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_ani.c
* File: z_en_ani.c
* Overlay: ovl_En_Ani
* Description: Part-Timer
* Description: Part-time worker
*/
#include "z_en_ani.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_aob_01.c
* File: z_en_aob_01.c
* Overlay: ovl_En_Aob_01
* Description: Mamamu Yan
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_arrow.c
* File: z_en_arrow.c
* Overlay: ovl_En_Arrow
* Description: Arrows and other projectiles
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_attack_niw.c
* File: z_en_attack_niw.c
* Overlay: ovl_En_Attack_Niw
* Description: Attacking cucco
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_az.c
* File: z_en_az.c
* Overlay: ovl_En_Az
* Description: Beaver Bros
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_baba.c
* File: z_en_baba.c
* Overlay: ovl_En_Baba
* Description: Bomb Shop Lady
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bal.c
* File: z_en_bal.c
* Overlay: ovl_En_Bal
* Description: Tingle With Balloon
* Description: Tingle with Balloon
*/
#include "z_en_bal.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_bat.c
* File: z_en_bat.c
* Overlay: ovl_En_Bat
* Description: Bad Bat
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bb.c
* File: z_en_bb.c
* Overlay: ovl_En_Bb
* Description: Blue Bubble
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bba_01.c
* File: z_en_bba_01.c
* Overlay: ovl_En_Bba_01
* Description:
* Description: Unused Bomb Shop Lady NPC
*/
#include "z_en_bba_01.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_bbfall.c
* File: z_en_bbfall.c
* Overlay: ovl_En_Bbfall
* Description: Red Bubble
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bee.c
* File: z_en_bee.c
* Overlay: ovl_En_Bee
* Description: Giant Bee
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bh.c
* File: z_en_bh.c
* Overlay: ovl_En_Bh
* Description: Brown Bird
* Description: Brown Bird (on the Moon)
*/
#include "z_en_bh.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_bigokuta.c
* File: z_en_bigokuta.c
* Overlay: ovl_En_Bigokuta
* Description: Big Octo
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bigpamet.c
* File: z_en_bigpamet.c
* Overlay: ovl_En_Bigpamet
* Description: Gekko & Snapper Miniboss - Snapper
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bigpo.c
* Overlay: ovl_En_Bigpi
* Description: Big Poe. Leader of the Poes, found under Dampe's house and in Beneath the Well
* File: z_en_bigpo.c
* Overlay: ovl_En_Bigpo
* Description: Big Poe. Found under Dampe's house and in Beneath the Well
*/
#include "z_en_bigpo.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_bigslime.c
* File: z_en_bigslime.c
* Overlay: ovl_En_Bigslime
* Description: Mad Jelly (miniboss)
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bjt.c
* File: z_en_bjt.c
* Overlay: ovl_En_Bjt
* Description: Hand in Toilet
* Description: ??? (Hand in toilet)
*/
#include "z_en_bjt.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_boj_01.c
* File: z_en_boj_01.c
* Overlay: ovl_En_Boj_01
* Description: [Empty]
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_boj_02.c
* File: z_en_boj_02.c
* Overlay: ovl_En_Boj_02
* Description: [Empty]
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_boj_03.c
* File: z_en_boj_03.c
* Overlay: ovl_En_Boj_03
* Description: [Empty]
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_boj_04.c
* File: z_en_boj_04.c
* Overlay: ovl_En_Boj_04
* Description: [Empty]
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_boj_05.c
* File: z_en_boj_05.c
* Overlay: ovl_En_Boj_05
* Description: [Empty]
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bom.c
* File: z_en_bom.c
* Overlay: ovl_En_Bom
* Description: Bomb / Powder Keg
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bom_bowl_man.c
* File: z_en_bom_bowl_man.c
* Overlay: ovl_En_Bom_Bowl_Man
* Description: Line of Bombers?
* Description: Line of Bombers when they teach you the password
*/
#include "z_en_bom_bowl_man.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_bom_chu.c
* File: z_en_bom_chu.c
* Overlay: ovl_En_Bom_Chu
* Description: Bombchus
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bombal.c
* File: z_en_bombal.c
* Overlay: ovl_En_Bombal
* Description: Bombers - Majora Balloon
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bombers.c
* File: z_en_bombers.c
* Overlay: ovl_En_Bombers
* Description: Bombers - Blue-Hatted Bomber
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bombers2.c
* File: z_en_bombers2.c
* Overlay: ovl_En_Bombers2
* Description: Bombers - Hideout Guard
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bombf.c
* File: z_en_bombf.c
* Overlay: ovl_En_Bombf
* Description: Bomb flower
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bomjima.c
* File: z_en_bomjima.c
* Overlay: ovl_En_Bomjima
* Description: Bombers - Jim
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bomjimb.c
* File: z_en_bomjimb.c
* Overlay: ovl_En_Bomjimb
* Description: Bomber Jim B
* Description: Bombers when chasing them
*/
#include "z_en_bomjimb.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_boom.c
* File: z_en_boom.c
* Overlay: ovl_En_Boom
* Description: Zora boomerangs
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_box.c
* File: z_en_box.c
* Overlay: ovl_En_Box
* Description: Chest
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bsb.c
* File: z_en_bsb.c
* Overlay: ovl_En_Bsb
* Description: Captain Keeta
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_bu.c
* File: z_en_bu.c
* Overlay: ovl_En_Bu
* Description: Unused dummied-out enemy
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_bubble.c
* File: z_en_bubble.c
* Overlay: ovl_En_Bubble
* Description: Bubble (flying skull enemy)
* Description: Shabom (unused)
*/
#include "z_en_bubble.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_butte.c
* File: z_en_butte.c
* Overlay: ovl_En_Butte
* Description: Butterflies
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_clear_tag.c
* File: z_en_clear_tag.c
* Overlay: ovl_En_Clear_Tag
* Description: Various effects: explosions and pops, splashes, light rays
*/

View File

@ -1,7 +1,7 @@
/*
* File z_en_cne_01.c
* File: z_en_cne_01.c
* Overlay: ovl_En_Cne_01
* Description:
* Description: Unused Market NPC
*/
#include "z_en_cne_01.h"

View File

@ -1,7 +1,7 @@
/*
* File z_en_col_man.c
* File: z_en_col_man.c
* Overlay: ovl_En_Col_Man
* Description: Gives you a Piece of Heart when you touch it?
* Description: Piece of Heart spawned by Fish2
*/
#include "z_en_col_man.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_cow.c
* File: z_en_cow.c
* Overlay: ovl_En_Cow
* Description: Cow
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_crow.c
* File: z_en_crow.c
* Overlay: ovl_En_Crow
* Description: Guay
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_death.c
* File: z_en_death.c
* Overlay: ovl_En_Death
* Description: Gomess
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_dekubaba.c
* File: z_en_dekubaba.c
* Overlay: ovl_En_Dekubaba
* Description: Deku Baba
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_demo_heishi.c
* File: z_en_demo_heishi.c
* Overlay: ovl_En_Demo_heishi
* Description: Unused(?) version of Shiro
*/

View File

@ -1,7 +1,7 @@
/*
* File: z_en_dnb.c
* Overlay: ovl_En_Dnb
* Description:
* Description: Unused invisible snowy mountain that explodes?
*/
#include "z_en_dnb.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ds2n.c
* Overlay: ovl_En_Ds2n
* Description:
* Description: Potion Shop Owner from OoT (unused)
*/
#include "z_en_ds2n.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_encount1.c
* Overlay: ovl_En_Encount1
* Description:
* Description: Spawner for Dragonflies, Skullfish, and Wallmasters
*/
#include "z_en_encount1.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_encount3.c
* Overlay: ovl_En_Encount3
* Description:
* Description: Garo spawner
*/
#include "z_en_encount3.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_encount4.c
* Overlay: ovl_En_Encount4
* Description:
* Description: Spawner for Stalchild and Fire Wall in Keeta chase
*/
#include "z_en_encount4.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ending_hero.c
* Overlay: ovl_En_Ending_Hero
* Description:
* Description: Mayor Dotour at wedding during the credits
*/
#include "z_en_ending_hero.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ending_hero2.c
* Overlay: ovl_En_Ending_Hero2
* Description:
* Description: Viscen watching moon disappearance and wedding
*/
#include "z_en_ending_hero2.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ending_hero3.c
* Overlay: ovl_En_Ending_Hero3
* Description:
* Description: Mutoh watching moon disappearance and wedding
*/
#include "z_en_ending_hero3.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ending_hero4.c
* Overlay: ovl_En_Ending_Hero4
* Description:
* Description: Soldiers watching moon disappearance and Indigo-Go's
*/
#include "z_en_ending_hero4.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ending_hero5.c
* Overlay: ovl_En_Ending_Hero5
* Description:
* Description: Carpenters watching moon disappearance and Indigo-Go's
*/
#include "z_en_ending_hero5.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_gamelupy.c
* Overlay: ovl_En_Gamelupy
* Description: Deku Scrub Playground - Large Green Rupee
* Description: Deku Scrub Playground Rupees
*/
#include "z_en_gamelupy.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ge1.c
* Overlay: ovl_En_Ge1
* Description:
* Description: White-clad Gerudo Pirate
*/
#include "z_en_ge1.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ge2.c
* Overlay: ovl_En_Ge2
* Description: Patrolling Pirate
* Description: Purple-clad Gerudo Pirate
*/
#include "z_en_ge2.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_ge3.c
* Overlay: ovl_En_Ge3
* Description:
* Description: Aviel
*/
#include "z_en_ge3.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_heishi.c
* Overlay: ovl_En_Heishi
* Description: Soldier
* Description: Soldier (Mayor's Residence only)
*/
#include "z_en_heishi.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_hgo.c
* Overlay: ovl_En_Hgo
* Description: Pamela's Father As a Gibdo
* Description: Pamela's Father (Gibdo)
*/
#include "z_en_hgo.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_horse_game_check.c
* Overlay: ovl_En_Horse_Game_Check
* Description:
* Description: Dirt patches you can jump over on Gorman Race Track
*/
#include "z_en_horse_game_check.h"

View File

@ -1,7 +1,7 @@
/*
* File: z_en_hs2.c
* Overlay: ovl_En_Hs2
* Description: Blue Target Spot
* Description: Blue Target Spot (?)
*/
#include "z_en_hs2.h"

View File

@ -1,5 +1,5 @@
/*
* File z_en_in.c
* File: z_en_in.c
* Overlay: ovl_En_In
* Description: Gorman Bros
*/

View File

@ -1,5 +1,5 @@
/*
* File z_en_invadepoh.c
* File: z_en_invadepoh.c
* Overlay: ovl_En_Invadepoh
* Description: Ranch nighttime actors
*/

Some files were not shown because too many files have changed in this diff Show More