Imperivm Modding WikiCKS · FORMATS · GUIDESEspañol
CKS TYPECKS reference

point

Browse its members and the signatures that accept or return this type.

13 members54 return it98 accept it

Members

13

Expand a member to read its notes or open its full entry. Each overload keeps its own identity.

MemberSignature and description
x

Returns the horizontal coordinate of the point.

Open full entry →
point
int& point::x()

Returns the horizontal coordinate of the 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.

Open full entry →
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.

x

Returns the horizontal coordinate of the point.

Open full entry →
point
int point::x()

Returns the horizontal coordinate of the point.

y

Returns the vertical coordinate of the point.

Open full entry →
point
int point::y()

Returns the vertical coordinate of the point.

Set

Sets the horizontal and vertical coordinates and returns the updated point.

Open full entry →
point
point point::Set(int, int)

Sets the horizontal and vertical coordinates and returns the updated point.

SetLen

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.

The argument is the requested length. On the documented calculation path, each coordinate is multiplied by that value and divided with truncation toward zero. Products use 32-bit arithmetic. Behavior with a zero computed divisor, invalid references, or values that cause overflow is not fully documented.

Open full entry →
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.

Len

Returns the integer square root of the sum of the squared coordinates.

Open full entry →
point
int point::Len()

Returns the integer square root of the sum of the squared coordinates.

Rot

Rotates a referenced integer point through an integer angle using sine and cosine.

Open full entry →
point
void point::Rot(int)

Rotates a referenced integer point through an integer angle using sine and cosine.

InRect

Checks whether the point lies inside the rectangle, including its boundaries.

Open full entry →
point
bool point::InRect(rect)

Checks whether the point lies inside the rectangle, including its boundaries.

IntoRect

Limits the point's coordinates to the rectangle's boundaries.

Open full entry →
point
void point::IntoRect(rect)

Limits the point's coordinates to the rectangle's boundaries.

Dist

returns the integer square root of dx squared plus dy squared.

Open full entry →
point
int point::Dist(point)

returns the integer square root of dx squared plus dy squared.

GetGAIKA

Shared handler for GetGAIKA and point::GetGAIKA that resolves a point through the global AI map.

Open full entry →
point
GAIKA point::GetGAIKA()

Shared handler for GetGAIKA and point::GetGAIKA that resolves a point through the global AI map.

ClampToMap

point::ClampToMap clamps each coordinate to zero through its map dimension minus one when a global map exists.

Open full entry →
point
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
MemberSignature and description
PointGlobalpoint Point(int, int)

Creates a point from its horizontal coordinate x and vertical coordinate y, in that order.

point::Setpointpoint point::Set(int, int)

Sets the horizontal and vertical coordinates and returns the updated point.

+Globalpoint +(point, point)Description pending

Description pending.

-Globalpoint -(point, point)Description pending

Description pending.

*Globalpoint *(point, int)Description pending

Description pending.

/Globalpoint /(point, int)Description pending

Description pending.

rect::Centerrectpoint rect::Center()

Returns the integer center point of the rectangle.

GetMapSizeGlobalpoint GetMapSize()

GetMapSize pushes the two 32-bit bound differences plus one from the pointer stored at [field].

Obj::posObjpoint Obj::pos()

Returns the object's position as a point. An invalid object returns zero coordinates.

Obj::posRHObjpoint Obj::posRH()

Resolves an Obj handle and returns an eight-byte point from virtual slot [field].

Obj::GetDirObjpoint Obj::GetDir()

Returns two 32-bit components from the resolved Obj. If resolution fails, returns the default vector (0, 1).

Obj::ClipDestToMapObjpoint 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::GetAverageDirectionQuerypoint Query::GetAverageDirection()

Returns the average direction of the query's objects, or a zero point for an empty or invalid query.

Building::GetEnterPointBuildingpoint Building::GetEnterPoint(Unit)

calculates the entrance point coordinates of a building relative to an approaching unit.

Building::GetExitPointBuildingpoint Building::GetExitPoint(Obj, point)

