OriPlayer Documentation

OriPlayer Documentation

This page lists methods and fields pertaining to the OriPlayer class that are exposed to other mods. This page is most useful for getting information about the OriMod player's current states and acting on those

Field	Type	Default Value	Description
OriSet	bool	false	Whether the player uses Ori's movements and sprites, or behaves as a normal player. When false, no abilities can be used and custom physics do not run. External mods can set this value
Transforming	bool	false	Whether the player is in the transform animation to change between normal state and Ori state. All input is disabled while transforming.
AnimName	string	"Default"	Current animation track that the player is using.
AnimTile	Vector2	(0, 0)	Current Ori sprite tile that's being drawn. Values are for tiles, not pixels
Abilities	OriAbilities	null	Class of all abilities assigned to this player.
IsGrounded	bool	false	Whether the player is grounded or not.
OnWall	bool	false	Whether the player is on a wall or not.
UnrestrictedMovement	bool	false	When true, sets player.runSlowDown to 0. External mods can set this value
FloorMaterial	string	"Grass"	Name of the sounds to play for footsteps.
GrassFloorMaterials RockFloorMaterials WoodFloorMaterials SandFloorMaterials SnowFloorMaterials MushroomFloorMaterials LightDarkFloorMaterials SpiritTreeRockFloorMaterials SpiritTreeWoodFloorMaterials	List<int>		List of TileIDs that, when stepped on, play sounds relating to certain footsteps. All FloorMaterials lists are already populated by most vanilla TileIDs - LightDark materials sound like crystals - SpiritTree- sounds contain an additional, echo-like effect External mods may append their own TileIDs to these lists.
SeinMinionActive	bool	false	Whether the player has one of OriMod's Sein minions summoned. Used to cap Sein summons to 1
SeinMinionUpgrade	int	0	Current summoned version of Sein, with 1 being the weakest and 8 being the strongest. Values are between 0 and 8.