Difference between revisions of "Talk:Methods"

From Elite Wiki
(pasted methods)
m (removed outdated requests etc by me)
 
(20 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
'''Methods to be sorted out:'''
 
  +
For the moment lets forget that scripts and AI can share methods - conflating them is confusing.
   
−
=== acceptDistressMessageFrom:(ShipEntity *)other; ===
 
  +
For the moment lets just note that they can share methods and not list extra methods here --[[User:Aegidian|Aegidian]] 16:28, 22 January 2006 (UTC)
−
Has police either respond to a distress call, or possibly decide it is too busy or too scared.
 
   
−
=== addFuel:(NSString*) fuel_number; ===
 
  +
Right, this page is now completely in-line with v1.62 --[[User:Aegidian|Aegidian]] 17:02, 22 January 2006 (UTC)
−
Changes fuel level (only of player entity?) by fuel_numer LY's, max to 7.0 min to 0.0.
 
   
−
=== becomeEnergyBlast ===
 
  +
== Debug? ==
−
Used in the [[Qbomb]].
 
  +
'O' option no longer working on 1.63 for windows?
  +
: Am I correct in thinking this is now 0 (zero)? And are entity and object dumps one and the same? [[User:Uncle Reno|Uncle Reno]] 17:53, 26 March 2007 (BST)
   
−
=== becomeExplosion ===
 
−
The entity model is replaced by an explosion.
 
   
−
=== becomeLargeExplosion ===
 
  +
== Mystery Equipment? ==
−
Used at player entity death, not for use in other instances.
 
   
−
=== broadcastDistressMessage; ===
 
  +
what are: EQ_MILITARY_JAMMER
−
Locates all the stations, bounty hunters and police ships in range and tells them that you are under attack.
 
  +
// EQ_MILITARY_SCANNER_FILTER ?
  +
--[[User:Rxke|Rxke]] 20:35, 14 March 2006 (UTC)
   
−
=== checkCourseToDestination; ===
 
  +
Ask dajt. They were added at his request for some super-speshal-sekrit-stuff. --[[User:Aegidian|Aegidian]] 23:48, 14 March 2006 (UTC)
−
Will return "COURSE_OK" or in case of obstacles on the direct route, "WAYPOINT_SET".
 
   
−
=== checkDistanceTravelled; ===
 
  +
Yeah, sure... He telling me, and then having to kill me, no thanks! ;)
−
May return "GONE_BEYOND_RANGE".
 
−
or "DISTANCE_REACHED"
 
−  
−
=== checkGroupOddsVersusTarget; ===
 
−
Will return "ODDS_GOOD" or "ODDS_BAD".
 
−  
−
=== checkForFullHold; ===
 
−
If entity's cargo capacity is reached, will return "HOLD_FULL".
 
−  
−
=== checkForMotherStation; ===
 
−
Will return "STATION_FOUND" or "NOTHING_FOUND".
 
−  
−
=== checkForNormalSpace; ===
 
−
Will return "NORMAL_SPACE" or "INTERSTELLAR_SPACE".
 
−  
−
=== checkTargetLegalStatus; ===
 
−
Returns "TARGET_CLEAN, "TARGET_MINOR_OFFENDER", "TARGET_OFFENDER", "TARGET_FUGITIVE" or "NO_TARGET".
 
−  
−
=== commsMessage:(NSString *)valueString; ===
 
−
Broadcasts a general message to player.
 
−
Example:
 
−
"sendCommsMessage: [thargoid_curses]"
 
−  
−
=== dealEnergyDamageWithinDesiredRange ===
 
−
Needs desiredRange to be set first, then deals [[weaponEnergy]]([[Shipdata.plist]]) damage within this sphere.
 
−  
−
=== deployEscorts ===
 
−
Deploys an escort.
 
−  
−
=== ejectCargo; ===
 
−
Ejects cargo.
 
−  
−
=== enterTargetWormhole; ===
 
−
Will locate nearest wormhole, and enter it.
 
−  
−
=== escortCheckMother; ===
 
−
Returns "ESCORTING" or "NOT_ESCORTING".
 
−  
−
=== exitAI; ===
 
−
Exits current AI.
 
−  
−
=== fightOrFleeHostiles; ===
 
−
Has entity consider whether to fight, deploy missiles or flee. Returns "FIGHTING", "DEPLOYING_ESCORTS" or "FLEEING".
 
−  
−
=== fightOrFleeMissile; ===
 
−
Deals with missiles, launches ECM if available, flees if not, marks as offender if police.
 
−  
−
=== findNearestPlanet; ===
 
−
(PlanetEntity *)
 
−
Will scan for planetentity, returns message TARGET_FOUND (or NOTHING_FOUND).
 
−  
−
=== fireECM ===
 
−
Used by stations and hermits.
 
−  
−
=== getWitchspaceEntryCoordinates; ===
 
