ArcBasicDocs

Built-in constants

Names for the numbers that commands use, so KeyDown(KEY_LEFT) can say what KeyDown(203) means. Use them anywhere a number goes; they never change.

If your program has its own Const, Global or variable with the same name as one of these, yours is used instead, so older programs keep working.

Keys

NameValueMeaning
KEY_ESCAPE1The Escape key
KEY_12The 1 key
KEY_23The 2 key
KEY_34The 3 key
KEY_45The 4 key
KEY_56The 5 key
KEY_67The 6 key
KEY_78The 7 key
KEY_89The 8 key
KEY_910The 9 key
KEY_011The 0 key
KEY_MINUS12The - key
KEY_EQUALS13The = key
KEY_BACKSPACE14The Backspace key
KEY_TAB15The Tab key
KEY_Q16The Q key
KEY_W17The W key
KEY_E18The E key
KEY_R19The R key
KEY_T20The T key
KEY_Y21The Y key
KEY_U22The U key
KEY_I23The I key
KEY_O24The O key
KEY_P25The P key
KEY_LBRACKET26The [ key
KEY_RBRACKET27The ] key
KEY_ENTER28The Enter (Return) key
KEY_LCTRL29The left Ctrl key
KEY_A30The A key
KEY_S31The S key
KEY_D32The D key
KEY_F33The F key
KEY_G34The G key
KEY_H35The H key
KEY_J36The J key
KEY_K37The K key
KEY_L38The L key
KEY_SEMICOLON39The ; key
KEY_APOSTROPHE40The ' key
KEY_GRAVE41The ` (backtick) key
KEY_LSHIFT42The left Shift key
KEY_BACKSLASH43The \ key
KEY_Z44The Z key
KEY_X45The X key
KEY_C46The C key
KEY_V47The V key
KEY_B48The B key
KEY_N49The N key
KEY_M50The M key
KEY_COMMA51The , key
KEY_PERIOD52The . key
KEY_SLASH53The / key
KEY_RSHIFT54The right Shift key
KEY_LALT56The left Alt key
KEY_SPACE57The Space key
KEY_CAPSLOCK58The Caps Lock key
KEY_F159The F1 key
KEY_F260The F2 key
KEY_F361The F3 key
KEY_F462The F4 key
KEY_F563The F5 key
KEY_F664The F6 key
KEY_F765The F7 key
KEY_F866The F8 key
KEY_F967The F9 key
KEY_F1068The F10 key
KEY_F1187The F11 key
KEY_F1288The F12 key
KEY_RCTRL157The right Ctrl key
KEY_RALT184The right Alt key
KEY_HOME199The Home key
KEY_UP200The up arrow key
KEY_PAGEUP201The Page Up key
KEY_LEFT203The left arrow key
KEY_RIGHT205The right arrow key
KEY_END207The End key
KEY_DOWN208The down arrow key
KEY_PAGEDOWN209The Page Down key
KEY_INSERT210The Insert key
KEY_DELETE211The Delete key
KEY_PAD082The keypad 0 key
KEY_PAD179The keypad 1 key
KEY_PAD280The keypad 2 key
KEY_PAD381The keypad 3 key
KEY_PAD475The keypad 4 key
KEY_PAD576The keypad 5 key
KEY_PAD677The keypad 6 key
KEY_PAD771The keypad 7 key
KEY_PAD872The keypad 8 key
KEY_PAD973The keypad 9 key
KEY_PADENTER156The keypad Enter key

Mouse

NameValueMeaning
MOUSE_LEFT1The left mouse button, for MouseDown and MouseHit
MOUSE_RIGHT2The right mouse button
MOUSE_MIDDLE3The middle mouse button

Lights and Cameras

NameValueMeaning
LIGHT_DIRECTIONAL1CreateLight: lights everything from one direction, like the sun
LIGHT_POINT2CreateLight: shines in every direction from a point, like a bulb
LIGHT_SPOT3CreateLight: shines in a cone, like a torch
PROJ_NONE0CameraProjMode: the camera draws nothing
PROJ_PERSPECTIVE1CameraProjMode: normal 3D, distant things look smaller
PROJ_ORTHO2CameraProjMode: no perspective, things look the same size at any distance

Animation

NameValueMeaning
ANIM_STOP0Animate: stops animating
ANIM_LOOP1Animate: plays over and over
ANIM_PINGPONG2Animate: plays forwards, then backwards, over and over
ANIM_ONCE3Animate: plays once and stops

Appearance

NameValueMeaning
BLEND_ALPHA1EntityBlend: normal see-through blending
BLEND_MULTIPLY2EntityBlend: darkens what is behind
BLEND_ADD3EntityBlend: brightens what is behind, for glows and fire
FX_FULLBRIGHT1EntityFX: not affected by lights
FX_VERTEXCOLOR2EntityFX: uses the mesh's vertex colours
FX_NOFOG8EntityFX: not affected by fog
FX_DOUBLESIDED16EntityFX: both sides of each triangle are drawn
FX_FORCEALPHA32EntityFX: always drawn as see-through
TEX_COLOR1LoadTexture flag: a colour texture
TEX_ALPHA2LoadTexture flag: keeps the image's transparency
TEX_MASKED4LoadTexture flag: black pixels are see-through
TEX_MIPMAP8LoadTexture flag: smoother when seen from far away
TEX_CLAMPU16LoadTexture flag: doesn't repeat across
TEX_CLAMPV32LoadTexture flag: doesn't repeat down

Collisions and Picking

NameValueMeaning
COLLIDE_SPHERE1Collisions method: sphere against sphere
COLLIDE_POLYGON2Collisions method: sphere against the other entity's triangles
COLLIDE_BOX3Collisions method: sphere against the other entity's box
RESPONSE_STOP1Collisions response: stops dead
RESPONSE_SLIDE2Collisions response: slides along what it hits
RESPONSE_SLIDE_NOSLOPE3Collisions response: slides, but doesn't slide down slopes
PICK_NONE0EntityPickMode: can't be picked
PICK_SPHERE1EntityPickMode: picked by its sphere
PICK_POLYGON2EntityPickMode: picked by its triangles
PICK_BOX3EntityPickMode: picked by its box

Physics

NameValueMeaning
PHYS_NONE0EntityPhysics: no physics body
PHYS_STATIC1EntityPhysics: never moves, like the ground or walls
PHYS_DYNAMIC2EntityPhysics: moved by gravity, forces and collisions
PHYS_KINEMATIC3EntityPhysics: moved by the program, pushes dynamic bodies
PHYS_TRIGGER4EntityPhysics: an invisible zone that notices bodies inside it
PHYS_CHARACTER5GetEntityPhysics: a character made with EntityCharacter
PHYS_SOFT6GetEntityPhysics: a soft body made with EntitySoftBody
SHAPE_AUTO0EntityShape: fitted to the entity's mesh
SHAPE_BOX1EntityShape: a box
SHAPE_SPHERE2EntityShape: a ball
SHAPE_CAPSULE3EntityShape: a capsule
SHAPE_CYLINDER4EntityShape: a cylinder
SHAPE_HULL5EntityShape: a convex hull wrapped around the mesh
SHAPE_MESH6EntityShape: the mesh's own triangles, for static and kinematic bodies