Resolves an exit point from a Building, an Obj template category, and an incoming point.

Building::GetExitPointBuildingpoint Building::GetExitPoint(point, bool)

Resolves an exit point from a Building, an incoming point, and a boolean mode.

Building::GetPointBuildingpoint Building::GetPoint(int, int)Description pending

Description pending.

Building::GetExitVectorBuildingpoint Building::GetExitVector()

Building GetExitVector returns template dwords at [field] and [field], with (-1,-1) for a sentinel first dword.

GetCatapultAttackPointGlobalpoint GetCatapultAttackPoint(point)Description pending

Description pending.

Catapult::GetPointOnTargetCatapultpoint Catapult::GetPointOnTarget(Obj)Description pending

Description pending.

Catapult::CalcEscapeDirectionCatapultpoint Catapult::CalcEscapeDirection()Description pending

Description pending.

Unit::destUnitpoint 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::GetUnexploredPointUnitpoint Unit::GetUnexploredPoint(int)

Returns a random unexplored point near the unit, or the point (-1, -1) when it finds none.

Unit::PathDestFoundUnitpoint Unit::PathDestFound()

When Unit [field] exists and its virtual [field] returns nonzero, returns the point from path virtual [field]; otherwise returns (-1,-1).

Hero::GetFinalPartyOrientationHeropoint Hero::GetFinalPartyOrientation()

Returns the transformed stored orientation point for this function.

Building::GetEnterExitBuildingpoint Building::GetEnterExit()

Delegates to a random point lookup using point type 12. The meaning of that type is not documented here.

Building::GetWaterSourceBuildingpoint Building::GetWaterSource()

Delegates to a random point lookup using point type 13. The meaning of that type is not documented here.

Building::GetGoodsSourceBuildingpoint Building::GetGoodsSource()

Delegates to a random point lookup using point type 14. The meaning of that type is not documented here.

Building::GetFixSiteBuildingpoint Building::GetFixSite()

Delegates to a random point lookup using point type 15. The meaning of that type is not documented here.

Settlement::FindNearEnterExitSettlementpoint Settlement::FindNearEnterExit(point)

Searches settlement type12 points and selects the first strict minimum of a transformed integer distance metric.

ViewPosGlobalpoint ViewPos()

Converts the native viewport midpoint to a world point and pushes it on the CKS VM stack.

GetVecGlobalpoint GetVec(point, point, int)

Scales a wrapped integer point difference using signed division by an integer helper return.

RandomOffsetGlobalpoint RandomOffset(int)

RandomOffset calls virtual slot [field] twice on Game[field] with the pair (-r,r), then writes (second,first).

RandomPointInCircleGlobalpoint RandomPointInCircle(point, int)

Constructs a point from radial and angular samples and clamps it to map bounds.

AreaCenterGlobalpoint AreaCenter(str)

Returns area coordinates selected by its geometry mode field.

GetRandomPointInAreaGlobalpoint GetRandomPointInArea(str)

Returns a helper point or a fixed pair when area lookup fails.

Teleport::exit_vectorTeleportpoint Teleport::exit_vector()

Teleport exit_vector copies two dwords.

Ship::FindPointToStayShippoint 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::GetTransPtShippoint Ship::GetTransPt()

Returns two 32-bit components from the resolved Ship as a point.

Flying::PickFlyingPointFlyingpoint 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::PickLandingPointFlyingpoint Flying::PickLandingPoint(int)Description pending

Description pending.

GetVecByDirGlobalpoint GetVecByDir(point, int)

Scales an input point vector to a requested integer magnitude.

GetDirByAngleGlobalpoint GetDirByAngle(int)

Handler for this function, point GetDirByAngle(int): returns cosine and sine of a degree angle scaled by 100.

Unit::dirUnitpoint Unit::dir()

Returns two 32-bit components from the resolved Unit as a point.

Squad::posSquadpoint Squad::pos()

Resolves a squad leader and returns its point or (-1,-1).

GAIKA::CenterGAIKApoint GAIKA::Center()