−
Calculates coordinates from the nearest station it can find, or just fly 10s forward.
 
−  
−
=== groupAttackTarget; ===
 
−
All ships in group will have their targets set to this entity's target and performAttack.
 
−  
−
=== initialiseTurret; ===
 
−
Prepares the turret.
 
−  
−
=== landOnPlanet; ===
 
−
Selects the nearest planet it can find, lands (10km from planet) and 'removes' the entity.
 
−  
−
=== LaunchSomeship ===
 
−
Launches a ship fron a dockable entity, various types of this method exist.
 
−
*LaunchDefenceShip
 
−
*LaunchMiner
 
−
*LaunchPolice
 
−
*LaunchScavenger
 
−
Probably will work for other roles too?
 
−  
−
=== markTargetForFines; ===
 
−
Deals out a fine.
 
−
Example:
 
−
"markTargetForFines 100"
 
−
Will fine the target 10Cr. N.b. for commercial transactions "[[awardMoney]] -$" is a more suitable method.
 
−  
−
=== markTargetForOffence:(NSString*) valueString; ===
 
−
Has police mark up the criminal status of target entity.
 
−  
−
=== messageMother:(NSString *)msgString; ===
 
−
Sends a AImessage to the mothership/leader of a group.
 
−
Example:
 
−
INCOMING_MISSILE = ("messageMother: INCOMING_MISSILE");
 
−
The mothership will then behave as if it was targetted by the missile.
 
−  
−
=== patrolReportIn; ===
 
−  
−
=== pauseAI:(NSString *)intervalString; ===
 
−
Sets AI think-time in seconds.
 
−  
−
=== performAttack; ===
 
−
Attacks target.
 
−  
−
=== performCollect; ===
 
−
Performs 'collection' of target.
 
−  
−
=== performDocking; ===
 
−
NOT YET IMPLEMENTED.
 
−  
−
=== performEscort; ===
 
−
Performs escorting.
 
−  
−
=== performFaceDestination; ===
 
−
Has entity face destination.
 
−  
−
=== performFlee; ===
 
−
Sets the caller (AI) to flee from it's primary target at maximum speed. If the caller has a cloacking device, it will be activated.
 
−  
−
=== performFlyToRangeFromDestination; ===
 
−
NOT YET IMPLEMENTED
 
−  
−
=== performHold; ===
 
−
Performs idleness while tracking a potential target.
 
−  
−
=== performHyperSpaceExit; ===
 
−
Gets a list of destinations within range, checks if clear of nearby masses, and select one at random. May return "WITCHSPACE UNAVAILABLE" or "WITCHSPACE BLOCKED".
 
−  
−
=== performIdle; ===
 
−
Performs idleness. Ship corrects its roll and pitch to 'horizontal' flight.
 
−  
−
=== performIntercept; ===
 
−
Performs target interception.
 
−  
−
=== performMining; ===
 
−
Performs mining. (Finds, intercepts and shoots asteroids with [[mining]] laser, if fitted.)
 
−  
−
=== performTumble; ===
 
−
Performs random pitch and roll, 'evasive maneuvers'.
 
−  
−
=== recallDockingInstructions; ===
 
−  
−
=== requestDockingCoordinates; ===
 
−
Requests coordinates from the nearest station it can find (which may be a rock hermit).
 
−  
−
=== requestNewTarget; ===
 
−
Locates all the ships in range targetting the mother ship, and chooses the nearest/biggest.
 
−  
−
=== rollD:(NSString*) die_number; ===
 
−
Uses "dice" for random situation use.
 
−  
−
=== scanForFormationLeader; ===
 
−
Locates the nearest suitable formation leader in range.
 
−  
−
=== scanForHostiles; ===
 
−
Locates all the ships in range targetting the receiver and chooses the nearest.
 
−  
−
=== scanForLoot; ===
 
−
Locates the nearest debris in range.
 
−  
−
=== scanForNearestMerchantmen; ===
 
−
Locates the nearest merchantman in range
 
−  
−
=== scanForNearestShipWithRole:(NSString*) scanRole; ===
 
−
Locates all the ships in range and chooses the nearest.
 
−  
−
=== scanForNonThargoid; ===
 
−
Locates all the non thargoid ships in range and chooses the nearest.
 
−  
−
=== scanForOffenders; ===
 
−
Locates all the ships in range and compares their legal status or bounty, and chooses the worst offender.
 
−  
−
=== scanForRandomLoot; ===
 
−
Locates the all debris in range and chooses a piece at random from the first sixteen found.
 
−  
−
=== scanForRandomMerchantmen; ===
 
−
Locates one of the merchantman in range.
 
−  
−
=== scanForRocks; ===
 
−
Locates the all boulders and asteroids in range and selects one of up to 16. Returns "TARGET_FOUND" or"NOTHING_FOUND".
 
