More or less standardised separator comments in the code

This commit is contained in:
Maruno17
2024-06-27 21:21:26 +01:00
parent 225549bfce
commit 509a414f37
198 changed files with 1907 additions and 1263 deletions

View File

@@ -1,5 +1,5 @@
#===============================================================================
# General purpose utilities
# General purpose utilities.
#===============================================================================
def _pbNextComb(comb, length)
i = comb.length - 1
@@ -98,7 +98,7 @@ class AntiRandom
end
#===============================================================================
# Constants utilities
# Constants utilities.
#===============================================================================
# Unused
def isConst?(val, mod, constant)
@@ -152,7 +152,7 @@ def getConstantNameOrValue(mod, value)
end
#===============================================================================
# Event utilities
# Event utilities.
#===============================================================================
def pbTimeEvent(variableNumber, secs = 86_400)
return if !$game_variables
@@ -217,7 +217,7 @@ def pbNoticePlayer(event, always_show_exclaim = false)
end
#===============================================================================
# Player-related utilities, random name generator
# Player-related utilities, random name generator.
#===============================================================================
# Unused
def pbGetPlayerGraphic
@@ -369,7 +369,7 @@ def getRandomName(maxLength = 100)
end
#===============================================================================
# Regional and National Pokédexes utilities
# Regional and National Pokédexes utilities.
#===============================================================================
# Returns the ID number of the region containing the player's current location,
# as determined by the current map's metadata.
@@ -415,7 +415,7 @@ def pbGetRegionalDexLength(region_dex)
end
#===============================================================================
# Other utilities
# Other utilities.
#===============================================================================
def pbTextEntry(helptext, minlength, maxlength, variableNumber)
$game_variables[variableNumber] = pbEnterText(helptext, minlength, maxlength)

View File

@@ -1,5 +1,5 @@
#===============================================================================
# Nicknaming and storing Pokémon
# Nicknaming and storing Pokémon.
#===============================================================================
def pbBoxesFull?
return ($player.party_full? && $PokemonStorage.full?)
@@ -43,7 +43,7 @@ def pbNicknameAndStore(pkmn)
end
#===============================================================================
# Giving Pokémon to the player (will send to storage if party is full)
# Giving Pokémon to the player (will send to storage if party is full).
#===============================================================================
def pbAddPokemon(pkmn, level = 1, see_form = true)
return false if !pkmn
@@ -91,7 +91,7 @@ def pbAddPokemonSilent(pkmn, level = 1, see_form = true)
end
#===============================================================================
# Giving Pokémon/eggs to the player (can only add to party)
# Giving Pokémon/eggs to the player (can only add to party).
#===============================================================================
def pbAddToParty(pkmn, level = 1, see_form = true)
return false if !pkmn || $player.party_full?
@@ -175,7 +175,7 @@ alias pbAddEgg pbGenerateEgg
alias pbGenEgg pbGenerateEgg
#===============================================================================
# Analyse Pokémon in the party
# Analyse Pokémon in the party.
#===============================================================================
# Returns the first unfainted, non-egg Pokémon in the player's party.
def pbFirstAblePokemon(variable_ID)
@@ -189,7 +189,7 @@ def pbFirstAblePokemon(variable_ID)
end
#===============================================================================
# Return a level value based on Pokémon in a party
# Return a level value based on Pokémon in a party.
#===============================================================================
def pbBalancedLevel(party)
return 1 if party.length == 0
@@ -238,7 +238,7 @@ def pbBalancedLevel(party)
end
#===============================================================================
# Calculates a Pokémon's size (in millimeters)
# Calculates a Pokémon's size (in millimeters).
#===============================================================================
def pbSize(pkmn)
baseheight = pkmn.height
@@ -272,7 +272,7 @@ def pbSize(pkmn)
end
#===============================================================================
# Returns true if the given species can be legitimately obtained as an egg
# Returns true if the given species can be legitimately obtained as an egg.
#===============================================================================
def pbHasEgg?(species)
species_data = GameData::Species.try_get(species)

View File

@@ -1,5 +1,5 @@
#===============================================================================
# Load various wild battle music
# Load various wild battle music.
#===============================================================================
# wildParty is an array of Pokémon objects.
def pbGetWildBattleBGM(_wildParty)
@@ -58,7 +58,7 @@ def pbGetWildCaptureME
end
#===============================================================================
# Load/play various trainer battle music
# Load/play various trainer battle music.
#===============================================================================
def pbPlayTrainerIntroBGM(trainer_type)
trainer_type_data = GameData::TrainerType.get(trainer_type)