GAIKA::Center copies dwords +8 and +12 from a resolved GAIKA record, returning a zero point if no record resolves.

GAIKA::GetDestPointGAIKApoint GAIKA::GetDestPoint(Unit)

Returns a stored destination or derives an approach point for selected building configurations.

Settlement::FindCatapultSpotSettlementpoint Settlement::FindCatapultSpot(point)

CKS adapter with unreconciled twenty-byte native input consumption that forwards an extra selector to class lookup and cached point selection.

GetGaikaCenterGlobalpoint GetGaikaCenter(int)

Returns the point fields of a record selected by the low 16 bits of the input.

GetSquadCenterGlobalpoint GetSquadCenter(int, int)

Averages resolved squad-member coordinates using unsigned division by the stored total count.

ViewSlotGlobalpoint ViewSlot()

Returns viewport midpoint coordinates divided by128 while discarding the terrain-conversion output.

Unit::BestMDPosUnitpoint 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.

MousePtmGlobalpoint MousePtm()

MousePtm pushes the dwords at receiver[field] and [field] from [[field]].

point::ClampToMappointpoint point::ClampToMap()

point::ClampToMap clamps each coordinate to zero through its map dimension minus one when a global map exists.

Accept this type

98
MemberSignature and description
point::Distpointint point::Dist(point)

returns the integer square root of dx squared plus dy squared.

+Globalpoint +(point, point)Description pending

Description pending.

-Globalpoint -(point, point)Description pending

Description pending.

*Globalpoint *(point, int)Description pending

Description pending.

/Globalpoint /(point, int)Description pending

Description pending.

DistGlobalint Dist(point, point)

returns the integer square root of dx squared plus dy squared.

=Globalvoid =(point&, point)Description pending

Description pending.

==Globalbool ==(point, point)Description pending

Description pending.

!=Globalbool !=(point, point)Description pending

Description pending.

Obj::AddCommandObjvoid Obj::AddCommand(bool, str, point)

Adds a named command with a point as its target.

Obj::SetCommandObjvoid Obj::SetCommand(str, point)

Creates and submits a named command for the object with a point as its target.

Obj::ExecDefaultCmdObjvoid Obj::ExecDefaultCmd(point, Obj, bool, bool)

Builds a one-receiver packet for default-command dispatch with point, target identifier and normalized flags.

Obj::ExecCmdObjvoid Obj::ExecCmd(str, point, Obj, bool)

Validates an object and named command, then dispatches it with script arguments.

Obj::DistToObjint Obj::DistTo(point)

Obj::DistTo computes distance from an Obj to a point and subtracts its template offset.

Obj::SetPosObjvoid Obj::SetPos(point)Description pending

Description pending.

Obj::SetPosSimpleObjvoid Obj::SetPosSimple(point)

Clamps the supplied point and invokes virtual placement with two true flags.

Obj::FaceObjvoid Obj::Face(point)

Initializes an object command context, sets its facing point and conditionally invokes its command-update virtual method.

Obj::PlayAnimObjvoid Obj::PlayAnim(int, point)

Requests a script-object animation and returns the VM suspension code.

Obj::StartAnimObjvoid Obj::StartAnim(int, point)

Prepares and requests an animation with an optional target point.

Obj::StartDelayedAnimObjvoid Obj::StartDelayedAnim(int, point, int)

Normalizes an equal-current point and forwards a decremented animation identifier with a final integer.

Obj::DropItemObjbool Obj::DropItem(Item, point)

Requests that a specified receiver item be dropped at a point while returning false.

Obj::ClipDestToMapObjpoint 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].

PlaceGlobalObj Place(str, point, int)

Creates an object of the named class at a map position for the specified player, when placement is possible.

ObjsInCircleGlobalQuery ObjsInCircle(point, int, str)

Returns a class-filtered spatial query centered on a point with a supplied radius.

Query::AddDefCmdQueryvoid 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::AddCommandQueryvoid Query::AddCommand(bool, str, point)

Dispatches factory mode one with the unchanged point pair for each live Query member and installs nonnull results.

