Class "EntityFamiliar"

Functions

AddCoins () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void AddCoins ( int Value ) {: .copyable aria-label='Functions' }

AddHearts () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void AddHearts ( int Hearts ) {: .copyable aria-label='Functions' }

AddKeys () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void AddKeys ( int Keys ) {: .copyable aria-label='Functions' }

AddToDelayed () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void AddToDelayed ( ) {: .copyable aria-label='Functions' }

Adds to delayed. This doesn't remove other flags!

AddToFollowers () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void AddToFollowers ( ) {: .copyable aria-label='Functions' }

Adds to followers. This doesn't remove other flags!

AddToOrbit () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void AddToOrbit ( int Layer ) {: .copyable aria-label='Functions' }

Adds to orbitals. This doesn't remove other flags!

FireProjectile () {: aria-label='Functions' }

{: .abp .tooltip .badge }

EntityTear FireProjectile ( Vector Dir ) {: .copyable aria-label='Functions' }

Shoots a projectile from the center of the familiar in the direction you defined. If used on a familiar that shoots multiple projectiles (example: harlequin baby), this function will only return the left most projectile based on the direction. If used on familiars with special tears (example: Lil Brimstone,...), this will just shoot a regular tear. This function will not play the shoot animation of the familiar.

FollowParent () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void FollowParent ( ) {: .copyable aria-label='Functions' }

FollowPosition () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void FollowPosition ( Vector Pos ) {: .copyable aria-label='Functions' }

GetOrbitDistance () {: aria-label='Functions' }

{: .static .tooltip .badge } {: .abp .tooltip .badge }

static Vector GetOrbitDistance ( int Layer ) {: .copyable aria-label='Functions' }

GetOrbitPosition () {: aria-label='Functions' }

{: .abp .tooltip .badge }

Vector GetOrbitPosition ( Vector Pos ) {: .copyable aria-label='Functions' }

Returns the position of an orbiting familiar relative to the player's position. Returns :::lua Vector(0,0) if its a normal familiar. The "pos" argument is used as an offset.

MoveDelayed () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void MoveDelayed ( int NumFrames ) {: .copyable aria-label='Functions' }

MoveDiagonally () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void MoveDiagonally ( float Speed ) {: .copyable aria-label='Functions' }

PickEnemyTarget () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void PickEnemyTarget ( float MaxDistance, int FrameInterval ) {: .copyable aria-label='Functions' }

PlayChargeAnim () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void PlayChargeAnim ( Direction Dir ) {: .copyable aria-label='Functions' }

PlayFloatAnim () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void PlayFloatAnim ( Direction Dir ) {: .copyable aria-label='Functions' }

PlayShootAnim () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void PlayShootAnim ( Direction Dir ) {: .copyable aria-label='Functions' }

RecalculateOrbitOffset () {: aria-label='Functions' }

{: .abp .tooltip .badge }

int RecalculateOrbitOffset ( int Layer, boolean Add ) {: .copyable aria-label='Functions' }

Returns the number of familiars in that layer.

RemoveFromDelayed () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void RemoveFromDelayed ( ) {: .copyable aria-label='Functions' }

RemoveFromFollowers () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void RemoveFromFollowers ( ) {: .copyable aria-label='Functions' }

RemoveFromOrbit () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void RemoveFromOrbit ( ) {: .copyable aria-label='Functions' }

Shoot () {: aria-label='Functions' }

{: .abp .tooltip .badge }

void Shoot ( ) {: .copyable aria-label='Functions' }

???+ bug "Bugs" This function does not seem to work.

Variables

Coins {: aria-label='Variables' }

{: .abp .tooltip .badge }

int Coins {: .copyable aria-label='Variables' }

FireCooldown {: aria-label='Variables' }

{: .abp .tooltip .badge }

int FireCooldown {: .copyable aria-label='Variables' }

HeadFrameDelay {: aria-label='Variables' }

{: .abp .tooltip .badge }

int HeadFrameDelay {: .copyable aria-label='Variables' }

Hearts {: aria-label='Variables' }

{: .abp .tooltip .badge }

int Hearts {: .copyable aria-label='Variables' }

Keys {: aria-label='Variables' }

{: .abp .tooltip .badge }

int Keys {: .copyable aria-label='Variables' }

LastDirection {: aria-label='Variables' }

{: .abp .tooltip .badge }

Direction LastDirection {: .copyable aria-label='Variables' }

MoveDirection {: aria-label='Variables' }

{: .abp .tooltip .badge }

Direction MoveDirection {: .copyable aria-label='Variables' }

OrbitAngleOffset {: aria-label='Variables' }

{: .abp .tooltip .badge }

float OrbitAngleOffset {: .copyable aria-label='Variables' }

Can be used to override the angular position of the familiar on its orbit based on the initial starting position of the orbit.

???- example "Example Code" This code will make all of your orbitals move as a tight wall around you.

    for i,v in ipairs(Isaac.GetRoomEntities()) do 
    if v.Type==3 then 
    v:ToFamiliar().OrbitAngleOffset = 0.25*i 
    end 
    end

Result: ![angle offset](https://raw.githubusercontent.com/wofsauge/IsaacDocs/master/customImg/example_familiar_angleOffset.png)

OrbitDistance {: aria-label='Variables' }

{: .abp .tooltip .badge }

Vector OrbitDistance {: .copyable aria-label='Variables' }

Defines the orbit of the familiar, if its an orbital. The Vector is interpreted as the dimensions of the circle/oval orbit. Example: :::lua Vector(110,90) is the orbital of "Forever alone".

Player {: aria-label='Variables' }

{: .abp .tooltip .badge }

EntityPlayer Player {: .copyable aria-label='Variables' }

RoomClearCount {: aria-label='Variables' }

{: .abp .tooltip .badge }

int RoomClearCount {: .copyable aria-label='Variables' }

ShootDirection {: aria-label='Variables' }

{: .abp .tooltip .badge }

Direction ShootDirection {: .copyable aria-label='Variables' }

State {: aria-label='Variables' }

{: .abp .tooltip .badge }

int State {: .copyable aria-label='Variables' }