point
Browse its members and the signatures that accept or return this type.
Members
13Expand a member to read its notes or open its full entry. Each overload keeps its own identity.
| Member | Signature and description |
|---|---|
| point | int& point::x()Returns the horizontal coordinate of the point. |
| int& point::y()The two shared component adapters retain an eight-byte encoded reference pair, with a zero or four-byte adjustment to its second dword. |
| point | int point::x()Returns the horizontal coordinate of the point. |
| point | int point::y()Returns the vertical coordinate of the point. |
| point | point point::Set(int, int)Sets the horizontal and vertical coordinates and returns the updated point. |
| void point::SetLen(int)Rescales the point's integer coordinates toward the requested vector length, modifying the point in place. Integer arithmetic and truncation can make the resulting length differ from the requested value. |
| point | int point::Len()Returns the integer square root of the sum of the squared coordinates. |
| void point::Rot(int)Rotates a referenced integer point through an integer angle using sine and cosine. |
| bool point::InRect(rect)Checks whether the point lies inside the rectangle, including its boundaries. |
| point | void point::IntoRect(rect)Limits the point's coordinates to the rectangle's boundaries. |
| point | int point::Dist(point)returns the integer square root of dx squared plus dy squared. |
| GAIKA point::GetGAIKA()Shared handler for GetGAIKA and point::GetGAIKA that resolves a point through the global AI map. |
| point point::ClampToMap()point::ClampToMap clamps each coordinate to zero through its map dimension minus one when a global map exists. |
Return this type
54| Member | Signature and description |
|---|---|
PointGlobal | point Point(int, int)Creates a point from its horizontal coordinate x and vertical coordinate y, in that order. |
point::Setpoint | point point::Set(int, int)Sets the horizontal and vertical coordinates and returns the updated point. |
+Global | point +(point, point)Description pendingDescription pending. |
-Global | point -(point, point)Description pendingDescription pending. |
*Global | point *(point, int)Description pendingDescription pending. |
/Global | point /(point, int)Description pendingDescription pending. |
rect::Centerrect | point rect::Center()Returns the integer center point of the rectangle. |
GetMapSizeGlobal | point GetMapSize()GetMapSize pushes the two 32-bit bound differences plus one from the pointer stored at [field]. |
Obj::posObj | point Obj::pos()Returns the object's position as a point. An invalid object returns zero coordinates. |
Obj::posRHObj | point Obj::posRH()Resolves an Obj handle and returns an eight-byte point from virtual slot [field]. |
Obj::GetDirObj | point Obj::GetDir()Returns two 32-bit components from the resolved Obj. If resolution fails, returns the default vector (0, 1). |
Obj::ClipDestToMapObj | point Obj::ClipDestToMap(point)Obj::ClipDestToMap ignores the object handle and clamps the point coordinates to the global map bounding rect at offset [field] of [shared state]. |
Query::GetAverageDirectionQuery | point Query::GetAverageDirection()Returns the average direction of the query's objects, or a zero point for an empty or invalid query. |
Building::GetEnterPointBuilding | point Building::GetEnterPoint(Unit)calculates the entrance point coordinates of a building relative to an approaching unit. |
Building::GetExitPointBuilding | point Building::GetExitPoint(Obj, point)Resolves an exit point from a Building, an Obj template category, and an incoming point. |
Building::GetExitPointBuilding | point Building::GetExitPoint(point, bool)Resolves an exit point from a Building, an incoming point, and a boolean mode. |
Building::GetPointBuilding | point Building::GetPoint(int, int)Description pendingDescription pending. |
Building::GetExitVectorBuilding | point Building::GetExitVector()Building GetExitVector returns template dwords at [field] and [field], with (-1,-1) for a sentinel first dword. |
GetCatapultAttackPointGlobal | point GetCatapultAttackPoint(point)Description pendingDescription pending. |
Catapult::GetPointOnTargetCatapult | point Catapult::GetPointOnTarget(Obj)Description pendingDescription pending. |
Catapult::CalcEscapeDirectionCatapult | point Catapult::CalcEscapeDirection()Description pendingDescription pending. |
Unit::destUnit | point Unit::dest()Returns two signed 16-bit components from path-controller virtual [field] when Unit [field] exists, otherwise from Unit virtual [field]; an invalid Unit returns (-1,-1). |
Unit::GetUnexploredPointUnit | point Unit::GetUnexploredPoint(int)Returns a random unexplored point near the unit, or the point (-1, -1) when it finds none. |
Unit::PathDestFoundUnit | point Unit::PathDestFound()When Unit [field] exists and its virtual [field] returns nonzero, returns the point from path virtual [field]; otherwise returns (-1,-1). |
Hero::GetFinalPartyOrientationHero | point Hero::GetFinalPartyOrientation()Returns the transformed stored orientation point for this function. |
Building::GetEnterExitBuilding | point Building::GetEnterExit()Delegates to a random point lookup using point type 12. The meaning of that type is not documented here. |
Building::GetWaterSourceBuilding | point Building::GetWaterSource()Delegates to a random point lookup using point type 13. The meaning of that type is not documented here. |
Building::GetGoodsSourceBuilding | point Building::GetGoodsSource()Delegates to a random point lookup using point type 14. The meaning of that type is not documented here. |
Building::GetFixSiteBuilding | point Building::GetFixSite()Delegates to a random point lookup using point type 15. The meaning of that type is not documented here. |
Settlement::FindNearEnterExitSettlement | point Settlement::FindNearEnterExit(point)Searches settlement type12 points and selects the first strict minimum of a transformed integer distance metric. |
ViewPosGlobal | point ViewPos()Converts the native viewport midpoint to a world point and pushes it on the CKS VM stack. |
GetVecGlobal | point GetVec(point, point, int)Scales a wrapped integer point difference using signed division by an integer helper return. |
RandomOffsetGlobal | point RandomOffset(int)RandomOffset calls virtual slot [field] twice on Game[field] with the pair (-r,r), then writes (second,first). |
RandomPointInCircleGlobal | point RandomPointInCircle(point, int)Constructs a point from radial and angular samples and clamps it to map bounds. |
AreaCenterGlobal | point AreaCenter(str)Returns area coordinates selected by its geometry mode field. |
GetRandomPointInAreaGlobal | point GetRandomPointInArea(str)Returns a helper point or a fixed pair when area lookup fails. |
Teleport::exit_vectorTeleport | point Teleport::exit_vector()Teleport exit_vector copies two dwords. |
Ship::FindPointToStayShip | point Ship::FindPointToStay()FindPointToStay tries up to 100 points offset by two separate [-500,500] draws, requiring matching LSA, a clear occupancy bit and a nonzero clearance-helper result. |
Ship::GetTransPtShip | point Ship::GetTransPt()Returns two 32-bit components from the resolved Ship as a point. |
Flying::PickFlyingPointFlying | point Flying::PickFlyingPoint(int)Picks a flight point at roughly the distance given by the argument. It follows the heading of a nearby moving unit of the same class; otherwise it tries twelve directions and chooses the least crowded one closest to the current heading. |
Flying::PickLandingPointFlying | point Flying::PickLandingPoint(int)Description pendingDescription pending. |
GetVecByDirGlobal | point GetVecByDir(point, int)Scales an input point vector to a requested integer magnitude. |
GetDirByAngleGlobal | point GetDirByAngle(int)Handler for this function, point GetDirByAngle(int): returns cosine and sine of a degree angle scaled by 100. |
Unit::dirUnit | point Unit::dir()Returns two 32-bit components from the resolved Unit as a point. |
Squad::posSquad | point Squad::pos()Resolves a squad leader and returns its point or (-1,-1). |
GAIKA::CenterGAIKA | point GAIKA::Center()GAIKA::Center copies dwords +8 and +12 from a resolved GAIKA record, returning a zero point if no record resolves. |
GAIKA::GetDestPointGAIKA | point GAIKA::GetDestPoint(Unit)Returns a stored destination or derives an approach point for selected building configurations. |
Settlement::FindCatapultSpotSettlement | point Settlement::FindCatapultSpot(point)CKS adapter with unreconciled twenty-byte native input consumption that forwards an extra selector to class lookup and cached point selection. |
GetGaikaCenterGlobal | point GetGaikaCenter(int)Returns the point fields of a record selected by the low 16 bits of the input. |
GetSquadCenterGlobal | point GetSquadCenter(int, int)Averages resolved squad-member coordinates using unsigned division by the stored total count. |
ViewSlotGlobal | point ViewSlot()Returns viewport midpoint coordinates divided by128 while discarding the terrain-conversion output. |
Unit::BestMDPosUnit | point Unit::BestMDPos(int, int, int, int, bool)Ranks filtered hostile squad leaders by a circle relation count with optional friendly penalties and a distance bonus. |
MousePtmGlobal | point MousePtm()MousePtm pushes the dwords at receiver[field] and [field] from [[field]]. |
point::ClampToMappoint | point point::ClampToMap()point::ClampToMap clamps each coordinate to zero through its map dimension minus one when a global map exists. |
Accept this type
98| Member | Signature and description |
|---|---|
point::Distpoint | int point::Dist(point)returns the integer square root of dx squared plus dy squared. |
+Global | point +(point, point)Description pendingDescription pending. |
-Global | point -(point, point)Description pendingDescription pending. |
*Global | point *(point, int)Description pendingDescription pending. |
/Global | point /(point, int)Description pendingDescription pending. |
DistGlobal | int Dist(point, point)returns the integer square root of dx squared plus dy squared. |
=Global | void =(point&, point)Description pendingDescription pending. |
==Global | bool ==(point, point)Description pendingDescription pending. |
!=Global | bool !=(point, point)Description pendingDescription pending. |
Obj::AddCommandObj | void Obj::AddCommand(bool, str, point)Adds a named command with a point as its target. |
Obj::SetCommandObj | void Obj::SetCommand(str, point)Creates and submits a named command for the object with a point as its target. |
Obj::ExecDefaultCmdObj | void Obj::ExecDefaultCmd(point, Obj, bool, bool)Builds a one-receiver packet for default-command dispatch with point, target identifier and normalized flags. |
Obj::ExecCmdObj | void Obj::ExecCmd(str, point, Obj, bool)Validates an object and named command, then dispatches it with script arguments. |
Obj::DistToObj | int Obj::DistTo(point)Obj::DistTo computes distance from an Obj to a point and subtracts its template offset. |
Obj::SetPosObj | void Obj::SetPos(point)Description pendingDescription pending. |
Obj::SetPosSimpleObj | void Obj::SetPosSimple(point)Clamps the supplied point and invokes virtual placement with two true flags. |
Obj::FaceObj | void Obj::Face(point)Initializes an object command context, sets its facing point and conditionally invokes its command-update virtual method. |
Obj::PlayAnimObj | void Obj::PlayAnim(int, point)Requests a script-object animation and returns the VM suspension code. |
Obj::StartAnimObj | void Obj::StartAnim(int, point)Prepares and requests an animation with an optional target point. |
Obj::StartDelayedAnimObj | void Obj::StartDelayedAnim(int, point, int)Normalizes an equal-current point and forwards a decremented animation identifier with a final integer. |
Obj::DropItemObj | bool Obj::DropItem(Item, point)Requests that a specified receiver item be dropped at a point while returning false. |
Obj::ClipDestToMapObj | point Obj::ClipDestToMap(point)Obj::ClipDestToMap ignores the object handle and clamps the point coordinates to the global map bounding rect at offset [field] of [shared state]. |
PlaceGlobal | Obj Place(str, point, int)Creates an object of the named class at a map position for the specified player, when placement is possible. |
ObjsInCircleGlobal | Query ObjsInCircle(point, int, str)Returns a class-filtered spatial query centered on a point with a supplied radius. |
Query::AddDefCmdQuery | void Query::AddDefCmd(point, Obj, bool, bool)Resolves Query and optional Obj, passes point, target ID or 65535 and two normalized flags to the default-command dispatch chain. |
Query::AddCommandQuery | void Query::AddCommand(bool, str, point)Dispatches factory mode one with the unchanged point pair for each live Query member and installs nonnull results. |
Query::AddCommandOffsetQuery | void Query::AddCommandOffset(bool, str, point)Transforms each live member position by requested point minus live-member average, then dispatches mode one without local clamping. |
Query::SetCommandQuery | void Query::SetCommand(str, point)Creates and installs the requested point command on each valid object selected by a Query. |
Query::SetCommandOffsetQuery | void Query::SetCommandOffset(str, point)Translates member positions relative to the live-member average and clamps them before factory mode-one dispatch, after virtual [field](0). |
NearestObjGlobal | Obj NearestObj(Query, point)Description pendingDescription pending. |
Query::NearestObjQuery | Obj Query::NearestObj(point)Description pendingDescription pending. |
Query::FaceQuery | void Query::Face(point)Applies a face-point command to each live member of a query. |
EnemyInRangeGlobal | bool EnemyInRange(point, int, Obj)Builds a wrapped bounding rectangle and returns the spatial callback accumulator as a boolean. |
Building::GetExitPointBuilding | point Building::GetExitPoint(Obj, point)Resolves an exit point from a Building, an Obj template category, and an incoming point. |
Building::GetExitPointBuilding | point Building::GetExitPoint(point, bool)Resolves an exit point from a Building, an incoming point, and a boolean mode. |
GetCatapultAttackPointGlobal | point GetCatapultAttackPoint(point)Description pendingDescription pending. |
Catapult::RotateToCatapult | void Catapult::RotateTo(point)Description pendingDescription pending. |
Catapult::AttackCatapult | void Catapult::Attack(point)Description pendingDescription pending. |
Catapult::InRangeCatapult | bool Catapult::InRange(point)Description pendingDescription pending. |
Unit::GotoUnit | bool Unit::Goto(point, int, int, bool, int)Clamps the point to map bounds and coordinates a Unit path controller, movement command, wait ticks and terminal bool through native status 0, 1 or 2; its path destination call passes final flag 1. |
Unit::GotoEnterUnit | bool Unit::GotoEnter(point, int, int, bool, int)Follows the point-route wait and completion branches while passing final flag 0 to the path destination call at [field]; the sibling Goto point handler passes 1. |
Unit::GotoStraightUnit | void Unit::GotoStraight(point)Constructs a path object on the first blocking invocation or reuses its saved pointer, calls its virtual [field] with a calculated step time, and returns native status 1 while a step remains or 0 after destroying the object. |
Unit::ExitHolderUnit | void Unit::ExitHolder(point)CKS-exposed Unit::ExitHolder passes a position to a reserve and movement path that can detach the Unit from its Holder. |
Unit::BestTargetInRangeUnit | Obj Unit::BestTargetInRange(point, int)Forwards explicit point coordinates and integer radius to the common target-search helper. |
Unit::PathToUnit | int Unit::PathTo(point, int, int)Prepares a point-centered path query for a Unit and returns the native pathfinder result code or a sentinel. |
Hero::FormSetupAndMoveToHero | void Hero::FormSetupAndMoveTo(point, int, int, bool)After holder-related waits, the point overload clears the Hero path controller, passes the point, two integers, and bool to formation destination change; on success it installs a new controller, enables formation move mode, and sets Hero [field] to 3. |
Hero::SetFinalPartyOrientationHero | void Hero::SetFinalPartyOrientation(point)Stores the transformed orientation request point for this function. |
Settlement::FindNearEnterExitSettlement | point Settlement::FindNearEnterExit(point)Searches settlement type12 points and selects the first strict minimum of a transformed integer distance metric. |
ObjList::AddCommandObjList | void ObjList::AddCommand(bool, str, point)For each resolved eligible member, creates a named point command with selector 1 and submits it through virtual [field] using the supplied Boolean. |
ObjList::AddCommandOffsetObjList | void ObjList::AddCommandOffset(bool, str, point)Creates point-targeted commands for object-list members while preserving their offsets from the list center. |
ObjList::ExecDefaultCmdObjList | void ObjList::ExecDefaultCmd(point, Obj, bool, bool)Resolves the optional Obj handle to its object identifier at +8 and delegates the list, point, identifier, two Booleans and -1 to [field]. |
ObjList::ExecCmdObjList | void ObjList::ExecCmd(str, point, Obj, bool)Looks up the supplied command string through the command-order registry virtual [field]; on success passes the resolved command and remaining arguments to [field], while the failure path reports an invalid command. |
ObjList::SetCommandObjList | void ObjList::SetCommand(str, point)For each resolved eligible member, calls virtual [field] with zero, creates a named point command with selector 1, submits it through virtual [field] with false, and updates command state. |
ObjList::SetCommandOffsetObjList | void ObjList::SetCommandOffset(str, point)Computes the list center, offsets each eligible member position from that center, clamps the translated target to map bounds, then creates and submits a selector-1 point command after virtual [field]. |
ObjList::FilterClosestObjList | ObjList ObjList::FilterClosest(point, int)Creates an ObjList through a bounded distance-selection helper using a point and count. |
ObjList::FaceObjList | void ObjList::Face(point)After popping the point and receiver list, the handler traverses member slots. |
ViewGlobal | void View(point, bool)Pops a world point and lock boolean from the CKS VM stack and forwards them to the native camera-centering helper. |
ExploreCircleGlobal | void ExploreCircle(int, point, int)Validates a player index and delegates a center and radius to a map exploration helper. |
GetVecGlobal | point GetVec(point, point, int)Scales a wrapped integer point difference using signed division by an integer helper return. |
IsPassableGlobal | bool IsPassable(point)Returns an inverse map bitmap bit after signed bounds checks. |
IsPassable3x3Global | bool IsPassable3x3(point)Tests a point and its eight surrounding offsets through a map passability bitmap helper. |
IsExploredGlobal | bool IsExplored(point, int)Forwards a point and decremented player value to the exploration receiver. |
RandomPointInCircleGlobal | point RandomPointInCircle(point, int)Constructs a point from radial and angular samples and clamps it to map bounds. |
RevealHiddenEnemyUnitsGlobal | void RevealHiddenEnemyUnits(point, int, int)Description pendingDescription pending. |
AreaDistToGlobal | int AreaDistTo(point, str)Computes a nonnegative area distance value after name resolution. |
_AdvPlaceAreaCircGlobal | void _AdvPlaceAreaCirc(str, point, int, str, str)Spawns and configures a circular adventure area from script arguments. |
CreateFeedbackGlobal | void CreateFeedback(str, point)Constructs named feedback at a supplied point and initializes its scheduling field from the current game field. |
CreateFeedbackGlobal | void CreateFeedback(str, point, int)Constructs named feedback at a supplied point and initializes its scheduling field with the integer offset. |
Ship::ShowBuildAnimationShip | void Ship::ShowBuildAnimation(point)Slides an already created ship from the shipyard exit along the given vector over about 800 milliseconds, like a launch. It is not a construction sequence. |
IsPointInWaterGlobal | bool IsPointInWater(point)Evaluates whether a given map coordinate corresponds to a water terrain tile by querying the global map terrain grid. |
Item::UseItem | void Item::Use(point)Clamps a point to signed map bounds and forwards it to the positional use helper. |
Flying::PlayAnimFlying | void Flying::PlayAnim(int, point, int)Validates and starts a Flying animation, then suspends the VM. |
Flying::AdjustFlyDirFlying | void Flying::AdjustFlyDir(point&)Conditionally transforms a referenced point outside an inset rectangle using object vector fields and quadrant rotations. |
GetTerrainHeightGlobal | int GetTerrainHeight(point)Clamps a world point to map bounds and samples terrain height there. |
GetVecByDirGlobal | point GetVecByDir(point, int)Scales an input point vector to a requested integer magnitude. |
GetAngleByDirGlobal | int GetAngleByDir(point)GetAngleByDir forms a wrapped unsigned squared length and applies a finite-path asin/quadrant pipeline before low-dword integer conversion. |
OnLeftGlobal | bool OnLeft(point, point)Description pendingDescription pending. |
Squad::SetCmdSquad | void Squad::SetCmd(int, int, int, str, point)Resolves the squad reference and delegates a command operation with target point coordinates. |
GetGAIKAGlobal | GAIKA GetGAIKA(point)Obtains the GAIKA value associated with the point's coordinates in the AI map. Returns zero if that AI map is unavailable. |
Settlement::FindCatapultSpotSettlement | point Settlement::FindCatapultSpot(point)CKS adapter with unreconciled twenty-byte native input consumption that forwards an extra selector to class lookup and cached point selection. |
Settlement::BestGateSettlement | Gate Settlement::BestGate(point)BestGate selects the first Gate with a strictly smaller native position score plus signed field [field] divided by five. |
SettlementCountGlobal | int SettlementCount(point, int, str)SettlementCount counts class-matching settlements below a strict unsigned metric threshold. |
FindRuinsGlobal | Obj FindRuins(point, int, int)Scans settlement slots and returns the last randomly accepted matching ruins handle. |
AttackSetForTrainingGlobal | bool AttackSetForTraining(Obj, point, int)Selects a prioritized nearby training target and queues approach and engagement commands. |
ScrollToGlobal | void ScrollTo(point, int)Uses a persistent blocking frame to interpolate a projected viewport center and schedule retries. |
LSAGlobal | int LSA(point)Description pendingDescription pending. |
NearestStrongholdGlobal | Settlement NearestStronghold(point, int, int)Description pendingDescription pending. |
NearestStrongholdGlobal | Settlement NearestStronghold(point, int)Description pendingDescription pending. |
NearestStrongholdGlobal | Settlement NearestStronghold(point)NearestStronghold point overload selects the unfiltered BaseTownhall search. |
NearestSetGlobal | Settlement NearestSet(point, str, int, int)NearestSet four-argument overload forwards the class, decremented player and supplied relation mask. |
NearestSetGlobal | Settlement NearestSet(point, str, int)NearestSet three-argument overload forwards the class, decremented player and fixed mask one. |
NearestSetGlobal | Settlement NearestSet(point)NearestSet point overload searches the Building central-building class without player filtering. |
PrepareAiTransportShipGlobal | Ship PrepareAiTransportShip(int, int, int, str, point)PrepareAiTransportShip conditionally builds an eight-byte handle result. |
FindTeleportGlobal | Obj FindTeleport(int, point, point)Finds the shortest usable teleport connection between source and destination regions for a player. |
Squad::UseTeleportSquad | bool Squad::UseTeleport(Obj, int, str, point)Stores squad state/time and submits teleport plus point commands for live members. |
EvalGlobal | void Eval(int, point, int, int, int, int)Resolves three referenced output integers, delegates a spatial query, and writes its three results. |
IsProtectedGlobal | bool IsProtected(int, point, str)IsProtected clamps coordinates and normalizes a local query flag. |
UserNotificationGlobal | void UserNotification(str, str, point, int)Triggers a notification from two script strings and a point when the requested player matches the active player. |
Coverage and limits
13 / 13 members with a published description.
These lists come from published signatures. “Accept” counts explicit parameters, excluding the method receiver; reference variants (&) are included. No inheritance hierarchy is asserted. Undocumented names, units and effects remain unresolved.