Query::AddCommandOffsetQueryvoid 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::SetCommandQueryvoid Query::SetCommand(str, point)

Creates and installs the requested point command on each valid object selected by a Query.

Query::SetCommandOffsetQueryvoid 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).

NearestObjGlobalObj NearestObj(Query, point)Description pending

Description pending.

Query::NearestObjQueryObj Query::NearestObj(point)Description pending

Description pending.

Query::FaceQueryvoid Query::Face(point)

Applies a face-point command to each live member of a query.

EnemyInRangeGlobalbool EnemyInRange(point, int, Obj)

Builds a wrapped bounding rectangle and returns the spatial callback accumulator as a boolean.

Building::GetExitPointBuildingpoint Building::GetExitPoint(Obj, point)

Resolves an exit point from a Building, an Obj template category, and an incoming point.

Building::GetExitPointBuildingpoint Building::GetExitPoint(point, bool)

Resolves an exit point from a Building, an incoming point, and a boolean mode.

GetCatapultAttackPointGlobalpoint GetCatapultAttackPoint(point)Description pending

Description pending.

Catapult::RotateToCatapultvoid Catapult::RotateTo(point)Description pending

Description pending.

Catapult::AttackCatapultvoid Catapult::Attack(point)Description pending

Description pending.

Catapult::InRangeCatapultbool Catapult::InRange(point)Description pending

Description pending.

Unit::GotoUnitbool 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::GotoEnterUnitbool 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::GotoStraightUnitvoid 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::ExitHolderUnitvoid 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::BestTargetInRangeUnitObj Unit::BestTargetInRange(point, int)

Forwards explicit point coordinates and integer radius to the common target-search helper.

Unit::PathToUnitint 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::FormSetupAndMoveToHerovoid 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::SetFinalPartyOrientationHerovoid Hero::SetFinalPartyOrientation(point)

Stores the transformed orientation request point for this function.

Settlement::FindNearEnterExitSettlementpoint Settlement::FindNearEnterExit(point)

Searches settlement type12 points and selects the first strict minimum of a transformed integer distance metric.

ObjList::AddCommandObjListvoid 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::AddCommandOffsetObjListvoid ObjList::AddCommandOffset(bool, str, point)

Creates point-targeted commands for object-list members while preserving their offsets from the list center.

ObjList::ExecDefaultCmdObjListvoid 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::ExecCmdObjListvoid 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::SetCommandObjListvoid 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::SetCommandOffsetObjListvoid 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::FilterClosestObjListObjList ObjList::FilterClosest(point, int)

Creates an ObjList through a bounded distance-selection helper using a point and count.

ObjList::FaceObjListvoid ObjList::Face(point)

After popping the point and receiver list, the handler traverses member slots.

ViewGlobalvoid View(point, bool)

Pops a world point and lock boolean from the CKS VM stack and forwards them to the native camera-centering helper.

ExploreCircleGlobalvoid ExploreCircle(int, point, int)

Validates a player index and delegates a center and radius to a map exploration helper.

GetVecGlobalpoint GetVec(point, point, int)

Scales a wrapped integer point difference using signed division by an integer helper return.

IsPassableGlobalbool IsPassable(point)

Returns an inverse map bitmap bit after signed bounds checks.

IsPassable3x3Globalbool IsPassable3x3(point)

Tests a point and its eight surrounding offsets through a map passability bitmap helper.

IsExploredGlobalbool IsExplored(point, int)

Forwards a point and decremented player value to the exploration receiver.

RandomPointInCircleGlobalpoint RandomPointInCircle(point, int)

Constructs a point from radial and angular samples and clamps it to map bounds.

RevealHiddenEnemyUnitsGlobalvoid RevealHiddenEnemyUnits(point, int, int)Description pending

Description pending.

AreaDistToGlobalint AreaDistTo(point, str)

Computes a nonnegative area distance value after name resolution.

_AdvPlaceAreaCircGlobalvoid _AdvPlaceAreaCirc(str, point, int, str, str)

Spawns and configures a circular adventure area from script arguments.

