aermre-api-docs/latest/instance_8h_source.html

#ifndef AER_INSTANCE_H

#define AER_INSTANCE_H


#include <stdbool.h>

#include <stddef.h>

#include <stdint.h>


/* ----- PUBLIC TYPES ----- */


typedef void AERInstance;


typedef union AERLocal {

    bool b;

    uint64_t u;

    int64_t i;

    float f;

    double d;

    void* p;

} AERLocal;


/* ----- PUBLIC FUNCTIONS ----- */


size_t AERInstanceGetAll(size_t bufSize, AERInstance** instBuf);


size_t AERInstanceGetByObject(int32_t objIdx,

                              bool recursive,

                              size_t bufSize,

                              AERInstance** instBuf);


AERInstance* AERInstanceGetById(int32_t instId);


AERInstance* AERInstanceCreate(int32_t objIdx, float x, float y);


void AERInstanceChange(AERInstance* inst, int32_t newObjIdx, bool doEvents);


void AERInstanceDestroy(AERInstance* inst);


void AERInstanceDelete(AERInstance* inst);


float AERInstanceGetDepth(AERInstance* inst);


void AERInstanceSetDepth(AERInstance* inst, float depth);


void AERInstanceSyncDepth(AERInstance* inst);


int32_t AERInstanceGetId(AERInstance* inst);


int32_t AERInstanceGetObject(AERInstance* inst);


bool AERInstanceCompatibleWith(AERInstance* inst, int32_t objIdx);


bool AERInstanceGetDeactivated(AERInstance* inst);


void AERInstanceSetDeactivated(AERInstance* inst, bool deactivated);


bool AERInstanceGetPersistent(AERInstance* inst);


void AERInstanceSetPersistent(AERInstance* inst, bool persistent);


void AERInstanceGetPosition(AERInstance* inst, float* x, float* y);


void AERInstanceSetPosition(AERInstance* inst, float x, float y);


void AERInstanceAddPosition(AERInstance* inst, float x, float y);


void AERInstanceGetBoundingBox(AERInstance* inst,

                               float* left,

                               float* top,

                               float* right,

                               float* bottom);


float AERInstanceGetFriction(AERInstance* inst);


void AERInstanceSetFriction(AERInstance* inst, float friction);


void AERInstanceGetMotion(AERInstance* inst, float* x, float* y);


void AERInstanceSetMotion(AERInstance* inst, float x, float y);


void AERInstanceAddMotion(AERInstance* inst, float x, float y);


int32_t AERInstanceGetMask(AERInstance* inst);


void AERInstanceSetMask(AERInstance* inst, int32_t maskIdx);


bool AERInstanceGetVisible(AERInstance* inst);


void AERInstanceSetVisible(AERInstance* inst, bool visible);


int32_t AERInstanceGetSprite(AERInstance* inst);


void AERInstanceSetSprite(AERInstance* inst, int32_t spriteIdx);


float AERInstanceGetSpriteFrame(AERInstance* inst);


void AERInstanceSetSpriteFrame(AERInstance* inst, float frame);


float AERInstanceGetSpriteSpeed(AERInstance* inst);


void AERInstanceSetSpriteSpeed(AERInstance* inst, float speed);


float AERInstanceGetSpriteAlpha(AERInstance* inst);


void AERInstanceSetSpriteAlpha(AERInstance* inst, float alpha);


float AERInstanceGetSpriteAngle(AERInstance* inst);


void AERInstanceSetSpriteAngle(AERInstance* inst, float angle);


void AERInstanceGetSpriteScale(AERInstance* inst, float* x, float* y);


void AERInstanceSetSpriteScale(AERInstance* inst, float x, float y);


uint32_t AERInstanceGetSpriteBlend(AERInstance* inst);


void AERInstanceSetSpriteBlend(AERInstance* inst, uint32_t color);


bool AERInstanceGetTangible(AERInstance* inst);


void AERInstanceSetTangible(AERInstance* inst, bool tangible);


int32_t AERInstanceGetAlarm(AERInstance* inst, uint32_t alarmIdx);


void AERInstanceSetAlarm(AERInstance* inst,

                         uint32_t alarmIdx,

                         int32_t numSteps);


size_t AERInstanceGetHLDLocals(AERInstance* inst,

                               size_t bufSize,

                               const char** nameBuf);


AERLocal* AERInstanceGetHLDLocal(AERInstance* inst, const char* name);


