{"id":44,"date":"2021-07-20T23:24:28","date_gmt":"2021-07-21T04:24:28","guid":{"rendered":"https:\/\/chronocrash.com\/obor\/wiki\/?p=44"},"modified":"2023-12-27T23:33:25","modified_gmt":"2023-12-28T04:33:25","slug":"animations-overview","status":"publish","type":"post","link":"https:\/\/chronocrash.com\/obor\/wiki\/animations-overview\/","title":{"rendered":"Animations"},"content":{"rendered":"\n

Animations are predefined sequences of frames played with timing to produce the illusion of motion or action. OpenBOR uses animations as the basic framework of a model. Most in game actions are part of or require an animation.<\/p>\n\n\n\n

Syntax<\/h1>\n\n\n\n

Unless otherwise noted defining an animation always consists of anim<\/code> followed by the animation name. Individual frames are defined with the frame<\/code> command followed by path to an image file. Offset<\/code> controls the image placement in relation to entity position for a frame, and delay<\/code> determines how long (in centiseconds) a frame stays on-screen. See the following example:<\/p>\n\n\n\n

anim idle\n\n     offset 100 200\n\n     delay 10\n\n     frame data\/chars\/some_guy\/idle_0.png\n     frame data\/chars\/some_guy\/idle_1.png\n     frame data\/chars\/some_guy\/idle_2.png\n\n<\/pre>\n\n\n\n
Tip:<\/strong> You can use a different offset for each frame, but you should avoid doing so. OpenBOR auto trims images on load, so it’s beneficial to select a uniform image size and use one offset. Don’t ever use offsets to simulate movement, there are specific functions and settings for that elsewhere.<\/p>\n\n\n\n
From this foundation, OpenBOR supports dozens of properties and commands to manipulate the behavior of a given animation, determine when it will play, and so on. One example might be an attack box to hit and damage other entities, and a body box that detects the incoming hits.<\/p>\n\n\n\n
Script Access<\/h1>\n\n\n\n
IDs<\/h2>\n\n\n\n
Each animation has a unique identifier acessible through openborconstant(). Unless noted otherwise, the animation constant is always ANI_<ANIMATION_NAME>. See the following example script:<\/p>\n\n\n
\nint current_animation = get_entity_property("animation_id");\n\nif(current_animation == openborconstant("ANI_JUMP"))\n{\n     log("\\n I'm jumping!");\n}\n<\/pre><\/div>\n\n\n
Properties<\/h2>\n\n\n\n
Animation properties are attributes possessed by animations, such as number of frames, collision boxes, cancel points, and so on. Animation properties are accessible through the get_animation_property()<\/code> and set_animation_property()<\/code> functions.<\/p>\n\n\n\n
Animations Vs. Frames:<\/strong> It would be logical to assume each animation has a set of frames with associated frame properties, but in actuality there is no such thing as a distinct frame collection in OpenBOR. Instead, any animation property specific to individual frames has an array of its own.<\/p>\n\n\n\n
Use Cases<\/h3>\n\n\n\n
Get a property value. Properties and their behavior can vary wildly – see the property list for details.<\/p>\n\n\n
\n mixed x = get_animation_property(void <animation handle>, char <identifier>);\n<\/pre><\/div>\n\n\n
Modify a property value. Some properties are read only – see the property list for details.<\/p>\n\n\n
\nmixed x = <value>\n\nset_animation_property(void <animation handle>, char <identifier>, x);\n<\/pre><\/div>\n\n\n
List<\/h3>\n\n\n\n
  • Name: The identifier used to access property through script.<\/li>
  • Type: The property value’s variable type.<\/li>
  • Description: A short description of what the property is and does.<\/li><\/ul>\n\n\n\n
    Name<\/th>Type<\/a><\/th>Read Only<\/th>Description<\/th><\/tr>
    attack_one<\/td>Binary<\/a><\/td><\/td>When TRUE, attack boxes only act on the first detected collision. Default TRUE for grab attacks, FALSE for all others.<\/td><\/tr>
    bounce_factor<\/td>Float<\/a><\/td><\/td>When entity lands from knockdown effect, its falling Y velocity is divided by this value, then applied as a new Y velocity to give a bounce effect. Default is openborconstant(\"ANIMATION_BOUNCE_FACTOR_DEFAULT\")<\/code> (4 as of 2019-11-18).<\/td><\/tr>
    cancel<\/td>Integer<\/a><\/td><\/td>Enable canceling the animation with a special command. This flag is only modified by the engine as a model loads, so you can freely use it to enable or disable cancel ability on a given animation. openborconstant(\"ANIMATION_CANCEL_DISABLED\")<\/code> – Default value. Cancels are not available. openborconstant(\"ANIMATION_CANCEL_ENABLED\")<\/code> – Cancels are enabled. This value is set when a cancel command is encountered while the model loads.<\/td><\/tr>
    charge_time<\/td>Integer<\/a><\/td><\/td>Value (in approximate real time seconds) player must hold attack command button before releasing it will trigger this animation. By default this property only affects CHARGEATTACK<\/a> (or the final series attack if CHARGEATTACK<\/a> is not available) since those are the only animations natively mapped to a hold and release command. Its default value is openborconstant(\"ANIMATION_CHARGE_TIME_DEFAULT\")<\/code><\/td><\/tr>
    counter_action_condition<\/td>Integer<\/a><\/td><\/td>If entity takes a hit during this animation, the following conditions are verified. If all conditions are met, the entity will immediately switch to a follow animation (see follow_up_animation_select). Logic is bitwise. It is possible to set contradictory flags if you aren’t careful, so pay attention when setting up conditions. If a condition is not specifically flagged, it simply isn’t evaluated. For example, if you don’t set a condition for freeze, then a counter can take place whether or not the attack has a freeze effect. openborconstant(\"COUNTER_ACTION_CONDITION_NONE\")<\/code> – Blank condition. If there are no conditions at all, counters are not executed. openborconstant(\"COUNTER_ACTION_CONDITION_ANY\")<\/code> – Always execute counter. Overrides all other conditions. openborconstant(\"COUNTER_ACTION_CONDITION_BACK_FALSE\")<\/code> – Attack must hit entity head on. openborconstant(\"COUNTER_ACTION_CONDITION_BACK_TRUE\")<\/code> – Attack must hit entity from behind. openborconstant(\"COUNTER_ACTION_CONDITION_BLOCK_FALSE\")<\/code> – Attack must be unblockable. openborconstant(\"COUNTER_ACTION_CONDITION_BLOCK_TRUE\")<\/code> – Attack must be blockable. openborconstant(\"COUNTER_ACTION_CONDITION_DAMAGE_LETHAL_FALSE\")<\/code> – Attack force must be insufficient to KO entity. openborconstant(\"COUNTER_ACTION_CONDITION_DAMAGE_LETHAL_TRUE\")<\/code> – Attack force must be sufficient to KO entity (note entity will not be KO’d if the counter triggers). openborconstant(\"COUNTER_ACTION_CONDITION_FREEZE_FALSE\")<\/code> – Attack does not have freeze effect. openborconstant(\"COUNTER_ACTION_CONDITION_FREEZE_TRUE\")<\/code> – Attack does have freeze effect. openborconstant(\"COUNTER_ACTION_CONDITION_HOSTILE_ATTACKER_FALSE\")<\/code> – Attacker must be benign toward entity. openborconstant(\"COUNTER_ACTION_CONDITION_HOSTILE_ATTACKER_TRUE\")<\/code> – Attacker must be hostile toward entity. openborconstant(\"COUNTER_ACTION_CONDITION_HOSTILE_TARGET_FALSE\")<\/code> – Entity must be benign toward attacker. openborconstant(\"COUNTER_ACTION_CONDITION_HOSTILE_TARGET_TRUE\")<\/code> – Entity must be hostile toward attacker.<\/td><\/tr>
    counter_action_frame_max<\/td>Integer<\/a><\/td><\/td>The last frame of an animation when the entity can perform a counter action.<\/td><\/tr>
    counter_action_frame_min<\/td>Integer<\/a><\/td><\/td>The first frame of an animation when the entity can perform a counter action.<\/td><\/tr>
    counter_action_take_damage<\/td>Integer<\/a><\/td><\/td>Controls how entity takes damage when a counter action is performed. openborconstant(\"COUNTER_ACTION_TAKE_DAMAGE_NONE\")<\/code> – Incoming damage is fully negated. openborconstant(\"COUNTER_ACTION_TAKE_DAMAGE_NORMAL\")<\/code> – Entity takes damage (normal damage mitigations still apply), but cannot be reduced below 1 hit-point.<\/td><\/tr>
    drop_frame<\/td>Integer<\/a><\/td><\/td>If set, when entity reaches apex of jump or fall, the animation will skip forward to this frame. If already at or passed this frame, no action is taken. Use openborconstant(\"FRAME_NONE\")<\/code> to disable.<\/td><\/tr>
    drop_model_index<\/td>Integer<\/a><\/td><\/td>If set, when entity drop_frame triggers, the model with this index is spawned into play as a dust effect. Use openborconstant(\"MODEL_INDEX_NONE\")<\/code> to disable.<\/td><\/tr>
    energy_cost_amount<\/td>Integer<\/a><\/td><\/td>Amount of energy resource required to use animation.<\/td><\/tr>
    energy_cost_disable<\/td>Integer<\/a><\/td><\/td>Entity type(s) that are unable to use animation. Uses bitwise logic.<\/td><\/tr>
    energy_cost_type<\/td>Integer<\/a><\/td><\/td>Which energy resource is used and required. openborconstant(\"COST_TYPE_HP_ONLY\")<\/code> – Can only use hit points. openborconstant(\"COST_TYPE_MP_ONLY\")<\/code> – Can only use magic points. openborconstant(\"COST_TYPE_MP_THEN_HP\")<\/code> – Use magic points unless they are insufficient to cover the amount, then use hit points.<\/td><\/tr>
    flip_frame<\/td>Integer<\/a><\/td><\/td>When animation reaches this frame, the entity will switch its facing to the opposite direction.<\/td><\/tr>
    follow_up_animation_select<\/td>Integer<\/a><\/td><\/td>When animation satisfies any existing follow up conditions and this property has a value of 1+, the entity will immediately switch animations to follow<this value>. For instance, if this value is 3, the entity will assume animation follow3, assuming it has that animation available.<\/td><\/tr>
    follow_up_condition<\/td>Integer<\/a><\/td><\/td>If this animation’s attack boxes register a hit, the following conditions are verified. If all conditions are met, the entity will immediately switch to a follow animation (see follow_up_animation_select). Logic is bitwise. It is possible to set contradictory flags if you aren’t careful, so pay attention when setting up conditions. openborconstant(\"FOLLOW_CONDITION_NONE\")<\/code> – Blank condition. If there are no conditions at all, follow ups are not executed. openborconstant(\"FOLLOW_CONDITION_ANY\")<\/code> – Always execute follow up. Overrides all other conditions. openborconstant(\"FOLLOW_CONDITION_BLOCK_FALSE\")<\/code> – Target must not block the attack. openborconstant(\"FOLLOW_CONDITION_BLOCK_TRUE\")<\/code> – Target must block the attack. openborconstant(\"FOLLOW_CONDITION_HOSTILE_ATTACKER_FALSE\")<\/code> – Entity must be benign toward target. openborconstant(\"FOLLOW_CONDITION_HOSTILE_ATTACKER_TRUE\")<\/code> – Entity must be hostile toward target. openborconstant(\"FOLLOW_CONDITION_HOSTILE_TARGET_FALSE\")<\/code> – Target must be benign toward entity. openborconstant(\"FOLLOW_CONDITION_HOSTILE_TARGET_TRUE\")<\/code> – Target must be hostile toward entity. Note the “hostile” options in followcond text command work by toggling this attribute. openborconstant(\"FOLLOW_CONDITION_LETHAL_FALSE\")<\/code> – Attack will not reduce target’s hit points to 0. openborconstant(\"FOLLOW_CONDITION_LETHAL_TRUE\")<\/code> – Attack will reduce target’s hit points to 0.<\/td><\/tr>
    frame_count<\/td>Integer<\/a><\/td><\/td>Number of frames in animation.<\/td><\/tr>
    hit_count<\/td>Integer<\/a><\/td><\/td>Number of attack hits by this animation. Used to determine cancel availability and resets each time animation changes. Note blocked hits still count toward this value.<\/td><\/tr>
    index<\/td>Integer<\/a><\/td><\/td>Sequential index assigned to each animation when loaded into memory. This is NOT the animation ID (Idle, Walk, etc.) – it is a specific integer value that is unique to all animations across all models.<\/td><\/tr>
    jump_frame<\/td>Integer<\/a><\/td><\/td>If set, upon reaching this frame the entity will toss itself into the air as if in a jump. Use the jump velocity settings to control how fast\/far. Use openborconstant(\"FRAME_NONE\")<\/code> to disable.<\/td><\/tr>
    jump_model_index<\/td>Integer<\/a><\/td><\/td>If set, when entity jump_frame triggers, the model with this index is spawned into play as a dust effect. Use openborconstant(\"MODEL_INDEX_NONE\")<\/code> to disable.<\/td><\/tr>
    jump_velocity_x<\/td>Float<\/a><\/td><\/td>X axis velocity applied on jump_frame.<\/td><\/tr>
    jump_velocity_y<\/td>Float<\/a><\/td><\/td>Y axis velocity applied on jump_frame.<\/td><\/tr>
    jump_velocity_z<\/td>Float<\/a><\/td><\/td>Z axis velocity applied on jump_frame.<\/td><\/tr>
    land_frame<\/td>Integer<\/a><\/td><\/td>If set, when entity touches ground (base) during jump or fall, the animation will skip forward to this frame. If already at or passed this frame, no action is taken. Use openborconstant(\"FRAME_NONE\")<\/code> to disable.<\/td><\/tr>
    land_model_index<\/td>Integer<\/a><\/td><\/td>If set, when entity land_frame triggers, the model with this index is spawned into play as a dust effect. Use openborconstant(\"MODEL_INDEX_NONE\")<\/code> to disable.
    <\/td><\/tr>
    loop_frame_end<\/td>Integer<\/a><\/td><\/td>When looping is enabled, the animation loops immediately upon reaching this frame (in other words, this frame is not seen). If not set or 0, the animation loops after playing last frame.<\/td><\/tr>
    loop_frame_start<\/td>Integer<\/a><\/td><\/td>When looping is enabled, the animation loops loops back to this frame. If not set, the animation loops to first frame.<\/td><\/tr>
    loop_state<\/td>  Binary<\/a><\/td><\/td>If TRUE, animation loops.<\/td><\/tr>
    model_index<\/td>Integer<\/a><\/td><\/td>Model index this animation attached to at load.<\/td><\/tr>
    projectile<\/td>Pointer<\/a><\/td><\/td>Handle for animation’s projectile properties.<\/td><\/tr>
    quake_frame_start<\/td>Integer<\/a><\/td><\/td>When animation with quake effect reaches this frame, the quake effect begins.<\/td><\/tr>
    quake_move_y<\/td>Integer<\/a><\/td><\/td>Number of pixels screen elements are adjusted along Y axis on each quake frame to produce a visual shake effect.<\/td><\/tr>
    quake_repeat_count<\/td>Integer<\/a><\/td><\/td>Number of “shakes” applied by current quake effect.<\/td><\/tr>
    quake_repeat_max<\/td>Integer<\/a><\/td><\/td>Maximum number of “shakes” before quake effect ends.<\/td><\/tr>
    range_base_max<\/td>Integer<\/a><\/td><\/td>Maximum range detection for base axis.<\/td><\/tr>
    range_base_min<\/td>Integer<\/a><\/td><\/td>Minimum range detection for base axis.<\/td><\/tr>
    range_x_max<\/td>Integer<\/a><\/td><\/td>Maximum range detection for X axis.<\/td><\/tr>
    range_x_min<\/td>Integer<\/a><\/td><\/td>Minimum range detection for X axis.<\/td><\/tr>
    range_y_max<\/td>Integer<\/a><\/td><\/td>Maximum range detection for Y axis.<\/td><\/tr>
    range_y_min<\/td>Integer<\/a><\/td><\/td>Minimum range detection for Y axis.<\/td><\/tr>
    range_z_max<\/td>Integer<\/a><\/td><\/td>Maximum range detection for Z axis.<\/td><\/tr>
    range_z_min<\/td>Integer<\/a><\/td><\/td>Minimum range detection for Z axis.<\/td><\/tr>
    size_x<\/td>Integer<\/a><\/td><\/td>Entity’s size (for interacting with terrain like walls, platforms, obstacles, etc.) along the X axis.<\/td><\/tr>
    size_y<\/td>Integer<\/a><\/td><\/td>Entity’s size (for interacting with terrain like walls, platforms, obstacles, etc.) along the Y axis.<\/td><\/tr>
    sub_entity_model_index<\/td>Integer<\/a><\/td><\/td>Model index spawned into play by either sub_entity_spawn, or sub_entity_summon properties.<\/td><\/tr>
    sub_entity_spawn<\/td>Integer<\/a><\/td><\/td>Pointer to sub entity properties controlling the frame and location of a sub entity spawn. If spawned with this property, the sub entity’s parent value is the entity that spawned it, but there is otherwise no default relationship. Spawns are unlimited.<\/td><\/tr>
    sub_entity_summon<\/td>Integer<\/a><\/td><\/td>Pointer to sub entity properties controlling the frame and location of a sub entity summon. If spawned with this property sub entity’s parent value is the entity that spawned it, and the parent’s child value is the spawned entity. The parent may unsummon its child entity at any time. One summon is allowed per parent – if a second entity is summoned, the new summon replaces previous summon in parent’s child property. Effectively, the previous summoned entity is now a spawn.<\/td><\/tr>
    sub_entity_unsummon<\/td>Integer<\/a><\/td><\/td>When entity reaches this frame, its child dies. Specifically, the child will damage itself with type openborconstant(\"ATK_SUB_ENTITY_UNSUMMON\")<\/code>.<\/td><\/tr>
    subject_to_gravity<\/td>Binary<\/a><\/td><\/td>If TRUE, gravity does not apply to entity during animation. Same as model subject_to_gravity.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"
    Animation basics and script access.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[8,328,2],"tags":[28,29,4,3],"class_list":["post-44","post","type-post","status-publish","format-standard","hentry","category-animation","category-openbor","category-script","tag-obor_func_get_animation_property","tag-obor_func_set_animation_property","tag-openbor-script","tag-variables"],"revision_note":"","jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts\/44","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/comments?post=44"}],"version-history":[{"count":5,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts\/44\/revisions"}],"predecessor-version":[{"id":1309,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/posts\/44\/revisions\/1309"}],"wp:attachment":[{"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/media?parent=44"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/categories?post=44"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/chronocrash.com\/obor\/wiki\/wp-json\/wp\/v2\/tags?post=44"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}