Additional docs for upcoming 1.1.2

Author: ConnorForan

docs/docs/EntityEffect.md

@@ -8,16 +8,16 @@ tags:
 --8<-- "docs/snippets/EntityClassDiagram_NewFunkyMode.md"
 ## Functions
 
-### AddAquariusTearFlags () {: aria-label='Functions' }
-#### void GetAquariusTearFlags ( [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) ) {: .copyable aria-label='Functions' }
-???+ info "Aquarius creep only"
-	Only works for  `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`
+### AddTearFlags () {: aria-label='Functions' }
+#### void AddTearFlags ( [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) ) {: .copyable aria-label='Functions' }
+???+ info "Applicable effects only"
+	Only works for `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`, `EffectVariant.BRIMSTONE_BALL`, `EffectVariant.TECH_DOT`, and `EffectVariant.CHAIN_LIGHTNING`.
 
 ___
-### ClearAquariusTearFlags () {: aria-label='Functions' }
-#### void GetAquariusTearFlags ( ) {: .copyable aria-label='Functions' }
-???+ info "Aquarius creep only"
-	Only works for  `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`
+### ClearTearFlags () {: aria-label='Functions' }
+#### void ClearTearFlags ( ) {: .copyable aria-label='Functions' }
+???+ info "Applicable effects only"
+	Only works for `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`, `EffectVariant.BRIMSTONE_BALL`, `EffectVariant.TECH_DOT`, and `EffectVariant.CHAIN_LIGHTNING`.
 
 ___
 ### CreateLight () {: aria-label='Functions' }
@@ -30,21 +30,27 @@ ___
 #### [EntityEffect](EntityEffect.md) CreateLootPreview ( [Vector](Vector.md) Position, [EntityPickup](EntityPickup.md) Owner, [EntityEffect](EntityEffect.md) Effect ) {: .copyable aria-label='Functions' }
 
 ___
-### GetAquariusTearFlags () {: aria-label='Functions' }
-#### [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) GetAquariusTearFlags ( ) {: .copyable aria-label='Functions' }
-???+ info "Aquarius creep only"
-	Only works for  `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`
+### GetGridEntityDesc () {: aria-label='Functions' }
+#### [GridEntityDesc](https://wofsauge.github.io/IsaacDocs/rep/GridEntityDesc.html) GetGridEntityDesc ( ) {: .copyable aria-label='Functions' }
+???+ info "Applicable effects only"
+	Only works for `EffectVariant.GRID_ENTITY_PROJECTILE_HELPER`.
 
 ___
-### HasAquariusTearFlags () {: aria-label='Functions' }
-#### boolean GetAquariusTearFlags ( [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) ) {: .copyable aria-label='Functions' }
-???+ info "Aquarius creep only"
-	Only works for  `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`
+### GetTearFlags () {: aria-label='Functions' }
+#### [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) GetTearFlags ( ) {: .copyable aria-label='Functions' }
+???+ info "Applicable effects only"
+	Only works for `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`, `EffectVariant.BRIMSTONE_BALL`, `EffectVariant.TECH_DOT`, and `EffectVariant.CHAIN_LIGHTNING`.
 
 ___
-### SetAquariusTearFlags () {: aria-label='Functions' }
-#### void GetAquariusTearFlags ( [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) ) {: .copyable aria-label='Functions' }
-???+ info "Aquarius creep only"
-	Only works for  `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`
+### HasTearFlags () {: aria-label='Functions' }
+#### boolean HasTearFlags ( [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) ) {: .copyable aria-label='Functions' }
+???+ info "Applicable effects only"
+	Only works for `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`, `EffectVariant.BRIMSTONE_BALL`, `EffectVariant.TECH_DOT`, and `EffectVariant.CHAIN_LIGHTNING`.
+
+___
+### SetTearFlags () {: aria-label='Functions' }
+#### void SetTearFlags ( [TearFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/TearFlags.html) ) {: .copyable aria-label='Functions' }
+???+ info "Applicable effects only"
+	Only works for `EffectVariant.PLAYER_CREEP_HOLYWATER_TRAIL`, `EffectVariant.BRIMSTONE_BALL`, `EffectVariant.TECH_DOT`, and `EffectVariant.CHAIN_LIGHTNING`.
 
 ___

docs/docs/EntityPlayer.md

@@ -63,6 +63,11 @@ ___
 #### boolean HasCollectible ( [CollectibleType](https://wofsauge.github.io/IsaacDocs/rep/enums/CollectibleType.html) Collectible, boolean IgnoreModifiers = false, boolean IgnoreSpoof = false ) {: .copyable aria-label='Modified Functions' }
 Now accepts a `IgnoreSpoof` argument that ignores innate items.
 