AERLocal* AERInstanceCreateModLocal(AERInstance* inst,

                                    const char* name,

                                    bool public,

                                    void (*destructor)(AERLocal* local));


void AERInstanceDestroyModLocal(AERInstance* inst,

                                const char* name,

                                bool public);


AERLocal AERInstanceDeleteModLocal(AERInstance* inst,

                                   const char* name,

                                   bool public);


AERLocal* AERInstanceGetModLocal(AERInstance* inst,

                                 const char* name,

                                 bool public);


#endif /* AER_INSTANCE_H */

AERInstanceGetObject
int32_t AERInstanceGetObject(AERInstance *inst)
Query the object of an instance.

AERInstanceSetSprite
void AERInstanceSetSprite(AERInstance *inst, int32_t spriteIdx)
Set the sprite of an instance.

AERInstanceGetSpriteAngle
float AERInstanceGetSpriteAngle(AERInstance *inst)
Query the sprite offset angle of an instance.

AERInstanceGetTangible
bool AERInstanceGetTangible(AERInstance *inst)
Query the tangibility of an instance.

AERInstanceCreateModLocal
AERLocal * AERInstanceCreateModLocal(AERInstance *inst, const char *name, bool public, void(*destructor)(AERLocal *local))
Create a new mod local variable for an instance.

AERInstanceGetAlarm
int32_t AERInstanceGetAlarm(AERInstance *inst, uint32_t alarmIdx)
Query the state of an alarm of an instance.

AERInstanceGetVisible
bool AERInstanceGetVisible(AERInstance *inst)
Query the visibility of an instance.

AERInstanceAddMotion
void AERInstanceAddMotion(AERInstance *inst, float x, float y)
Add to the existing motion of an instance.

AERInstanceGetFriction
float AERInstanceGetFriction(AERInstance *inst)
Query the friction of an instance.

AERInstanceSetDeactivated
void AERInstanceSetDeactivated(AERInstance *inst, bool deactivated)
Set the deactivation state of an instance.

AERInstanceGetMotion
void AERInstanceGetMotion(AERInstance *inst, float *x, float *y)
Query the motion of an instance.

AERInstanceGetSpriteSpeed
float AERInstanceGetSpriteSpeed(AERInstance *inst)
Query the sprite animation speed of an instance.

AERInstanceSetAlarm
void AERInstanceSetAlarm(AERInstance *inst, uint32_t alarmIdx, int32_t numSteps)
Set the state of an alarm of an instance.

AERInstanceGetSpriteAlpha
float AERInstanceGetSpriteAlpha(AERInstance *inst)
Query the sprite alpha (transparency) of an instance.

AERInstanceGetModLocal
AERLocal * AERInstanceGetModLocal(AERInstance *inst, const char *name, bool public)
Get a reference to a specific mod local variable of an instance.

AERInstanceSetFriction
void AERInstanceSetFriction(AERInstance *inst, float friction)
Set the friction of an instance.

AERInstanceGetById
AERInstance * AERInstanceGetById(int32_t instId)
Query the instance with a specific ID in the current room.

AERInstanceSetTangible
void AERInstanceSetTangible(AERInstance *inst, bool tangible)
Set the tangibility of an instance.

AERInstance
void AERInstance
Opaque type for instance of an object.
Definition: instance.h:36

AERInstanceSetSpriteBlend
void AERInstanceSetSpriteBlend(AERInstance *inst, uint32_t color)
Set the sprite blend color of an instance.

AERInstanceAddPosition
void AERInstanceAddPosition(AERInstance *inst, float x, float y)
Add to the existing position of an instance in the current room.

AERInstanceGetDeactivated
bool AERInstanceGetDeactivated(AERInstance *inst)
Query whether or not an instance is deactivated.

AERInstanceSetSpriteAlpha
void AERInstanceSetSpriteAlpha(AERInstance *inst, float alpha)
Set the sprite alpha (transparency) of an instance.

AERInstanceCompatibleWith
bool AERInstanceCompatibleWith(AERInstance *inst, int32_t objIdx)
Query whether an instance's object is or inherits from another object.

AERInstanceGetHLDLocal
AERLocal * AERInstanceGetHLDLocal(AERInstance *inst, const char *name)
Get a reference to a specific vanilla local variable of an instance.

AERInstanceSetVisible
void AERInstanceSetVisible(AERInstance *inst, bool visible)
Set the visibility of an instance.