CreateFeedbackGlobalvoid CreateFeedback(str, point)

Constructs named feedback at a supplied point and initializes its scheduling field from the current game field.

CreateFeedbackGlobalvoid CreateFeedback(str, point, int)

Constructs named feedback at a supplied point and initializes its scheduling field with the integer offset.

Ship::ShowBuildAnimationShipvoid 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.

IsPointInWaterGlobalbool IsPointInWater(point)

Evaluates whether a given map coordinate corresponds to a water terrain tile by querying the global map terrain grid.

Item::UseItemvoid Item::Use(point)

Clamps a point to signed map bounds and forwards it to the positional use helper.

Flying::PlayAnimFlyingvoid Flying::PlayAnim(int, point, int)

Validates and starts a Flying animation, then suspends the VM.

Flying::AdjustFlyDirFlyingvoid Flying::AdjustFlyDir(point&)

Conditionally transforms a referenced point outside an inset rectangle using object vector fields and quadrant rotations.

GetTerrainHeightGlobalint GetTerrainHeight(point)

Clamps a world point to map bounds and samples terrain height there.

GetVecByDirGlobalpoint GetVecByDir(point, int)

Scales an input point vector to a requested integer magnitude.

GetAngleByDirGlobalint GetAngleByDir(point)

GetAngleByDir forms a wrapped unsigned squared length and applies a finite-path asin/quadrant pipeline before low-dword integer conversion.

OnLeftGlobalbool OnLeft(point, point)Description pending

Description pending.

Squad::SetCmdSquadvoid Squad::SetCmd(int, int, int, str, point)

Resolves the squad reference and delegates a command operation with target point coordinates.

GetGAIKAGlobalGAIKA 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::FindCatapultSpotSettlementpoint 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::BestGateSettlementGate Settlement::BestGate(point)

BestGate selects the first Gate with a strictly smaller native position score plus signed field [field] divided by five.

SettlementCountGlobalint SettlementCount(point, int, str)

SettlementCount counts class-matching settlements below a strict unsigned metric threshold.

FindRuinsGlobalObj FindRuins(point, int, int)

Scans settlement slots and returns the last randomly accepted matching ruins handle.

AttackSetForTrainingGlobalbool AttackSetForTraining(Obj, point, int)

Selects a prioritized nearby training target and queues approach and engagement commands.

ScrollToGlobalvoid ScrollTo(point, int)

Uses a persistent blocking frame to interpolate a projected viewport center and schedule retries.

LSAGlobalint LSA(point)Description pending

Description pending.

NearestStrongholdGlobalSettlement NearestStronghold(point, int, int)Description pending

Description pending.

NearestStrongholdGlobalSettlement NearestStronghold(point, int)Description pending

Description pending.

NearestStrongholdGlobalSettlement NearestStronghold(point)

NearestStronghold point overload selects the unfiltered BaseTownhall search.

NearestSetGlobalSettlement NearestSet(point, str, int, int)

NearestSet four-argument overload forwards the class, decremented player and supplied relation mask.

NearestSetGlobalSettlement NearestSet(point, str, int)

NearestSet three-argument overload forwards the class, decremented player and fixed mask one.

NearestSetGlobalSettlement NearestSet(point)

NearestSet point overload searches the Building central-building class without player filtering.

PrepareAiTransportShipGlobalShip PrepareAiTransportShip(int, int, int, str, point)

PrepareAiTransportShip conditionally builds an eight-byte handle result.

FindTeleportGlobalObj FindTeleport(int, point, point)

Finds the shortest usable teleport connection between source and destination regions for a player.

Squad::UseTeleportSquadbool Squad::UseTeleport(Obj, int, str, point)

Stores squad state/time and submits teleport plus point commands for live members.

EvalGlobalvoid Eval(int, point, int, int, int, int)

Resolves three referenced output integers, delegates a spatial query, and writes its three results.

IsProtectedGlobalbool IsProtected(int, point, str)

IsProtected clamps coordinates and normalizes a local query flag.

UserNotificationGlobalvoid 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.