+___
+### ShootRedCandle () {: aria-label='Functions' }
+#### [EntityEffect](EntityEffect.md) ShootRedCandle ( [Vector](Vector.md) Direction ) {: .copyable aria-label='Functions' }
+Now returns the EntityEffect for the flame.
+
 ___
 ### UseActiveItem () {: aria-label=' Modified Functions' }
 #### [UseActiveItemResultFlags](enums/UseActiveItemResultFlag.md) UseActiveItem ( [CollectibleType](https://wofsauge.github.io/IsaacDocs/rep/enums/CollectibleType.html) Item, [UseFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/UseFlag.html) UseFlags = 0, [ActiveSlot](https://wofsauge.github.io/IsaacDocs/rep/enums/ActiveSlot.html) Slot = -1, int CustomVarData = 0 ) {: .copyable aria-label='Modified Functions' }
@@ -99,7 +104,7 @@ Returns the true amount of charge added, which may have been capped by the targe
 
 ___
 ### AddBoneOrbital () {: aria-label='Functions' }
-#### void AddBoneOrbital ( [Vector](Vector.md) Position ) {: .copyable aria-label='Functions' }
+#### [EntityFamiliar](EntityFamiliar.md) AddBoneOrbital ( [Vector](Vector.md) Position ) {: .copyable aria-label='Functions' }
 
 ___
 ### AddCandyHeartBonus () {: aria-label='Functions' }
