Ability

---

An ability is a type of action that you do on a Navigation Map. Using the navigation tools you can specify where you can walk, run, swim, jump etc... At runtime you can execute navigation queries using the ability bit value (aka cap) to create an ability mask that can then be passed to the query function. The type of abilities specified during the navigation query will directly affect the result of the final navigation path returned based on the Zone cost and/or Connection available for each ability.

See Also

Navigation, Map, Zone, Connection

Static Variables

---

Name	Description
navigation	Reference to the Navigation engine where the ability reside. **
Declaration Navigation *navigation Example Lua C/C++ -- Get the first ability of the current scene navigation. local abl=App:GetScene("Scene").navigation:GetAbilityAt(0) -- Print the navigation pointer associated with the ability. print(abl.navigation) // Get the first ability of the current scene navigation. Ability *abl = NavigationGetAbilityAt(AppGetScene("Scene")->navigation,0); // Print the navigation pointer associated with the ability. printf("%p\n",abl.navigation);
cap	The unique bit id of the ability which can be use to create ability mask for navigation query. **
Declaration int cap Example Lua C/C++ -- Get the navigation associated with the scene "Scene". local nav = App:GetScene("Scene").navigation -- Print the cap value for all abilities. for i=0,( nav.ability_count - 1 ) do local abl = nav:GetAbilityAt( i ) print( "Ability " .. abl.name .." cap value:" .. abl.cap ) end // Get the navigation associated with the scene "Scene" Navigation *nav = AppGetScene("Scene")->navigation; // List the cap value of all abilities for( int i = 0; i < nav->ability_count; ++i ) { Ability *abl = NavigationGetAbilityAt( nav, i ); printf("Ability %s cap value: %d\n", abl->id.name, abl->cap ); }
uid	Retrieve the unique id of the ability.
Declaration unsigned int uid

Variables

---

Name	Description
name	Retrieve the unique name that identify the current ability. **
Declaration char *name Example Lua C/C++ -- Get the first ability of the scene navigation local abl = App:GetScene("Scene").navigation:GetAbilityAt(0) -- Change the ability name. abl.name = "Walk" // Get the first ability of the current scene navigation. Ability *abl = NavigationGetAbilityAt(AppGetScene("Scene")->navigation,0); // Change the ability name. AbilityRename( abl, "Walk" );