doorUtils docs

--custom BGO flags
the values listed are what's used by doorUtils.defaults. change any as needed, and only use what's needed
door=true -- used to differentiate this BGO from others. this assumes you're not overlapping other doors with this one. this is only used by BGOs and not in doorUtils.defaults
usePluralMacguffins=true -- whether or not a plural message should be shown. good for making a single message.
macguffin="star" -- the singular macguffin string used in messages. this is used in the message by putting [macguffin] where desired.
macguffinPlural="stars" -- the plural macguffin string used in messages. this is used in the message by putting [macguffinplural] where desired.
macguffinMessage="You need [number] [macguffin] to enter." -- the singular message string used by the door. [number] is where the number of macguffins required would be inserted into the string.
macguffinMessagePlural="You need [number] [macguffinplural] to enter." -- the plural message string used by the door. [number] is where the number of macguffins required would be inserted into the string.
macguffinIcon=nil -- the BGO id of the doors macguffin icon
centerMacguffinOnBackground=false  -- whether or not the macguffin icon should center on the door or the warp. false for the warp, true for the door.
macguffinAlignX=0.5 -- the macguffin's alignment amount on centered object on the x-axis. 0 for left, 0.5 for center, 1 for right. not recommeneded to go above that limit, but i'm not your parent.
macguffinAlignY=1 -- the macguffin's alignment amount on centered object on the y-axis. same as previously stated.
macguffinOffsetX=0 -- how many pixels to move the macguffin icon from it's center by on the x-axis. positive numbers move right, negative left.
macguffinOffsetY=0 -- how many pixels to move the macguffin icon from it's center by on the y-axis. positive numbers move down, negative up.
lockIcon=nil -- the BGO id of the doors lock icon
centerLockOnBackground=false  -- whether or not the lock icon should center on the door or the warp. fasle for the warp, true for the door.
lockAlignX=0 -- the lock's alignment amount on centered object on the x-axis. same as preivously stated.
lockAlignY=0 -- the lock's alignment amount on centered object on the y-axis. same as preivously stated.
lockOffsetX=0 -- how many pixels to move the lock icon from it's center by on the x-axis. same as preivously stated.
lockOffsetY=0 -- how many pixels to move the lock icon from it's center by on the y-axis. same as preivously stated.
effect==751 -- effect id spawned upon entering a door warp infront of the door.
effectOffsetX=0 -- how many pixels to move the spawned effect from it's center by on the x-axis. same as preivously stated.
effectOffsetY=0 -- how many pixels to move the spawned effect from it's center by on the y-axis. same as preivously stated.
autoResizeWarp=false -- if the bgo is longer then 32 pixel wide, resize the warp to fit the door's width. it takes 16 pixels of legnth from each side of the warp. not optimal for anything 64 pixel wide or below.

--library things
each BGO flag has a default flag associated with it in the library, these control the default behavior if said flag has not been set in a BGOs .txt. e.g. doorUtils.defaults.usePluralMacguffins.

doorUtils.defaults.autoRegisterBaseDoors = true --  used in lua after loading, as any other defaults field would be. there are no BGO equvalant, as this is used to determent if the user wants 1.3 doors that have effects to be registered with the system by default.

---custom range effect documentation
[1]
onTick=TICK_DOORUTILS -- the custom effect onTick included with doorUtils.lua. made to mimic 1.3 door effects behavior.
frames=5 -- mimics 1.3 door effects behavior.
priority=BACKGROUND -- needed to ensure it doesn't render over the player, but infront of the door.
lifetime=60 -- mimics 1.3 door effects behavior.
framespeed=5 -- mimics 1.3 door effects behavior.
--
this is a basic setup for a 1:1 recreation of a 1.3 door, using custom range effects.
it's intended to be used for custom doors.
frames can be increased/decreased, just adjust lifetime/framerate as needed.
TICK_DOORUTILS ticks the frames up by frame rate until the door hits it's last frame.
it keeps it at the last frame until it reaches 2/3s of it's life time.
then, it ticks down by it's frame rate until it reaches beyond the last frame, killing it's self.