AERInstanceGetByObject
size_t AERInstanceGetByObject(int32_t objIdx, bool recursive, size_t bufSize, AERInstance **instBuf)
Query all instances of an object in the current room.

AERInstanceGetPersistent
bool AERInstanceGetPersistent(AERInstance *inst)
Query the persistence of an instance.

AERInstanceGetSpriteBlend
uint32_t AERInstanceGetSpriteBlend(AERInstance *inst)
Query the sprite blend color of an instance.

AERInstanceGetBoundingBox
void AERInstanceGetBoundingBox(AERInstance *inst, float *left, float *top, float *right, float *bottom)
Query the axis-aligned bounding box of an instance.

AERInstanceSetMotion
void AERInstanceSetMotion(AERInstance *inst, float x, float y)
Set the motion of an instance.

AERInstanceSetSpriteSpeed
void AERInstanceSetSpriteSpeed(AERInstance *inst, float speed)
Set the sprite animation speed of an instance.

AERInstanceGetAll
size_t AERInstanceGetAll(size_t bufSize, AERInstance **instBuf)
Query all instances in the current room.

AERInstanceGetSprite
int32_t AERInstanceGetSprite(AERInstance *inst)
Query the sprite of an instance.

AERInstanceSetMask
void AERInstanceSetMask(AERInstance *inst, int32_t maskIdx)
Set the collision mask of an instance.

AERInstanceGetSpriteFrame
float AERInstanceGetSpriteFrame(AERInstance *inst)
Query the current frame of sprite animation of an instance.

AERInstanceSetSpriteScale
void AERInstanceSetSpriteScale(AERInstance *inst, float x, float y)
Set the sprite scale of an instance.

AERInstanceSetSpriteFrame
void AERInstanceSetSpriteFrame(AERInstance *inst, float frame)
Set the current frame of sprite animation of an instance.

AERInstanceDeleteModLocal
AERLocal AERInstanceDeleteModLocal(AERInstance *inst, const char *name, bool public)
Destroy a mod local variable but do not call its destructor.

AERInstanceDestroy
void AERInstanceDestroy(AERInstance *inst)
Destroy an instance and call its destroy event.

AERInstanceSyncDepth
void AERInstanceSyncDepth(AERInstance *inst)
Set the render depth of an instance based on its position in the current room.

AERInstanceGetSpriteScale
void AERInstanceGetSpriteScale(AERInstance *inst, float *x, float *y)
Query the sprite scale of an instance.

AERInstanceGetHLDLocals
size_t AERInstanceGetHLDLocals(AERInstance *inst, size_t bufSize, const char **nameBuf)
Query the names of all vanilla local variables of an instance.

AERInstanceGetDepth
float AERInstanceGetDepth(AERInstance *inst)
Query the render depth of an instance.

AERInstanceSetDepth
void AERInstanceSetDepth(AERInstance *inst, float depth)
Set the render depth of an instance.

AERInstanceSetPosition
void AERInstanceSetPosition(AERInstance *inst, float x, float y)
Set the position of an instance in the current room.

AERInstanceChange
void AERInstanceChange(AERInstance *inst, int32_t newObjIdx, bool doEvents)
Convert an instance of one object into an instance of another object in-place.

AERInstanceGetId
int32_t AERInstanceGetId(AERInstance *inst)
Query the ID of an instance.

AERInstanceSetPersistent
void AERInstanceSetPersistent(AERInstance *inst, bool persistent)
Set the persistence of an instance.

AERInstanceGetMask
int32_t AERInstanceGetMask(AERInstance *inst)
Query the collision mask of an instance.

AERInstanceGetPosition
void AERInstanceGetPosition(AERInstance *inst, float *x, float *y)
Query the position of an instance in the current room.

AERInstanceDelete
void AERInstanceDelete(AERInstance *inst)
Destroy an instance but do not call its destroy event.

AERInstanceDestroyModLocal
void AERInstanceDestroyModLocal(AERInstance *inst, const char *name, bool public)
Destroy a mod local variable and call its destructor.

AERInstanceSetSpriteAngle
void AERInstanceSetSpriteAngle(AERInstance *inst, float angle)
Set the sprite offset angle of an instance.

AERInstanceCreate
AERInstance * AERInstanceCreate(int32_t objIdx, float x, float y)
Create an instance of an object.

AERLocal
A dynamic member variable of an instance.
Definition: instance.h:43