@@ -1009,12 +1014,7 @@ Call this after spawning characters with "special" tears (Forgotten, Lilith, Aza
 ___
 ### InitTwin () {: aria-label='Functions' }
 #### [EntityPlayer](EntityPlayer.md) InitTwin ( [PlayerType](https://wofsauge.github.io/IsaacDocs/rep/enums/PlayerType.html) PlayerType ) {: .copyable aria-label='Functions' }
-Initializes a new player that is controlled by the player's same controller.
-
-???+ bug "Bug"
-    The twin player will desync from its main twin on save and continue. This softlocks the game in singleplayer, as the game prompts for a controller.
-	
-	We've received confirmation from \_Kilburn that this is hardcoded to be handled on vanilla characters. We will need to add a workaround for this.
+Initializes a "twin" player that is controlled by the player's same controller, similarly to Jacob & Esau.
 
 ___
 ### IsCollectibleAnimFinished () {: aria-label='Functions' }
@@ -1581,7 +1581,7 @@ Sets the active Weapon in the assigned `WeaponSlot`.
 
 ___
 ### ShootBlueCandle () {: aria-label='Functions' }
-#### void ShootBlueCandle ( [Vector](Vector.md) Direction ) {: .copyable aria-label='Functions' }
+#### [EntityEffect](EntityEffect.md) ShootBlueCandle ( [Vector](Vector.md) Direction ) {: .copyable aria-label='Functions' }
 Makes the player shoot a blue flame from the Candle collectible.
 
 ___

docs/docs/Level.md

@@ -28,7 +28,7 @@ ___
 ___
 ### FindValidRoomPlacementLocations () {: aria-label='Functions' }
 #### int[] FindValidRoomPlacementLocations ( [RoomConfigRoom](https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Room.html) RoomConfig, [Dimension](enums/Dimension.md) Dimension = -1, boolean AllowMultipleDoors = true, boolean AllowSpecialNeighbors = false ) {: .copyable aria-label='Functions' }
-#### int[] FindValidRoomPlacementLocations ( [RoomShape](https://wofsauge.github.io/IsaacDocs/rep/enums/RoomShape.html) RoomShape, [DoorMask](enums/DoorMask.md) DoorMask, [Dimension](enums/Dimension.md) Dimension = -1, boolean AllowMultipleDoors = true, boolean AllowSpecialNeighbors = false ) {: .copyable aria-label='Functions' }
+#### int[] FindValidRoomPlacementLocations ( [RoomShape](https://wofsauge.github.io/IsaacDocs/rep/enums/RoomShape.html) RoomShape = 1, [DoorMask](enums/DoorMask.md) DoorMask = -1, [Dimension](enums/Dimension.md) Dimension = -1, boolean AllowMultipleDoors = true, boolean AllowSpecialNeighbors = false ) {: .copyable aria-label='Functions' }
 Returns a table of room grid indices that would be valid locations to place the specified room using [TryPlaceRoom](Level.md#tryplaceroom).
 
 Note that if you set `AllowSpecialNeighbors` to `true`, you can get weird placements next to the ultra secret room. You can use [GetNeighboringRooms](Level.md#getneighboringrooms) to confirm that potential neighbors are desired before placing your room.

docs/docs/Room.md

@@ -18,6 +18,11 @@ ___
 #### [LRoomTileDesc](LRoomTileDesc.md) GetLRoomTileDesc ( ) {: .copyable aria-label='Modified Functions' }
 Now returns a usable class. Describes the corners of an L-room shape (as divided horizontally into two rectangles), in grid coordinates.
 
+___
+### SetRedHeartDamage () {: aria-label='Modified Functions' }
+#### void SetRedHeartDamage ( boolean Value = true ) {: .copyable aria-label='Modified Functions' }
+Now accepts an optional parameter, allowing the flag to be set to false.
+
 ___
 ### SpawnGridEntity () {: aria-label='Modified Functions' }
 #### boolean SpawnGridEntity ( int GridIndex, [GridEntityType](https://wofsauge.github.io/IsaacDocs/rep/enums/GridEntityType.html) Type, int Variant = 0, int Seed = nil, int VarData = 0 ) {: .copyable aria-label='Modified Functions' }

docs/docs/RoomDescriptor.md

@@ -82,6 +82,14 @@ ___
 #### int GetTaintedKeeperCoinSpawns ( ) {: .copyable aria-label='Functions' }
 Prevent coin spawn from killed enemies on room reenter when counter reaches 10.
 
+___
+### GetValidNeighborPlacementLocations () {: aria-label='Functions' }
+#### int[] GetValidNeighborPlacementLocations ( [RoomConfigRoom](https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Room.html) RoomConfig, boolean AllowMultipleDoors = true, boolean AllowSpecialNeighbors = false ) {: .copyable aria-label='Functions' }
+#### int[] GetValidNeighborPlacementLocations ( [RoomShape](https://wofsauge.github.io/IsaacDocs/rep/enums/RoomShape.html) RoomShape = 1, [DoorMask](enums/DoorMask.md) DoorMask = -1, boolean AllowMultipleDoors = true, boolean AllowSpecialNeighbors = false ) {: .copyable aria-label='Functions' }
+Returns a table of room grid indices that would be valid locations to place the specified room as a neighbor of this room using [TryPlaceRoom](Level.md#tryplaceroom).
+
+See [TryPlaceRoom](Level.md#tryplaceroom) for more information on room placement and example code.
+
 ___
 ### InitSeeds () {: aria-label='Functions' }
 #### void InitSeeds ( [RNG](RNG.md) RNG ) {: .copyable aria-label='Functions' }

docs/docs/TearParams.md

@@ -0,0 +1,23 @@
+---
+tags:
+  - Class
+---
+# Class "TearParams"
+
+## Variables
+### KnockbackMultiplier {: aria-label='Variables' }
+#### float KnockbackMultiplier {: .copyable aria-label='Variables'}
+
+___
+### MassMultiplier {: aria-label='Variables' }
+#### float MassMultiplier {: .copyable aria-label='Variables'}
+
+___
+### SpeedMultiplier {: aria-label='Variables' }
+#### float SpeedMultiplier {: .copyable aria-label='Variables'}
+
+___
+### TearDisplacement {: aria-label='Variables' }
+#### int TearDisplacement {: .copyable aria-label='Variables'}
+Represents which eye the tear was shot from (`1` for the right eye, `-1` for the left eye).
+___

docs/docs/enums/ModCallbacks.md

@@ -128,9 +128,12 @@ Now optionally accepts returning a table, with any combination of the following
 
 Modified values are passed along to the remaining callbacks. Returning false to cancel the damage still skips the remaining callbacks.
 
+???+ info "ExtraSource"
+    ExtraSource is a new EntityRef passed to this callback in specific situations where the ""true"" source of the damage is obscured. For example, lasers and melee hitboxes provide their parent (ie, the player) instead of themselves as the damage Source. The laser/knife entity itself will be available as the ExtraSource! Gello and Brimstone Balls are also supported. Note that ExtraSource is nil if not available.
+
 |ID|Name|Function Args|Optional Args|Return Type|
 |:--|:--|:--|:--|:--|
-|11 |MC_ENTITY_TAKE_DMG {: .copyable } | ([Entity](../Entity.md) Entity, float Damage, [DamageFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/DamageFlag.html) DamageFlags, [EntityRef](https://wofsauge.github.io/IsaacDocs/rep/EntityRef.html) Source, int DamageCountdown) | [EntityType](https://wofsauge.github.io/IsaacDocs/rep/enums/EntityType.html) | boolean or table |
+|11 |MC_ENTITY_TAKE_DMG {: .copyable } | ([Entity](../Entity.md) Entity, float Damage, [DamageFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/DamageFlag.html) DamageFlags, [EntityRef](https://wofsauge.github.io/IsaacDocs/rep/EntityRef.html) Source, int DamageCountdown, [EntityRef](https://wofsauge.github.io/IsaacDocs/rep/EntityRef.html) ExtraSource) | [EntityType](https://wofsauge.github.io/IsaacDocs/rep/enums/EntityType.html) | boolean or table |
 
 ### MC_PRE_MOD_UNLOAD
 Added boolean argument that identifies if it is running due to game shutdown.
@@ -393,9 +396,12 @@ Alternatively accepts `false` to cancel rendering
 ### MC_POST_ENTITY_TAKE_DMG {: .copyable }
 Accepts no return parameters.
 
+???+ info "ExtraSource"
+    ExtraSource is a new EntityRef passed to this callback in specific situations where the ""true"" source of the damage is obscured. For example, lasers and melee hitboxes provide their parent (ie, the player) instead of themselves as the damage Source. The laser/knife entity itself will be available as the ExtraSource! Gello and Brimstone Balls are also supported. Note that ExtraSource is nil if not available.
+
 |ID|Name|Function Args|Optional Args|Return Type|
 |:--|:--|:--|:--|:--|
-|1006 |MC_POST_ENTITY_TAKE_DMG {: .copyable } | ([Entity](../Entity.md) Entity, <br>float Damage, <br>[DamageFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/DamageFlag.html) DamageFlags, <br>[EntityRef](https://wofsauge.github.io/IsaacDocs/rep/EntityRef.html) Source, <br>int DamageCountdown) | [EntityType](https://wofsauge.github.io/IsaacDocs/rep/enums/EntityType.html) | void |
+|1006 |MC_POST_ENTITY_TAKE_DMG {: .copyable } | ([Entity](../Entity.md) Entity, <br>float Damage, <br>[DamageFlags](https://wofsauge.github.io/IsaacDocs/rep/enums/DamageFlag.html) DamageFlags, <br>[EntityRef](https://wofsauge.github.io/IsaacDocs/rep/EntityRef.html) Source, <br>int DamageCountdown, <br>[EntityRef](https://wofsauge.github.io/IsaacDocs/rep/EntityRef.html) ExtraSource) | [EntityType](https://wofsauge.github.io/IsaacDocs/rep/enums/EntityType.html) | void |
 
 ### MC_PRE_ENTITY_THROW {: .copyable }
 Accepts a [Vector](../Vector.md) which will modify the velocity of the thrown entity.
@@ -1509,13 +1515,6 @@ Return `true` to prevent the split, `false` to allow it even if blacklisted, or
 |:--|:--|:--|:--|:--|
 |1191 |MC_PRE_NPC_SPLIT {: .copyable } | ([EntityNPC](../EntityNPC.md) NPC, <br>boolean IsBlacklisted) | [EntityType](https://wofsauge.github.io/IsaacDocs/rep/enums/EntityType.html) | boolean |
 
-### MC_PRE_OPENGL_RENDER {: .copyable }
-Gets called right before the Manager::Render() function gets called.
-
-|ID|Name|Function Args|Optional Args|Return Type|
-|:--|:--|:--|:--|:--|
-|1136 | MC_PRE_OPENGL_RENDER {: .copyable } | (VertexBuffer, <br>int shaderId, <br>RenderContext) | - | ? |
-
 ### MC_PRE_PAUSE_SCREEN_RENDER {: .copyable }
 Can return `false` to prevent the pause screen from rendering. Doing so will also prevent the screen from darkening.
 
@@ -1718,12 +1717,6 @@ Alternative accepts `true`, which cancels trinket rendering.
 |:--|:--|:--|:--|:--|
 |1264 |MC_PRE_PLAYERHUD_TRINKET_RENDER {: .copyable } | (int Slot, <br>[Vector](../Vector.md) Position, <br>float Scale, <br>[EntityPlayer](../EntityPlayer.md) Player, <br>[Vector](../Vector.md) CropOffset) | int Slot | table or boolean |
 
-### MC_PRE_PLAYER_APPLY_INNATE_COLLECTIBLE_NUM {: .copyable }
-
-|ID|Name|Function Args|Optional Args|Return Type|
-|:--|:--|:--|:--|:--|
-|1092 |MC_PRE_PLAYER_APPLY_INNATE_COLLECTIBLE_NUM {: .copyable } | (int ModCount, <br>[EntityPlayer](../EntityPlayer.md) Player, <br>[CollectibleType](https://wofsauge.github.io/IsaacDocs/rep/enums/CollectibleType.html) Type, <br>boolean OnlyCountTrueItems) | - | int |
-
 ### MC_POST_PLAYER_COLLISION {: .copyable }
 Runs after the on-collision code of this entity, assuming it wasn't skipped.