−  
−
=== scanForThargoid; ===
 
−
Locates all the thargoid warships in range and chooses the nearest.
 
−  
−
=== scriptActionOnTarget:(NSString*) action; ===
 
−
Will cause immediate reaction to any changes this makes.
 
−  
−
=== sendTargetCommsMessage:(NSString*) message; ===
 
−
Sends any message to the established (found) target.
 
−  
−
Example:
 
−
"sendTargetCommsMessage: Listen to me!!"
 
−  
−
=== setAITo:(NSString *)aiString; ===
 
−
Pauses current AI and switches to anotherAI.plist, this becomes the top AI on the 'AI-stack'.
 
−
When anotherAI.plist exits ([[exitAI]]), the previousAI becomes topAI again and AI-state is messaged RESTARTED.
 
−  
−
=== setCoordinates:(NSString *)system_x_y_z; ===
 
−
Sets PWM destination coords.
 
−  
−
=== setCourseToPlanet; ===
 
−
Selects the nearest planet it can find, reaching desired range 50 km from the planet.
 
−  
−
=== setCourseToWitchpoint; ===
 
−
Sets destination coords to Witchpoint area.
 
−  
−
=== setDesiredRangeTo:(NSString *)rangeString; ===
 
−
Defines acceptable range distance from destination.
 
−  
−
=== setDestinationFromCoordinates; ===
 
−
Enables the plotting of manual waypoints.
 
−  
−
=== setDestinationToCurrentLocation; ===
 
−
Altitude controll?
 
−  
−
=== setDestinationToDockingAbort; ===
 
−
DockingAbort coordinates...Xm in front of a dockingslit?
 
−  
−
=== setDestinationToStationBeacon; ===
 
−
Gets station beacon position.
 
−  
−
=== setDestinationToTarget; ===
 
−
Sets destination to target coords.
 
−  
−
=== setDestinationToWitchpoint; ===
 
−
Sets destination coords to WitchspaceExitPosition.
 
−  
−
=== setDestinationWithinTarget; ===
 
−
Handy for ramming and racing.
 
−  
−
=== setPlanetPatrolCoordinates; ===
 
−
Check we've arrived near the last given coordinates.
 
−  
−
=== setSpeedTo:(NSString *)speedString; ===
 
−  
−
=== setSpeedFactorTo:(NSString *)speedString; ===
 
−  
−
=== setSunSkimEndCoordinates; ===
 
−  
−
=== setSunSkimExitCoordinates; ===
 
−  
−
=== setSunSkimStartCoordinates; ===
 
−  
−
=== setStateTo: SOMESTATE ===
 
−
Changes the AI state to SOMESTATE.
 
−  
−
=== setTakeOffFromPlanet; ===
 
−
Selects the nearest planet it can find and adds entity 10 km from planet, unless there is no planet to be found.
 
−  
−
=== setTargetToFoundTarget; ===
 
−
Affirms a target found by a scanFor- or find-Something-method as the universal target.
 
−  
−
=== setTargetToPrimaryAggressor; ===
 
−
Changes to a different enemy target if attacked, unless already very busy attacking another.
 
−  
−
=== suggestEscort; ===
 
−
Has an escort seek employment and either gets accepted or rejected by the "mother".
 
−  
−
=== switchAITo:(NSString *)aiString; ===
 
−
Switches entity AI to another *AI.plist, the previous AI will be exited.
 
−  
−
=== switchLightsOff ===
 
−
If an entity has [[Flashers]], this command will turn them off.
 
−
Default state of Flashers is on.
 
−  
−
=== switchLightsOff ===
 
−
Will turn flashers back on.
 
−  
−
=== wormholeEntireGroup; ===
 
−
Wormholes ships in this group.
 
−  
−
=== wormholeEscorts; ===
 
−
Wormholes official escorts.
 
−  
−
=== wormholeGroup; ===
 
−
Wormholes ships in group of which this is a leader.
 

Latest revision as of 12:08, 5 August 2010

For the moment lets forget that scripts and AI can share methods - conflating them is confusing.

For the moment lets just note that they can share methods and not list extra methods here --Aegidian 16:28, 22 January 2006 (UTC)

Right, this page is now completely in-line with v1.62 --Aegidian 17:02, 22 January 2006 (UTC)

Debug?

'O' option no longer working on 1.63 for windows?

Am I correct in thinking this is now 0 (zero)? And are entity and object dumps one and the same? Uncle Reno 17:53, 26 March 2007 (BST)


Mystery Equipment?

what are: EQ_MILITARY_JAMMER // EQ_MILITARY_SCANNER_FILTER ? --Rxke 20:35, 14 March 2006 (UTC)

Ask dajt. They were added at his request for some super-speshal-sekrit-stuff. --Aegidian 23:48, 14 March 2006 (UTC)

Yeah, sure... He telling me, and then having to kill me, no thanks! ;)