Panorama API — Interfaces & Classes

Global Singletons

Name	Type	Description
`GameEvents`	`PanoramaEvents`
`GameUI`	`PanoramaUI`
`CustomNetTables`	`PanoramaNetTables`
`LocalInventory`	`PanoramaLocalInventory`
`EventData`	`PanoramaEventData`
`Particles`	`ParticlesAPI`
`Buffs`	`BuffsAPI`
`Players`	`PlayersAPI`
`Entities`	`EntitiesAPI`
`Abilities`	`AbilitiesAPI`
`Items`	`ItemsAPI`
`Game`	`GameAPI`
`SteamUGC`	`SteamUGCAPI`
`SteamFriends`	`SteamFriendsAPI`
`SteamUtils`	`SteamUtilsAPI`
`VRUtils`	`VRUtilsAPI`
`panorama`	`DollarStatic`

DOTAHeroModelOverlay

Native name: DOTAHeroModelOverlay

DOTAPlay

Native name: DOTAPlay

TabButton

Native name: TabButton

CustomUIElement

Native name: CustomUIElement

Global

Global VScripts functions

Methods

Method	Return Type	Native Name
`startAnimating()`	`Unit = externalSource()`	`StartAnimating`
`stopAnimating()`	`Unit = externalSource()`	`StopAnimating`
`setMovie(source: String)`	`Unit = externalSource()`	`SetMovie`
`setControls(controls: MovieControls)`	`Unit = externalSource()`	`SetControls`
`setTitle(title: String)`	`Unit = externalSource()`	`SetTitle`
`play()`	`Unit = externalSource()`	`Play`
`pause()`	`Unit = externalSource()`	`Pause`
`stop()`	`Unit = externalSource()`	`Stop`
`setRepeat(repeat: Boolean)`	`Unit = externalSource()`	`SetRepeat`
`setPlaybackVolume(volume: Float)`	`Unit = externalSource()`	`SetPlaybackVolume`
`getPanoramaSurfacePanel()`	`Panel? = null`	`GetPanoramaSurfacePanel`
`setScenePanelToLocalHero(heroId: Any)`	`Boolean = externalSource()`	`SetScenePanelToLocalHero`
`setPostProcessFade(value: Float)`	`Unit = externalSource()`	`SetPostProcessFade`
`setCustomPostProcessMaterial(material: String)`	`Unit = externalSource()`	`SetCustomPostProcessMaterial`
`reloadScene()`	`Unit = externalSource()`	`ReloadScene`
`clearScene(unknown1: Boolean)`	`Unit = externalSource()`	`ClearScene`
`startParticles()`	`Unit = externalSource()`	`StartParticles`
`stopParticlesImmediately(b: Boolean)`	`Unit = externalSource()`	`StopParticlesImmediately`
`stopParticlesWithEndcaps()`	`Unit = externalSource()`	`StopParticlesWithEndcaps`
`setItemByDefinition(itemDef: Int)`	`Unit = externalSource()`	`SetItemByDefinition`
`setAccountID(accountid: Int)`	`Unit = externalSource()`	`SetAccountID`
`setDirection(value: Any)`	`Unit = externalSource()`	`SetDirection`
`setRequiresSelection(value: Boolean)`	`Unit = externalSource()`	`SetRequiresSelection`
`setShowDefaultValue(value: Boolean)`	`Unit = externalSource()`	`SetShowDefaultValue`
`setValueNoEvents(value: Float)`	`Unit = externalSource()`	`SetValueNoEvents`
`setSelectedChild(selected: Panel)`	`Unit = externalSource()`	`SetSelectedChild`
`setURL(url: String)`	`Unit = externalSource()`	`SetURL`
`setIgnoreCursor(value: Boolean)`	`Unit = externalSource()`	`SetIgnoreCursor`
`runJavascript(js: String)`	`Unit = externalSource()`	`RunJavascript`

CustomGameEventDeclarations

PanoramaEvents

Native name: CDOTA_PanoramaScript_GameEvents

Methods

Method	Return Type	Native Name
`unsubscribe(callbackHandle: GameEventListenerID)`	`Unit`	`Unsubscribe`
`sendCustomGameEventToServer(eventName: String, eventData: Any,)`	`Unit`	`SendCustomGameEventToServer`
`sendCustomGameEventToAllClients(eventName: String, eventData: Any,)`	`Unit`	`SendCustomGameEventToAllClients`
`sendCustomGameEventToClient(eventName: String, playerIndex: PlayerID, eventData: Any,)`	`Unit`	`SendCustomGameEventToClient`
`sendEventClientSide(eventName: String, eventData: Any,)`	`Unit`	`SendEventClientSide`

CustomUIConfig

PanoramaUI

Native name: CDOTA_PanoramaScript_GameUI

Methods

Method	Return Type	Native Name	Description
`setDefaultUIEnabled(elementType: Int, visible: Boolean,)`	`Unit`	`SetDefaultUIEnabled`	Control whether the default UI is enabled
`customUIConfig()`	`CustomUIConfig`	`CustomUIConfig`	Get the current UI configuration
`pingMinimapAtLocation(vec3: String)`	`Unit`	`PingMinimapAtLocation`	Create a minimap ping at the given location
`getCursorPosition()`	`List<Int>`	`GetCursorPosition`	Get the current mouse position.
`findScreenEntities(screenPos: List<Int>)`	`List<ScreenEntity>`	`FindScreenEntities`	Return the entity index of the entity under the given screen position.
`getScreenWorldPosition(screenPos: List<Int>)`	`List<Float>?`	`GetScreenWorldPosition`	Get the world position of the screen position, or null if the cursor is out of the world.
`wasMousePressed(buttonNum: Int)`	`Boolean`	`WasMousePressed`	Install a mouse input filter
`wasMouseDoublePressed(buttonNum: Int)`	`Boolean`	`WasMouseDoublePressed`	Install a mouse input filter
`isMouseDown(buttonNum: Int)`	`Boolean`	`IsMouseDown`	Install a mouse input filter
`isShiftDown()`	`Boolean`	`IsShiftDown`	Is the shift button pressed?
`isAltDown()`	`Boolean`	`IsAltDown`	Is the alt button pressed?
`isControlDown()`	`Boolean`	`IsControlDown`	Is the control button pressed?
`getClickBehaviors()`	`Int`	`GetClickBehaviors`	Get the current UI click interaction mode.
`selectUnit(entityIndex: EntityIndex, addToGroup: Boolean,)`	`Unit`	`SelectUnit`	Select a unit, adding it to the group or replacing the current selection.
`getCameraLookAtPosition()`	`List<Float>`	`GetCameraLookAtPosition`	Get the current look at position.
`getCameraPosition()`	`List<Float>`	`GetCameraPosition`	Get the current camera position.
`getCameraLookAtPositionHeightOffset()`	`Float`	`GetCameraLookAtPositionHeightOffset`	Get the current look at position height offset.
`setCameraPitchMin(pitchMin: Float)`	`Unit`	`SetCameraPitchMin`	Set the minimum camera pitch angle.
`setCameraPitchMax(pitchMax: Float)`	`Unit`	`SetCameraPitchMax`	Set the maximum camera pitch angle.
`setCameraYaw(cameraYaw: Float)`	`Unit`	`SetCameraYaw`
`getCameraYaw()`	`Float`	`GetCameraYaw`	Get the camera's yaw.
`setCameraLookAtPositionHeightOffset(cameraLookAtHeightOffset: Float)`	`Unit`	`SetCameraLookAtPositionHeightOffset`
`setCameraPositionFromLateralLookAtPosition(x: Float, y: Float,)`	`Unit`	`SetCameraPositionFromLateralLookAtPosition`	Set the camera from a lateral position.
`setCameraTerrainAdjustmentEnabled(enabled: Boolean)`	`Unit`	`SetCameraTerrainAdjustmentEnabled`	Set whether the camera should automatically adjust to average terrain height.
`setCameraDistance(distance: Float)`	`Unit`	`SetCameraDistance`	Set the camera distance from the look at point.
`setRenderBottomInsetOverride(inset: Int)`	`Unit`	`SetRenderBottomInsetOverride`	Set the gap between the bottom of the screen and the game rendering viewport. (Value expressed as pixels in a normalized 1024x768 viewport.)
`setRenderTopInsetOverride(inset: Int)`	`Unit`	`SetRenderTopInsetOverride`	Set the gap between the top of the screen and the game rendering viewport. (Value expressed as pixels in a normalized 1024x768 viewport.)
`setCameraTarget(targetEntIndex: EntityIndex)`	`Unit`	`SetCameraTarget`	Set the camera target for the local player, or -1 to clear.
`setCameraTargetPosition(vec3: List<Float>, lerp: Float,)`	`Unit`	`SetCameraTargetPosition`	Set the camera target as position for the local player over specified lerp.
`moveCameraToEntity(targetEntIndex: EntityIndex)`	`Unit`	`MoveCameraToEntity`	Moves the camera to an entity, but doesn't lock the camera on that entity.
`worldToScreenXYClamped(vec3: List<Float>)`	`List<Int>`	`WorldToScreenXYClamped`	Converts the specified x,y,z world co-ordinate into an x,y screen coordinate. Will clamp position to always be in front of camera. Position returned as 0->1.0
`getPlayerScoreboardScore(scoreboardName: String)`	`Int`	`GetPlayerScoreboardScore`	Get the current players scoreboard score for the specified zone.
`sendCustomHUDError(errorText: String, errorSound: String,)`	`Unit`	`SendCustomHUDError`	Send a custom client side error message with passed string and soundevent.
`replaceDOTAAbilitySpecialValues(abilityName: String, text: String,)`	`String`	`ReplaceDOTAAbilitySpecialValues`	Given a passed ability, replace the special value variables in the passed localized text.
`getUnitLocToken(name: String)`	`String`	`GetUnitLocToken`	Returns the localization token to use for a particular unit, given the unit's name
`getUnitNameLocalized(name: String)`	`String`	`GetUnitNameLocalized`	Get the localized version of a unit's name
`constructNumberString(n: Int)`	`String`	`ConstructNumberString`	Creates a localized version of the number
`areTipsAvailable()`	`Boolean`	`AreTipsAvailable`	Query to check if Tips are available for the local player
`isPlayerTippable(playerID: PlayerID)`	`Boolean`	`IsPlayerTippable`	Query to see if the local player can tip a specific player
`tipPlayer(playerID: PlayerID)`	`Unit`	`TipPlayer`	Tip a player
`displayCustomContextualTip(tip: ContextualTip)`	`Unit`	`DisplayCustomContextualTip`	Display a custom contextual tip (wizard tip) with specific loc string and duration
`setupDOTATalentNameLabel(panel: Panel, abilityName: String,)`	`Unit`	`SetupDOTATalentNameLabel`	Set the text of a passed label for a DOTA Talent using ability values.
`isAbilityDOTATalent(abilityName: String)`	`Boolean`	`IsAbilityDOTATalent`	Returns true if the passed ability is a talent.
`savePersistentEventGameData(vararg args: Any)`	`Unit`	`SavePersistentEventGameData`	Save persistent data used by an event game
`loadPersistentEventGameData(vararg args: Any)`	`Unit`	`LoadPersistentEventGameData`	Load persistent data used by an event game
`enableAliMode(enable: Boolean, port: Number, offsetVal: Any, scale: Float,)`	`Unit`	`EnableAliMode`
`getHeroNameLocalizedForHeroID(heroID: HeroID)`	`String`	`GetHeroNameLocalizedForHeroID`	Get the localized version of a hero's name by id
`getHeroNameForHeroID(heroID: HeroID)`	`String`	`GetHeroNameForHeroID`	Get hero name by hero ID

ScreenEntity

Properties

Property	Type	Native Name	Description
`entityIndex`	`val EntityIndex`
`accurate`	`val Boolean`

ContextualTip

Properties

Property	Type	Native Name
`tipText`	`val String`	`tip_text`
`layoutPath`	`val String`	`layout_path`
`displayDuration`	`val Float`	`display_duration`

PanoramaNetTables

Native name: CDOTA_PanoramaScript_CustomNetTables

Methods

Method	Return Type	Native Name
`getTableValue(tableName: String, keyName: String,)`	`Any?`	`GetTableValue`
`getAllTableValues(tableName: String)`	`Any?`	`GetAllTableValues`
`unsubscribeNetTableListener(callbackHandle: NetTableListenerID)`	`Unit`	`UnsubscribeNetTableListener`

PanoramaLocalInventory

Native name: CDOTA_PanoramaScript_LocalInventory

Methods

Method	Return Type	Native Name	Description
`hasItemByDefinition(defIndex: Int)`	`Boolean`	`HasItemByDefinition`	Does the player have an inventory item of a given item definition index?

PanoramaEventData

Native name: CDOTA_PanoramaScript_EventData

Methods

Method	Return Type	Native Name	Description
`getEventActionScore(eventID: Int, actionID: Int,)`	`Int`	`GetEventActionScore`	Get the score of an EventAction
`getPeriodicResourceUsed(periodicResourceID: Int)`	`Int`	`GetPeriodicResourceUsed`	Get a periodic resource value used
`getPeriodicResourceMax(periodicResourceID: Int)`	`Int`	`GetPeriodicResourceMax`	Get a periodic resource value max
`isFirstRunThisEvent()`	`Boolean`	`IsFirstRunThisEvent`	Is this the first time we've launched this season?

ParticlesAPI

Native name: CScriptBindingPR_Particles

Methods

Method	Return Type	Native Name
`createParticle(particleName: String, particleAttach: Int, owningEntity: EntityIndex,)`	`ParticleID`	`CreateParticle`
`releaseParticleIndex(particle: ParticleID)`	`Unit`	`ReleaseParticleIndex`
`destroyParticleEffect(particle: ParticleID, immediate: Boolean,)`	`Unit`	`DestroyParticleEffect`
`setParticleControl(particle: ParticleID, controlPoint: Int, value: List<Float>,)`	`Unit`	`SetParticleControl`
`setParticleControlForward(particle: ParticleID, controlPoint: Int, value: List<Float>,)`	`Unit`	`SetParticleControlForward`
`setParticleControlTransform(particle: ParticleID, controlPoint: Int, origin: List<Float>, angles: List<Float>,)`	`Unit`	`SetParticleControlTransform`
`setParticleControlTransformForward(particle: ParticleID, controlPoint: Int, origin: List<Float>, forward: List<Float>,)`	`Unit`	`SetParticleControlTransformForward`
`setParticleAlwaysSimulate(particle: ParticleID)`	`Unit`	`SetParticleAlwaysSimulate`
`setParticleControlEnt(particle: ParticleID, controlPoint: Int, entity: EntityIndex, particleAttach: Int, attachmentName: String, offset: List<Float>, unknown: Boolean,)`	`Unit`	`SetParticleControlEnt`

BuffsAPI

Native name: CScriptBindingPR_Buffs

Methods

Method	Return Type	Native Name	Description
`getName(entityIndex: EntityIndex, buffIndex: BuffID,)`	`String`	`GetName`
`getClass(entityIndex: EntityIndex, buffIndex: BuffID,)`	`String`	`GetClass`
`getTexture(entityIndex: EntityIndex, buffIndex: BuffID,)`	`String`	`GetTexture`
`getDuration(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Float`	`GetDuration`
`getDieTime(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Float`	`GetDieTime`
`getRemainingTime(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Float`	`GetRemainingTime`
`getElapsedTime(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Float`	`GetElapsedTime`
`getCreationTime(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Float`	`GetCreationTime`
`getStackCount(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Int`	`GetStackCount`
`isDebuff(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Boolean`	`IsDebuff`
`isHidden(entityIndex: EntityIndex, buffIndex: BuffID,)`	`Boolean`	`IsHidden`
`getCaster(entityIndex: EntityIndex, buffIndex: BuffID,)`	`EntityIndex`	`GetCaster`	Get the owner of the ability responsible for the modifier.
`getParent(entityIndex: EntityIndex, buffIndex: BuffID,)`	`EntityIndex`	`GetParent`	Get the unit the modifier is parented to.
`getAbility(entityIndex: EntityIndex, buffIndex: BuffID,)`	`AbilityEntityIndex`	`GetAbility`	Get the ability that generated the modifier.

PlayersAPI

Native name: CScriptBindingPR_Players

Methods

Method	Return Type	Native Name	Description
`getMaxPlayers()`	`Int`	`GetMaxPlayers`	Get the maximum number of players in the game.
`getMaxTeamPlayers()`	`Int`	`GetMaxTeamPlayers`	Get the maximum number of players on teams.
`getLocalPlayer()`	`PlayerID`	`GetLocalPlayer`	Get the local player ID.
`isValidPlayerID(playerID: PlayerID)`	`Boolean`	`IsValidPlayerID`	Is the nth player a valid player?
`getPlayerName(playerID: PlayerID)`	`String`	`GetPlayerName`	Return the name of a player.
`getPlayerHeroEntityIndex(playerID: PlayerID)`	`EntityIndex`	`GetPlayerHeroEntityIndex`	Get the entity index of the hero controlled by this player.
`getSelectedEntities(playerID: PlayerID)`	`List<EntityIndex>`	`GetSelectedEntities`	Get the entities this player has selected.
`getQueryUnit(playerID: PlayerID)`	`EntityIndex`	`GetQueryUnit`	Get the entities this player is querying.
`getLocalPlayerPortraitUnit()`	`EntityIndex`	`GetLocalPlayerPortraitUnit`	Get local player current portrait unit. (ie. Player's hero or primary selected unit.)
`canPlayerBuyback(playerID: PlayerID)`	`Boolean`	`CanPlayerBuyback`	Can the player buy back?
`hasCustomGameTicketForPlayerID(playerID: PlayerID)`	`Boolean`	`HasCustomGameTicketForPlayerID`	Does this player have a custom game ticket?
`getAssists(playerID: PlayerID)`	`Int`	`GetAssists`	The number of assists credited to a player.
`getDeaths(playerID: PlayerID)`	`Int`	`GetDeaths`	The number of deaths a player has suffered.
`getDenies(playerID: PlayerID)`	`Int`	`GetDenies`	The number of denies credited to a player.
`getGold(playerID: PlayerID)`	`Int`	`GetGold`	The amount of gold a player has.
`getKills(playerID: PlayerID)`	`Int`	`GetKills`	The number of kills credited to a player.
`getLastHits(playerID: PlayerID)`	`Int`	`GetLastHits`	The number of last hits credited to a player.
`getLevel(playerID: PlayerID)`	`Int`	`GetLevel`	The current level of a player.
`getReliableGold(playerID: PlayerID)`	`Int`	`GetReliableGold`	Total reliable gold for this player.
`getTotalEarnedGold(playerID: PlayerID)`	`Int`	`GetTotalEarnedGold`	Total gold earned in this game by this player.
`getTotalEarnedXP(playerID: PlayerID)`	`Int`	`GetTotalEarnedXP`	Total xp earned in this game by this player.
`getUnreliableGold(playerID: PlayerID)`	`Int`	`GetUnreliableGold`	Total unreliable gold for this player.
`getTeam(playerID: PlayerID)`	`DOTATeam`	`GetTeam`	Get the team this player is on.
`getSelectedHeroID(playerID: PlayerID)`	`HeroID`	`GetSelectedHeroID`	Get the player's selected hero id.
`getGoldPerMin(playerID: PlayerID)`	`Int`	`GetGoldPerMin`	Average gold earned per minute for this player.
`getXPPerMin(playerID: PlayerID)`	`Int`	`GetXPPerMin`	Average xp earned per minute for this player.
`getPlayerSelectedHero(playerID: PlayerID)`	`String`	`GetPlayerSelectedHero`	Return the name of the hero a player is controlling.
`getPlayerColor(playerID: PlayerID)`	`Int`	`GetPlayerColor`	Get the player color.
`isSpectator(playerID: PlayerID)`	`Boolean`	`IsSpectator`	Is this player a spectator.
`playerPortraitClicked(clickedPlayerID: PlayerID, holdingCtrl: Boolean, holdingAlt: Boolean,)`	`Unit`	`PlayerPortraitClicked`	.
`playerPortraitDoubleClicked(clickedPlayerID: PlayerID, holdingCtrl: Boolean, holdingAlt: Boolean,)`	`Unit`	`PlayerPortraitDoubleClicked`	.
`isLocalPlayerLiveSpectating()`	`Boolean`	`IsLocalPlayerLiveSpectating`	Is the local player live spectating?
`isLocalPlayerInPerspectiveCamera()`	`Boolean`	`IsLocalPlayerInPerspectiveCamera`	If local player is in perspective camera, returns true. Else, false
`getPerspectivePlayerEntityIndex()`	`EntityIndex`	`GetPerspectivePlayerEntityIndex`	If player is in perspective mode, returns the followed players entity index. Else, -1.
`getPerspectivePlayerId()`	`PlayerID`	`GetPerspectivePlayerId`	If player is in perspective mode, returns the followed players id. Else, -1.
`getClaimedDenies(playerID: PlayerID)`	`Int`	`GetClaimedDenies`
`getClaimedMisses(playerID: PlayerID)`	`Int`	`GetClaimedMisses`
`getLastBuybackTime(playerID: PlayerID)`	`Number`	`GetLastBuybackTime`
`getLastHitMultikill(playerID: PlayerID)`	`Number`	`GetLastHitMultikill`
`getLastHitStreak(playerID: PlayerID)`	`Int`	`GetLastHitStreak`
`getMisses(playerID: PlayerID)`	`Int`	`GetMisses`
`getNearbyCreepDeaths(playerID: PlayerID)`	`Int`	`GetNearbyCreepDeaths`
`getRespawnSeconds(playerID: PlayerID)`	`Number`	`GetRespawnSeconds`
`getStreak(playerID: PlayerID)`	`Int`	`GetStreak`
`buffClicked(entity: EntityIndex, buffSerial: Number, alert: Boolean,)`	`Unit`	`BuffClicked`	.

EntitiesAPI

Native name: CScriptBindingPR_Entities

Methods

Method	Return Type	Native Name	Description
`getAbsOrigin(entityIndex: EntityIndex)`	`List<Float>`	`GetAbsOrigin`	Get the world origin of the entity.
`getAbsAngles(entityIndex: EntityIndex)`	`List<Float>`	`GetAbsAngles`	Get the world angles of the entity.
`getForward(entityIndex: EntityIndex)`	`List<Float>`	`GetForward`	Get the forward vector of the entity.
`getRight(entityIndex: EntityIndex)`	`List<Float>`	`GetRight`	Get the right vector of the entity. WARNING: This produces a left-handed coordinate system. Use GetLeft instead!
`getUp(entityIndex: EntityIndex)`	`List<Float>`	`GetUp`	Get the up vector of the entity.
`getAllBuildingEntities()`	`List<EntityIndex>`	`GetAllBuildingEntities`	Get all the building entities.
`getAllHeroEntities()`	`List<EntityIndex>`	`GetAllHeroEntities`	Get all the hero entities.
`getAllEntitiesByName(name: String)`	`List<EntityIndex>`	`GetAllEntitiesByName`	Get all the entities with a given name.
`getAllEntitiesByClassname(name: String)`	`List<EntityIndex>`	`GetAllEntitiesByClassname`	Get all the entities with a given classname.
`getAllCreatureEntities()`	`List<EntityIndex>`	`GetAllCreatureEntities`	Get all the creature entities.
`getAllEntities()`	`List<EntityIndex>`	`GetAllEntities`	Get all the entities.
`getPlayerOwnerID(entityIndex: EntityIndex)`	`PlayerID`	`GetPlayerOwnerID`
`isValidEntity(entityIndex: EntityIndex)`	`Boolean`	`IsValidEntity`	Is this a valid entity index?
`isItemPhysical(entityIndex: EntityIndex)`	`Boolean`	`IsItemPhysical`	Is this entity an item container in the world?
`getContainedItem(entityIndex: EntityIndex)`	`ItemEntityIndex`	`GetContainedItem`	Get the item contained in this physical item container.
`setMinimapIcon(entityIndex: EntityIndex, minimapIcon: String,)`	`Unit`	`SetMinimapIcon`	Set the minimap icon on this client.
`getLeft(entityIndex: EntityIndex)`	`Any`	`GetLeft`	Get the left vector of the entity.
`canBeDominated(entityIndex: EntityIndex)`	`Boolean`	`CanBeDominated`
`hasAttackCapability(entityIndex: EntityIndex)`	`Boolean`	`HasAttackCapability`
`hasCastableAbilities(entityIndex: EntityIndex)`	`Boolean`	`HasCastableAbilities`
`hasFlyingVision(entityIndex: EntityIndex)`	`Boolean`	`HasFlyingVision`
`hasFlyMovementCapability(entityIndex: EntityIndex)`	`Boolean`	`HasFlyMovementCapability`
`hasGroundMovementCapability(entityIndex: EntityIndex)`	`Boolean`	`HasGroundMovementCapability`
`hasMovementCapability(entityIndex: EntityIndex)`	`Boolean`	`HasMovementCapability`
`hasScepter(entityIndex: EntityIndex)`	`Boolean`	`HasScepter`
`hasUpgradeableAbilities(entityIndex: EntityIndex)`	`Boolean`	`HasUpgradeableAbilities`
`hasUpgradeableAbilitiesThatArentMaxed(entityIndex: EntityIndex)`	`Boolean`	`HasUpgradeableAbilitiesThatArentMaxed`
`isAlive(entityIndex: EntityIndex)`	`Boolean`	`IsAlive`
`isAncient(entityIndex: EntityIndex)`	`Boolean`	`IsAncient`
`isAttackImmune(entityIndex: EntityIndex)`	`Boolean`	`IsAttackImmune`
`isBarracks(entityIndex: EntityIndex)`	`Boolean`	`IsBarracks`
`isBlind(entityIndex: EntityIndex)`	`Boolean`	`IsBlind`
`isBoss(entityIndex: EntityIndex)`	`Boolean`	`IsBoss`
`isBossCreature(entityIndex: EntityIndex)`	`Boolean`	`IsBossCreature`
`isRoshan(entityIndex: EntityIndex)`	`Boolean`	`IsRoshan`
`isBuilding(entityIndex: EntityIndex)`	`Boolean`	`IsBuilding`
`isCommandRestricted(entityIndex: EntityIndex)`	`Boolean`	`IsCommandRestricted`
`isConsideredHero(entityIndex: EntityIndex)`	`Boolean`	`IsConsideredHero`
`isControllableByAnyPlayer(entityIndex: EntityIndex)`	`Boolean`	`IsControllableByAnyPlayer`
`isCourier(entityIndex: EntityIndex)`	`Boolean`	`IsCourier`
`isCreature(entityIndex: EntityIndex)`	`Boolean`	`IsCreature`
`isCreep(entityIndex: EntityIndex)`	`Boolean`	`IsCreep`
`isCreepHero(entityIndex: EntityIndex)`	`Boolean`	`IsCreepHero`
`isDeniable(entityIndex: EntityIndex)`	`Boolean`	`IsDeniable`
`isDominated(entityIndex: EntityIndex)`	`Boolean`	`IsDominated`
`isEnemy(entityIndex: EntityIndex)`	`Boolean`	`IsEnemy`
`isEvadeDisabled(entityIndex: EntityIndex)`	`Boolean`	`IsEvadeDisabled`
`isFort(entityIndex: EntityIndex)`	`Boolean`	`IsFort`
`isFrozen(entityIndex: EntityIndex)`	`Boolean`	`IsFrozen`
`isGeneratedByEconItem(entityIndex: EntityIndex)`	`Boolean`	`IsGeneratedByEconItem`
`isHallofFame(entityIndex: EntityIndex)`	`Boolean`	`IsHallofFame`
`isDisarmed(entityIndex: EntityIndex)`	`Boolean`	`IsDisarmed`
`isHero(entityIndex: EntityIndex)`	`Boolean`	`IsHero`
`isHexed(entityIndex: EntityIndex)`	`Boolean`	`IsHexed`
`isIllusion(entityIndex: EntityIndex)`	`Boolean`	`IsIllusion`
`isInRangeOfFountain(entityIndex: EntityIndex)`	`Boolean`	`IsInRangeOfFountain`
`isInventoryEnabled(entityIndex: EntityIndex)`	`Boolean`	`IsInventoryEnabled`
`isInvisible(entityIndex: EntityIndex)`	`Boolean`	`IsInvisible`
`isInvulnerable(entityIndex: EntityIndex)`	`Boolean`	`IsInvulnerable`
`isLaneCreep(entityIndex: EntityIndex)`	`Boolean`	`IsLaneCreep`
`isLowAttackPriority(entityIndex: EntityIndex)`	`Boolean`	`IsLowAttackPriority`
`isMagicImmune(entityIndex: EntityIndex)`	`Boolean`	`IsMagicImmune`
`isMuted(entityIndex: EntityIndex)`	`Boolean`	`IsMuted`
`isNeutralUnitType(entityIndex: EntityIndex)`	`Boolean`	`IsNeutralUnitType`
`isNightmared(entityIndex: EntityIndex)`	`Boolean`	`IsNightmared`
`isOther(entityIndex: EntityIndex)`	`Boolean`	`IsOther`
`isOutOfGame(entityIndex: EntityIndex)`	`Boolean`	`IsOutOfGame`
`isOwnedByAnyPlayer(entityIndex: EntityIndex)`	`Boolean`	`IsOwnedByAnyPlayer`
`isPhantom(entityIndex: EntityIndex)`	`Boolean`	`IsPhantom`
`isRangedAttacker(entityIndex: EntityIndex)`	`Boolean`	`IsRangedAttacker`
`isRealHero(entityIndex: EntityIndex)`	`Boolean`	`IsRealHero`
`isRooted(entityIndex: EntityIndex)`	`Boolean`	`IsRooted`
`isSelectable(entityIndex: EntityIndex)`	`Boolean`	`IsSelectable`
`isShop(entityIndex: EntityIndex)`	`Boolean`	`IsShop`
`isSilenced(entityIndex: EntityIndex)`	`Boolean`	`IsSilenced`
`isSpeciallyDeniable(entityIndex: EntityIndex)`	`Boolean`	`IsSpeciallyDeniable`
`isSpeciallyUndeniable(entityIndex: EntityIndex)`	`Boolean`	`IsSpeciallyUndeniable`
`isStunned(entityIndex: EntityIndex)`	`Boolean`	`IsStunned`
`isSummoned(entityIndex: EntityIndex)`	`Boolean`	`IsSummoned`
`isTower(entityIndex: EntityIndex)`	`Boolean`	`IsTower`
`isUnselectable(entityIndex: EntityIndex)`	`Boolean`	`IsUnselectable`
`isWard(entityIndex: EntityIndex)`	`Boolean`	`IsWard`
`isZombie(entityIndex: EntityIndex)`	`Boolean`	`IsZombie`
`noHealthBar(entityIndex: EntityIndex)`	`Boolean`	`NoHealthBar`
`noTeamMoveTo(entityIndex: EntityIndex)`	`Boolean`	`NoTeamMoveTo`
`noTeamSelect(entityIndex: EntityIndex)`	`Boolean`	`NoTeamSelect`
`notOnMinimap(entityIndex: EntityIndex)`	`Boolean`	`NotOnMinimap`
`notOnMinimapForEnemies(entityIndex: EntityIndex)`	`Boolean`	`NotOnMinimapForEnemies`
`noUnitCollision(entityIndex: EntityIndex)`	`Boolean`	`NoUnitCollision`
`providesVision(entityIndex: EntityIndex)`	`Boolean`	`ProvidesVision`
`usesHeroAbilityNumbers(entityIndex: EntityIndex)`	`Boolean`	`UsesHeroAbilityNumbers`
`isMoving(entityIndex: EntityIndex)`	`Boolean`	`IsMoving`
`getAbilityCount(entityIndex: EntityIndex)`	`Int`	`GetAbilityCount`
`getCurrentVisionRange(entityIndex: EntityIndex)`	`Number`	`GetCurrentVisionRange`
`getDamageBonus(entityIndex: EntityIndex)`	`Number`	`GetDamageBonus`
`getDamageMax(entityIndex: EntityIndex)`	`Number`	`GetDamageMax`
`getDamageMin(entityIndex: EntityIndex)`	`Number`	`GetDamageMin`
`getDayTimeVisionRange(entityIndex: EntityIndex)`	`Number`	`GetDayTimeVisionRange`
`getHealth(entityIndex: EntityIndex)`	`Number`	`GetHealth`
`getHealthPercent(entityIndex: EntityIndex)`	`EntityIndex`	`GetHealthPercent`
`getHealthThinkRegen(entityIndex: EntityIndex)`	`Number`	`GetHealthThinkRegen`
`getLevel(entityIndex: EntityIndex)`	`Int`	`GetLevel`
`getMaxHealth(entityIndex: EntityIndex)`	`Number`	`GetMaxHealth`
`getNightTimeVisionRange(entityIndex: EntityIndex)`	`Number`	`GetNightTimeVisionRange`
`getStates(entityIndex: EntityIndex)`	`Number`	`GetStates`
`getTotalPurchasedUpgradeGoldCost(entityIndex: EntityIndex)`	`Number`	`GetTotalPurchasedUpgradeGoldCost`
`getTeamNumber(entityIndex: EntityIndex)`	`DOTATeam`	`GetTeamNumber`
`getHealthBarOffset(entityIndex: EntityIndex)`	`Number`	`GetHealthBarOffset`
`getAttackRange(entityIndex: EntityIndex)`	`Number`	`GetAttackRange`
`getAttackSpeed(entityIndex: EntityIndex)`	`Number`	`GetAttackSpeed`
`getAttacksPerSecond(entityIndex: EntityIndex)`	`Number`	`GetAttacksPerSecond`
`getBaseAttackTime(entityIndex: EntityIndex)`	`Number`	`GetBaseAttackTime`
`getBaseMagicalResistanceValue(entityIndex: EntityIndex)`	`Number`	`GetBaseMagicalResistanceValue`
`getBaseMoveSpeed(entityIndex: EntityIndex)`	`Number`	`GetBaseMoveSpeed`
`getBonusPhysicalArmor(entityIndex: EntityIndex)`	`Number`	`GetBonusPhysicalArmor`
`getCollisionPadding(entityIndex: EntityIndex)`	`Number`	`GetCollisionPadding`
`getEffectiveInvisibilityLevel(entityIndex: EntityIndex)`	`Int`	`GetEffectiveInvisibilityLevel`
`getHasteFactor(entityIndex: EntityIndex)`	`Number`	`GetHasteFactor`
`getHullRadius(entityIndex: EntityIndex)`	`Number`	`GetHullRadius`
`getIdealSpeed(entityIndex: EntityIndex)`	`Number`	`GetIdealSpeed`
`getIncreasedAttackSpeed(entityIndex: EntityIndex)`	`Number`	`GetIncreasedAttackSpeed`
`getMana(entityIndex: EntityIndex)`	`Number`	`GetMana`
`getManaThinkRegen(entityIndex: EntityIndex)`	`Number`	`GetManaThinkRegen`
`getMaxMana(entityIndex: EntityIndex)`	`Number`	`GetMaxMana`
`getMagicalArmorValue(entityIndex: EntityIndex)`	`Number`	`GetMagicalArmorValue`
`getPaddedCollisionRadius(entityIndex: EntityIndex)`	`Number`	`GetPaddedCollisionRadius`
`getPercentInvisible(entityIndex: EntityIndex)`	`Number`	`GetPercentInvisible`
`getPhysicalArmorValue(entityIndex: EntityIndex)`	`Number`	`GetPhysicalArmorValue`
`getProjectileCollisionSize(entityIndex: EntityIndex)`	`Number`	`GetProjectileCollisionSize`
`getRingRadius(entityIndex: EntityIndex)`	`Number`	`GetRingRadius`
`getSecondsPerAttack(entityIndex: EntityIndex)`	`Number`	`GetSecondsPerAttack`
`manaFraction(entityIndex: EntityIndex)`	`Number`	`ManaFraction`
`getClassNameAsCStr(entityIndex: EntityIndex)`	`String`	`GetClassNameAsCStr`
`getDisplayedUnitName(entityIndex: EntityIndex)`	`String`	`GetDisplayedUnitName`
`getSelectionGroup(entityIndex: EntityIndex)`	`String`	`GetSelectionGroup`
`getSoundSet(entityIndex: EntityIndex)`	`String`	`GetSoundSet`
`getUnitLabel(entityIndex: EntityIndex)`	`String`	`GetUnitLabel`
`getUnitName(entityIndex: EntityIndex)`	`String`	`GetUnitName`
`getTotalDamageTaken(entityIndex: EntityIndex)`	`Number`	`GetTotalDamageTaken`
`isControllableByPlayer(entityIndex: EntityIndex, playerIndex: Number,)`	`Boolean`	`IsControllableByPlayer`
`getChosenTarget(entityIndex: EntityIndex)`	`Number`	`GetChosenTarget`
`hasItemInInventory(entityIndex: EntityIndex, itemName: String,)`	`Boolean`	`HasItemInInventory`
`getRangeToUnit(entityIndex: EntityIndex, entityIndex2: Number,)`	`EntityIndex`	`GetRangeToUnit`
`isEntityInRange(entityIndex: EntityIndex, entityIndex2: Number, range: Float,)`	`Boolean`	`IsEntityInRange`
`getMoveSpeedModifier(entityIndex: EntityIndex, baseSpeed: Float,)`	`Number`	`GetMoveSpeedModifier`
`canAcceptTargetToAttack(entityIndex: EntityIndex, entityIndex2: Number,)`	`Boolean`	`CanAcceptTargetToAttack`
`inState(entityIndex: EntityIndex, state: Number,)`	`Boolean`	`InState`
`getArmorForDamageType(entityIndex: EntityIndex, damageType: Int,)`	`Number`	`GetArmorForDamageType`
`getArmorReductionForDamageType(entityIndex: EntityIndex, damageType: Int,)`	`Number`	`GetArmorReductionForDamageType`
`isInRangeOfShop(entityIndex: EntityIndex, shopType: Int, specific: Boolean,)`	`Boolean`	`IsInRangeOfShop`
`getNumItemsInStash(entityIndex: EntityIndex)`	`Int`	`GetNumItemsInStash`
`getNumItemsInInventory(entityIndex: EntityIndex)`	`Int`	`GetNumItemsInInventory`
`getItemInSlot(entityIndex: EntityIndex, slotIndex: Number,)`	`Int`	`GetItemInSlot`
`getAbility(entityIndex: EntityIndex, slotIndex: Number,)`	`Number`	`GetAbility`
`getAbilityByName(entityIndex: EntityIndex, abilityName: String,)`	`Number`	`GetAbilityByName`
`getNumBuffs(entityIndex: EntityIndex)`	`Int`	`GetNumBuffs`
`getBuff(entityIndex: EntityIndex, bufIndex: Number,)`	`Int`	`GetBuff`
`getAbilityPoints(entityIndex: EntityIndex)`	`Number`	`GetAbilityPoints`
`getCurrentXP(entityIndex: EntityIndex)`	`Int`	`GetCurrentXP`
`getNeededXPToLevel(entityIndex: EntityIndex)`	`Int`	`GetNeededXPToLevel`
`getSelectionEntities(entityIndex: EntityIndex)`	`Any`	`GetSelectionEntities`	Get the currently selected entities
`passivesDisabled(entityIndex: EntityIndex)`	`Boolean`	`PassivesDisabled`

AbilitiesAPI

Native name: CScriptBindingPR_Abilities

Methods

Method	Return Type	Native Name	Description
`getLocalPlayerActiveAbility()`	`AbilityEntityIndex`	`GetLocalPlayerActiveAbility`	Get the local player's current active ability. (Pre-cast targetting state.)
`executeAbility(abilityEntIndex: AbilityEntityIndex, casterEntIndex: EntityIndex, isQuickCast: Boolean,)`	`Unit`	`ExecuteAbility`	Attempt to execute the specified ability (Equivalent to clicking the ability in the HUD action bar)
`createDoubleTapCastOrder(abilityEntIndex: AbilityEntityIndex, casterEntIndex: EntityIndex,)`	`Unit`	`CreateDoubleTapCastOrder`	Attempt to double-tap (self-cast) the specified ability (Equivalent to double-clicking the ability in the HUD action bar)
`pingAbility(abilityIndex: AbilityEntityIndex)`	`Unit`	`PingAbility`	Ping the specified ability (Equivalent to alt-clicking the ability in the HUD action bar)
`getKeybind(abilityEntIndex: AbilityEntityIndex)`	`String`	`GetKeybind`	Returns the keybind (as a string) for the specified ability.
`getMaxAbilityCharges(abilityEntIndex: AbilityEntityIndex)`	`Int`	`GetMaxAbilityCharges`	Get the max ability charge count.
`getAbilityName(entityIndex: EntityIndex)`	`String`	`GetAbilityName`
`getAbilityTextureName(entityIndex: EntityIndex)`	`String`	`GetAbilityTextureName`
`getAssociatedPrimaryAbilities(entityIndex: EntityIndex)`	`String`	`GetAssociatedPrimaryAbilities`
`getAssociatedSecondaryAbilities(entityIndex: EntityIndex)`	`String`	`GetAssociatedSecondaryAbilities`
`getHotkeyOverride(entityIndex: EntityIndex)`	`String`	`GetHotkeyOverride`
`getIntrinsicModifierName(entityIndex: EntityIndex)`	`String`	`GetIntrinsicModifierName`
`getSharedCooldownName(entityIndex: EntityIndex)`	`String`	`GetSharedCooldownName`
`abilityReady(entityIndex: EntityIndex)`	`Number`	`AbilityReady`
`canBeExecuted(entityIndex: EntityIndex)`	`Number`	`CanBeExecuted`
`getAbilityDamage(entityIndex: EntityIndex)`	`Number`	`GetAbilityDamage`
`getAbilityDamageType(entityIndex: EntityIndex)`	`Number`	`GetAbilityDamageType`
`getAbilityTargetFlags(entityIndex: EntityIndex)`	`Number`	`GetAbilityTargetFlags`
`getAbilityTargetTeam(entityIndex: EntityIndex)`	`DOTATeam`	`GetAbilityTargetTeam`
`getAbilityTargetType(entityIndex: EntityIndex)`	`Number`	`GetAbilityTargetType`
`getAbilityType(entityIndex: EntityIndex)`	`Number`	`GetAbilityType`
`getBehavior(entityIndex: EntityIndex)`	`Number`	`GetBehavior`
`getCastRange(entityIndex: EntityIndex)`	`Number`	`GetCastRange`
`getChannelledManaCostPerSecond(entityIndex: EntityIndex)`	`Number`	`GetChannelledManaCostPerSecond`
`getCurrentCharges(entityIndex: EntityIndex)`	`Number`	`GetCurrentCharges`
`getCurrentAbilityCharges(entityIndex: EntityIndex)`	`Number`	`GetCurrentAbilityCharges`
`getEffectiveLevel(entityIndex: EntityIndex)`	`Int`	`GetEffectiveLevel`
`getHeroLevelRequiredToUpgrade(entityIndex: EntityIndex)`	`Number`	`GetHeroLevelRequiredToUpgrade`
`getLevel(entityIndex: EntityIndex)`	`Int`	`GetLevel`
`getManaCost(entityIndex: EntityIndex)`	`Number`	`GetManaCost`
`getMaxLevel(entityIndex: EntityIndex)`	`Int`	`GetMaxLevel`
`attemptToUpgrade(entityIndex: EntityIndex)`	`Boolean`	`AttemptToUpgrade`
`canLearn(entityIndex: EntityIndex)`	`Boolean`	`CanLearn`
`getAutoCastState(entityIndex: EntityIndex)`	`Boolean`	`GetAutoCastState`
`getToggleState(entityIndex: EntityIndex)`	`Boolean`	`GetToggleState`
`hasScepterUpgradeTooltip(entityIndex: EntityIndex)`	`Boolean`	`HasScepterUpgradeTooltip`
`isActivated(entityIndex: EntityIndex)`	`Boolean`	`IsActivated`
`isActivatedChanging(entityIndex: EntityIndex)`	`Boolean`	`IsActivatedChanging`
`isAttributeBonus(entityIndex: EntityIndex)`	`Boolean`	`IsAttributeBonus`
`isAutocast(entityIndex: EntityIndex)`	`Boolean`	`IsAutocast`
`isCooldownReady(entityIndex: EntityIndex)`	`Boolean`	`IsCooldownReady`
`isDisplayedAbility(entityIndex: EntityIndex)`	`Boolean`	`IsDisplayedAbility`
`isHidden(entityIndex: EntityIndex)`	`Boolean`	`IsHidden`
`isHiddenWhenStolen(entityIndex: EntityIndex)`	`Boolean`	`IsHiddenWhenStolen`
`isInAbilityPhase(entityIndex: EntityIndex)`	`Boolean`	`IsInAbilityPhase`
`isItem(entityIndex: EntityIndex)`	`Boolean`	`IsItem`
`isMarkedAsDirty(entityIndex: EntityIndex)`	`Boolean`	`IsMarkedAsDirty`
`isMuted(entityIndex: EntityIndex)`	`Boolean`	`IsMuted`
`isOnCastbar(entityIndex: EntityIndex)`	`Boolean`	`IsOnCastbar`
`isOnLearnbar(entityIndex: EntityIndex)`	`Boolean`	`IsOnLearnbar`
`isOwnersGoldEnough(entityIndex: EntityIndex)`	`Boolean`	`IsOwnersGoldEnough`
`isOwnersGoldEnoughForUpgrade(entityIndex: EntityIndex)`	`Boolean`	`IsOwnersGoldEnoughForUpgrade`
`isOwnersManaEnough(entityIndex: EntityIndex)`	`Boolean`	`IsOwnersManaEnough`
`isPassive(entityIndex: EntityIndex)`	`Boolean`	`IsPassive`
`isRecipe(entityIndex: EntityIndex)`	`Boolean`	`IsRecipe`
`isSharedWithTeammates(entityIndex: EntityIndex)`	`Boolean`	`IsSharedWithTeammates`
`isStealable(entityIndex: EntityIndex)`	`Boolean`	`IsStealable`
`isStolen(entityIndex: EntityIndex)`	`Boolean`	`IsStolen`
`isToggle(entityIndex: EntityIndex)`	`Boolean`	`IsToggle`
`usesAbilityCharges(entityIndex: EntityIndex)`	`Boolean`	`UsesAbilityCharges`
`getAOERadius(entityIndex: EntityIndex)`	`Number`	`GetAOERadius`
`getBackswingTime(entityIndex: EntityIndex)`	`Number`	`GetBackswingTime`
`getCastPoint(entityIndex: EntityIndex)`	`Number`	`GetCastPoint`
`getChannelStartTime(entityIndex: EntityIndex)`	`Number`	`GetChannelStartTime`
`getChannelTime(entityIndex: EntityIndex)`	`Number`	`GetChannelTime`
`getCooldown(entityIndex: EntityIndex)`	`Number`	`GetCooldown`
`getCooldownLength(entityIndex: EntityIndex)`	`Number`	`GetCooldownLength`
`getCooldownTime(entityIndex: EntityIndex)`	`Number`	`GetCooldownTime`
`getCooldownTimeRemaining(entityIndex: EntityIndex)`	`Number`	`GetCooldownTimeRemaining`
`getDuration(entityIndex: EntityIndex)`	`Number`	`GetDuration`
`getUpgradeBlend(entityIndex: EntityIndex)`	`Number`	`GetUpgradeBlend`
`getAbilityChargeRestoreTimeRemaining(entityIndex: EntityIndex)`	`Number`	`GetAbilityChargeRestoreTimeRemaining`
`canAbilityBeUpgraded(entityIndex: EntityIndex, tomeUpgrade: Boolean,)`	`Number`	`CanAbilityBeUpgraded`	Returns an AbilityLearnResult_t
`getCaster(abilityIndex: AbilityEntityIndex)`	`Number`	`GetCaster`
`getCustomValueFor(abilityIndex: AbilityEntityIndex, abilityVarName: String,)`	`Number`	`GetCustomValueFor`
`getLevelSpecialValueFor(abilityIndex: AbilityEntityIndex, name: String, level: Int,)`	`Number`	`GetLevelSpecialValueFor`
`getSpecialValueFor(abilityIndex: AbilityEntityIndex, name: String,)`	`Number`	`GetSpecialValueFor`
`isCosmetic(abilityIndex: AbilityEntityIndex, targetEntityIndex: EntityIndex,)`	`Boolean`	`IsCosmetic`

ItemsAPI

Native name: CScriptBindingPR_Items

Methods

Method	Return Type	Native Name	Description
`localPlayerDisassembleItem(item: ItemEntityIndex)`	`Unit`	`LocalPlayerDisassembleItem`	Attempt to have the local player disassemble the specified item. Returns false if the order wasn't issued.
`localPlayerDropItemFromStash(item: ItemEntityIndex)`	`Unit`	`LocalPlayerDropItemFromStash`	Attempt to have the local player drop the specified item from its stash. Returns false if the order wasn't issued.
`localPlayerItemAlertAllies(item: ItemEntityIndex)`	`Unit`	`LocalPlayerItemAlertAllies`	Attempt to have the local player alert allies about the specified item. Returns false if the order wasn't issued.
`localPlayerMoveItemToStash(item: ItemEntityIndex)`	`Unit`	`LocalPlayerMoveItemToStash`	Attempt to have the local player move the specified item to its stash. Returns false if the order wasn't issued.
`localPlayerSellItem(item: ItemEntityIndex)`	`Unit`	`LocalPlayerSellItem`	Attempt to have the local player sell the specified item. Returns false if the order wasn't issued.
`shouldDisplayCharges(entityIndex: EntityIndex)`	`Boolean`	`ShouldDisplayCharges`
`alwaysDisplayCharges(entityIndex: EntityIndex)`	`Boolean`	`AlwaysDisplayCharges`
`showSecondaryCharges(entityIndex: EntityIndex)`	`Boolean`	`ShowSecondaryCharges`
`canBeSoldByLocalPlayer(entityIndex: EntityIndex)`	`Boolean`	`CanBeSoldByLocalPlayer`
`canDoubleTapCast(entityIndex: EntityIndex)`	`Boolean`	`CanDoubleTapCast`
`forceHideCharges(entityIndex: EntityIndex)`	`Boolean`	`ForceHideCharges`
`isAlertableItem(entityIndex: EntityIndex)`	`Boolean`	`IsAlertableItem`
`isCastOnPickup(entityIndex: EntityIndex)`	`Boolean`	`IsCastOnPickup`
`isDisassemblable(entityIndex: EntityIndex)`	`Boolean`	`IsDisassemblable`
`isDroppable(entityIndex: EntityIndex)`	`Boolean`	`IsDroppable`
`isInnatelyDisassemblable(entityIndex: EntityIndex)`	`Boolean`	`IsInnatelyDisassemblable`
`isKillable(entityIndex: EntityIndex)`	`Boolean`	`IsKillable`
`isMuted(entityIndex: EntityIndex)`	`Boolean`	`IsMuted`
`isPermanent(entityIndex: EntityIndex)`	`Boolean`	`IsPermanent`
`isPurchasable(entityIndex: EntityIndex)`	`Boolean`	`IsPurchasable`
`isRecipe(entityIndex: EntityIndex)`	`Boolean`	`IsRecipe`
`isRecipeGenerated(entityIndex: EntityIndex)`	`Boolean`	`IsRecipeGenerated`
`isSellable(entityIndex: EntityIndex)`	`Boolean`	`IsSellable`
`isStackable(entityIndex: EntityIndex)`	`Boolean`	`IsStackable`
`proRatesChargesWhenSelling(entityIndex: EntityIndex)`	`Boolean`	`ProRatesChargesWhenSelling`
`requiresCharges(entityIndex: EntityIndex)`	`Boolean`	`RequiresCharges`
`canBeExecuted(entityIndex: EntityIndex)`	`Number`	`CanBeExecuted`
`getCost(entityIndex: EntityIndex)`	`Number`	`GetCost`
`getCurrentCharges(entityIndex: EntityIndex)`	`Number`	`GetCurrentCharges`
`getSecondaryCharges(entityIndex: EntityIndex)`	`Number`	`GetSecondaryCharges`
`getDisplayedCharges(entityIndex: EntityIndex)`	`Number`	`GetDisplayedCharges`
`getInitialCharges(entityIndex: EntityIndex)`	`Number`	`GetInitialCharges`
`getItemColor(entityIndex: EntityIndex)`	`Number`	`GetItemColor`
`getShareability(entityIndex: EntityIndex)`	`Number`	`GetShareability`
`getAbilityTextureSF(entityIndex: EntityIndex)`	`String`	`GetAbilityTextureSF`
`getAssembledTime(entityIndex: EntityIndex)`	`Number`	`GetAssembledTime`
`getPurchaseTime(entityIndex: EntityIndex)`	`Number`	`GetPurchaseTime`
`getPurchaser(itemID: MiscId)`	`Number`	`GetPurchaser`

TeamDetails

Properties

Property	Type	Native Name
`teamID`	`val DOTATeam`	`team_id`
`teamName`	`val String`	`team_name`
`teamMaxPlayers`	`val Int`	`team_max_players`
`teamScore`	`val Int`	`team_score`
`teamNumPlayers`	`val Int`	`team_num_players`

PanoramaPlayerInfo

Properties

Property	Type	Native Name
`playerID`	`val PlayerID`	`player_id`
`playerName`	`val String`	`player_name`
`playerConnectionState`	`val Int`	`player_connection_state`
`playerSteamID`	`val String`	`player_steamid`
`playerTeamID`	`val Int`	`player_team_id`

MapInfo

Properties

Property	Type	Native Name	Description
`mapName`	`val String`	`map_name`
`mapDisplayName`	`val String`	`map_display_name`

PrepareUnitOrdersArgument

Properties

Property	Type	Native Name
`orderType`	`var Int`	`OrderType`
`targetIndex`	`var EntityIndex?`	`TargetIndex`
`abilityIndex`	`var AbilityEntityIndex?`	`AbilityIndex`
`position`	`var List<Float>?`	`Position`
`queue`	`var Boolean?`	`Queue`
`showEffects`	`var Boolean?`	`ShowEffects`

GameAPI

Native name: CScriptBindingPR_Game

Properties

Property	Type	Native Name
`gameTime`	`val Number`	`GetGameTime`
`gameFrameTime`	`val Number`	`GetGameFrameTime`
`isGamePaused`	`val Boolean`	`IsGamePaused`
`isDayTime`	`val Boolean`	`IsDayTime`
`isInToolsMode`	`val Boolean`	`IsInToolsMode`
`isInBanPhase`	`val Boolean`	`IsInBanPhase`
`stateTransitionTime`	`val Number`	`GetStateTransitionTime`
`nianFightTimeLeft`	`val Number`	`GetNianFightTimeLeft`
`state`	`val Number`	`GetState`
`joyFocusPanel`	`var Any`	`GetJoyFocusPanel` / `SetJoyFocusPanel`
`localPlayerID`	`val PlayerID`	`GetLocalPlayerID`
`isInAbilityLearnMode`	`val Boolean`	`IsInAbilityLearnMode`

Methods

Method	Return Type	Native Name	Description
`getGameWinner()`	`Int`	`GetGameWinner`	Return the team id of the winning team.
`getCustomGameDifficulty()`	`Int`	`GetCustomGameDifficulty`	Get the difficulty setting of the game.
`isHUDFlipped()`	`Boolean`	`IsHUDFlipped`	Returns true if the user has enabled flipped HUD
`getScreenWidth()`	`Int`	`GetScreenWidth`	Returns the width of the display.
`getScreenHeight()`	`Int`	`GetScreenHeight`	Returns the height of the display.
`worldToScreenX(x: Float, y: Float, z: Float,)`	`Int`	`WorldToScreenX`	Converts the specified x,y,z world co-ordinate into an x screen coordinate. Returns -1 if behind the camera
`worldToScreenY(x: Float, y: Float, z: Float,)`	`Int`	`WorldToScreenY`	Converts the specified x,y,z world co-ordinate into a y screen coordinate. Returns -1 if behind the camera
`screenXYToWorld(nX: Int, nY: Int,)`	`List<Float>`	`ScreenXYToWorld`	Converts the specified x, y screen coordinates into a x, y, z world coordinates.
`getKeybindForAbility(slot: Int)`	`String`	`GetKeybindForAbility`	Returns the keybind (as a string) for the requested ability slot.
`getKeybindForInventorySlot(slot: Int)`	`String`	`GetKeybindForInventorySlot`	Returns the keybind (as a string) for the requested inventory slot.
`getKeybindForCommand(command: Int)`	`String`	`GetKeybindForCommand`	Returns the keybind (as a string).
`playerJoinTeam(teamID: Int)`	`Unit`	`PlayerJoinTeam`	Assign the local player to the specified team
`autoAssignPlayersToTeams()`	`Unit`	`AutoAssignPlayersToTeams`	Assign the currently unassigned players to teams
`shufflePlayerTeamAssignments()`	`Unit`	`ShufflePlayerTeamAssignments`	Shuffle the team assignments of all of the players currently assigned to a team.
`setRemainingSetupTime(seconds: Float)`	`Unit`	`SetRemainingSetupTime`	Set the remaining seconds in team setup before the game starts. -1 to stop the countdown timer
`setAutoLaunchDelay(seconds: Float)`	`Unit`	`SetAutoLaunchDelay`	Set the amount of time in seconds that will be set as the remaining time when all players are assigned to a team.
`setAutoLaunchEnabled(enable: Boolean)`	`Unit`	`SetAutoLaunchEnabled`
`getAutoLaunchEnabled()`	`Boolean`	`GetAutoLaunchEnabled`	Return true of false indicating if automatically starting the game is enabled.
`setTeamSelectionLocked(lockTeams: Boolean)`	`Unit`	`SetTeamSelectionLocked`
`getTeamSelectionLocked()`	`Boolean`	`GetTeamSelectionLocked`	Returns true or false to indicate if team selection is locked
`getAllTeamIDs()`	`List<Int>`	`GetAllTeamIDs`	Get all team IDs
`getAllPlayerIDs()`	`List<PlayerID>`	`GetAllPlayerIDs`	Get all player IDs
`getUnassignedPlayerIDs()`	`List<PlayerID>`	`GetUnassignedPlayerIDs`	Get unassigned player IDs
`getPlayerUltimateStateOrTime(playerID: PlayerID)`	`Int`	`GetPlayerUltimateStateOrTime`	Get info about the player hero ultimate ability
`isPlayerMuted(playerID: PlayerID)`	`Boolean`	`IsPlayerMuted`	Whether the local player has muted text and voice chat for the specified player id
`setPlayerMuted(playerID: PlayerID, muted: Boolean,)`	`Unit`	`SetPlayerMuted`	Set whether the local player has muted text and voice chat for the specified player id
`getTeamDetails(team: Int)`	`TeamDetails`	`GetTeamDetails`	Get detailed information for the given team
`getLocalPlayerInfo()`	`PanoramaPlayerInfo`	`GetLocalPlayerInfo`	Get details for the local player
`getPlayerItems(playerID: PlayerID)`	`List<ItemEntityIndex>`	`GetPlayerItems`	Get info about the player items.
`getPlayerInfo(playerID: PlayerID)`	`PanoramaPlayerInfo`	`GetPlayerInfo`	Get info about the given player
`getPlayerIDsOnTeam(team: Int)`	`List<PlayerID>`	`GetPlayerIDsOnTeam`	Get player IDs for the given team
`emitSound(soundEventName: String)`	`Unit`	`EmitSound`	Emit a sound for the local player. Returns an integer handle that can be passed to StopSound. (Returns 0 on failure.)
`stopSound(handle: Int)`	`Unit`	`StopSound`	Stop a current playing sound on the local player. Takes handle from a call to EmitSound.
`isShopOpen()`	`Boolean`	`IsShopOpen`	Ask whether the in game shop is open.
`setCustomShopEntityString(customShopEntityString: String)`	`Unit`	`SetCustomShopEntityString`	Set custom shop context.
`getMapInfo()`	`MapInfo`	`GetMapInfo`	Return information about the current map.
`prepareUnitOrders(args: PrepareUnitOrdersArgument)`	`Unit`	`PrepareUnitOrders`	Orders from the local player - takes a single arguments object that supports: dotaunitorder_t OrderType, ent_index TargetIndex, vector Position, ent_index AbilityIndex, OrderIssuer_t OrderIssuer, ent_index UnitIndex, OrderQueueBehavior_t QueueBehavior, bool ShowEffects.
`dropItemAtCursor(controlledUnitEnt: EntityIndex, itemEnt: ItemEntityIndex,)`	`Unit`	`DropItemAtCursor`	Order a unit to drop the specified item at the current cursor location.
`length2D(vec1: List<Float>, vec2: List<Float>,)`	`Float`	`Length2D`	Calculate 2D length.
`normalized(vec: List<Float>)`	`List<Float>`	`Normalized`	Returns normalized vector.
`createCustomKeyBind(keyName: String, commandName: String,)`	`Unit`	`CreateCustomKeyBind`	Create a new keybind.
`isPlayerMutedVoice(playerID: PlayerID)`	`Boolean`	`IsPlayerMutedVoice`	Whether the local player has muted voice chat for the specified player id
`setPlayerMutedVoice(playerID: PlayerID, mutedVoice: Boolean,)`	`Unit`	`SetPlayerMutedVoice`	Set whether the local player has muted voice chat for the specified player id
`isPlayerMutedText(playerID: PlayerID)`	`Boolean`	`IsPlayerMutedText`	Whether the local player has muted text chat for the specified player id
`setPlayerMutedText(playerID: PlayerID, mutedText: Boolean,)`	`Unit`	`SetPlayerMutedText`	Set whether the local player has muted text chat for the specified player id
`time()`	`Number`	`Time`
`getDOTATime(includePreGame: Boolean, includeNegativeTime: Boolean,)`	`Number`	`GetDOTATime`
`diretide2020ShouldShowGameInfo()`	`Boolean`	`Diretide2020ShouldShowGameInfo`
`diretide2020SetShowGameInfo(showGameInfo: Boolean)`	`Unit`	`Diretide2020SetShowGameInfo`
`diretide2020GetGameplayTipNumber()`	`Number`	`Diretide2020GetGameplayTipNumber`
`diretide2020SetGameplayTipNumber(gameplayTipNumber: Number)`	`Unit`	`Diretide2020SetGameplayTipNumber`
`nemesticeGetGameplayTipNumber()`	`Number`	`NemesticeGetGameplayTipNumber`
`nemesticeSetGameplayTipNumber(gameplayTipNumber: Number)`	`Unit`	`NemesticeSetGameplayTipNumber`
`nemesticeShouldShowGameInfo()`	`Boolean`	`NemesticeShouldShowGameInfo`
`nemesticeSetShowGameInfo(showGameInfo: Boolean)`	`Unit`	`NemesticeSetShowGameInfo`
`winter2022ShouldShowGameInfo()`	`Boolean`	`Winter2022ShouldShowGameInfo`
`winter2022SetShowGameInfo(showGameInfo: Boolean)`	`Unit`	`Winter2022SetShowGameInfo`
`winter2022GetGameplayTipNumber()`	`Number`	`Winter2022GetGameplayTipNumber`
`winter2022SetGameplayTipNumber(gameplayTipNumber: Number)`	`Unit`	`Winter2022SetGameplayTipNumber`
`forceCustomUILoad()`	`Unit`	`ForceCustomUILoad`
`cutToDefaultCamera()`	`Unit`	`CutToDefaultCamera`
`playDataDrivenCamera(cameraName: String)`	`Number`	`PlayDataDrivenCamera`
`gameStateIs(state: Number)`	`Boolean`	`GameStateIs`
`gameStateIsBefore(state: Number)`	`Boolean`	`GameStateIsBefore`
`gameStateIsAfter(state: Number)`	`Boolean`	`GameStateIsAfter`
`pushJoyFocusPanel(vararg args: Any)`	`Unit`	`PushJoyFocusPanel`
`popJoyFocusPanel()`	`Unit`	`PopJoyFocusPanel`
`serverCmd(msg: String)`	`Unit`	`ServerCmd`
`setDotaRefractHeroes(enabled: Boolean)`	`Unit`	`SetDotaRefractHeroes`
`finishGame()`	`Unit`	`FinishGame`
`leaveCurrentGame()`	`Unit`	`LeaveCurrentGame`
`disconnect()`	`Unit`	`Disconnect`
`findEventMatch()`	`Unit`	`FindEventMatch`
`slideOutEventGamePlayButton()`	`Unit`	`SlideOutEventGamePlayButton`
`getConvarBool(cvar: String)`	`Boolean`	`GetConvarBool`	Get the bool value of the specific convar. Asserts if invalid and returns false
`getConvarInt(cvar: String)`	`Number`	`GetConvarInt`	Get the int value of the specific convar. Asserts if invalid and returns 0
`getConvarFloat(cvar: String)`	`Number`	`GetConvarFloat`	Get the float value of the specific convar. Asserts if invalid and returns 0.f
`enterAbilityLearnMode()`	`Unit`	`EnterAbilityLearnMode`
`endAbilityLearnMode()`	`Unit`	`EndAbilityLearnMode`

SteamUGCAPI

Native name: CPanoramaScript_SteamUGC

Methods

Method	Return Type	Native Name
`getSubscriptionInfo(publishedFileID: String)`	`Any`	`GetSubscriptionInfo`
`createQueryAllUGCRequest(queryType: Int, matchingUGCType: Int, page: Int,)`	`String`	`CreateQueryAllUGCRequest`
`createQueryUGCDetailsRequest(publishedFileIDs: List<String>)`	`String`	`CreateQueryUGCDetailsRequest`
`addRequiredTagToQuery(handle: String, tag: String,)`	`Unit`	`AddRequiredTagToQuery`
`addExcludedTagToQuery(handle: String, tag: String,)`	`Unit`	`AddExcludedTagToQuery`
`configureQuery(handle: String, jsObject: Any,)`	`Unit`	`ConfigureQuery`

SteamFriendsAPI

Native name: CPanoramaScript_SteamFriends

Methods

Method	Return Type	Native Name	Description
`setLargeAvatarImage(unknown: Any)`	`Unit`	`SetLargeAvatarImage`	Sets the avatar image on the image panel

SteamUtilsAPI

Native name: CPanoramaScript_SteamUtils

Methods

Method	Return Type	Native Name	Description
`getConnectedUniverse()`	`Int`	`GetConnectedUniverse`	Returns the connected universe
`getAppID()`	`MiscId`	`GetAppID`	Returns the appid of the current app

VRUtilsAPI

Native name: CPanoramaScript_VRUtils

Methods

Method	Return Type	Native Name	Description
`getVRAppPropertyData(appID: Int)`	`Any`	`GetVRAppPropertyData`
`launchSteamApp(appID: Int, launchSource: String,)`	`Unit`	`LaunchSteamApp`

DollarStatic

Native name: $

Methods

Method	Return Type	Native Name	Description
`findChildInContext(selector: String)`	`Panel`	`FindChildInContext`	Find an element
`createPanel(type: String, root: PanelBase, id: String, properties: Any?,)`	`Panel`	`CreatePanel`	Create a new panel
`createPanelWithProperties(type: String, root: PanelBase, id: String, properties: Any,)`	`Panel`	`CreatePanelWithProperties`	DEPRECATED: Use $.CreatePanel which has the same signature and supports properties.
`msg(vararg args: Any)`	`Unit`	`Msg`	Log a message
`assertHelper(vararg args: Any)`	`Unit`	`AssertHelper`	Trigger an assert
`warning(vararg args: Any)`	`Unit`	`Warning`	Log a warning message to specified channel
`getContextPanel()`	`Panel`	`GetContextPanel`	Get the current panel context
`cancelScheduled(scheduledEvent: ScheduleID)`	`Unit`	`CancelScheduled`	Cancels a scheduled function
`dispatchEvent(eventName: String, vararg args: Any,)`	`Unit`	`DispatchEvent`	Dispatch an event
`dispatchEventAsync(eventName: String, vararg args: Any,)`	`Unit`	`DispatchEventAsync`	Dispatch an event to occur later
`language()`	`String`	`Language`	Get the current language
`localize(token: String, parent: PanelBase?,)`	`String`	`Localize`	Localize a string. Optionally accepts a Panel argument for dialog variable values.
`localize(token: String, value: Int, parent: PanelBase?,)`	`String`	`Localize`	Localize a string. Optionally accepts a Panel argument for dialog variable values.
`localizePlural(token: String, value: Int, parent: PanelBase?,)`	`String`	`LocalizePlural`
`registerEventHandler(eventName: String, panel: Any, callback: Function<Unit>,)`	`Unit`	`RegisterEventHandler`	Register an event handler
`registerForUnhandledEvent(eventName: String, callback: Function<Unit>,)`	`UnhandledEventListenerID`	`RegisterForUnhandledEvent`	Register a handler for an event that is not otherwise handled
`unregisterForUnhandledEvent(event: String, handle: UnhandledEventListenerID,)`	`Unit`	`UnregisterForUnhandledEvent`	Remove an unhandled event handler
`frameTime()`	`Float`	`FrameTime`	Gets the time this frame started, in seconds since panorama was initialized
`asyncWebRequest(url: String, data: AsyncWebRequestData,)`	`Unit`	`AsyncWebRequest`	Make a web request (disabled)
`dbgIsReloadingScript()`	`Boolean`	`DbgIsReloadingScript`	Call during JS startup code to check if script is being reloaded
`logChannel(vararg unknown: Any)`	`Unit`	`LogChannel`	Create a logging channel
`htmlEscape(string: String)`	`String`	`HTMLEscape`	Convert a string to HTML-safe
`imageFileExists(path: String)`	`Boolean`	`BImageFileExists`	Return true if a file exists. Path will usually start with 'file://{images}'
`constructString(vararg args: Any)`	`Unit`	`ConstructString`	Localize a string using the given property values
`constructMFString(vararg args: Any)`	`Unit`	`ConstructMFString`	Localize a MessageFormat string using the given property values
`mousePosition(vararg args: Any)`	`Unit`	`MousePosition`	Return the position of the mouse in the parent window.
`canLocalize(vararg args: Any)`	`Unit`	`CanLocalize`	Check whether the given localization token is known to the localization system.

AsyncWebRequestResponse

Properties

Property	Type	Native Name	Description
`statusText`	`val String`
`responseText`	`val String?`
`status`	`val Int`

AsyncWebRequestData

Properties

Property	Type	Native Name
`type`	`var String?`	`type`
`timeout`	`var Int?`	`timeout`
`headers`	`var Any?`	`headers`
`data`	`var Any?`	`data`
`success`	`var ((response: Any, result: String, statusText: String) -> Unit)?`	`success`
`error`	`var ((data: AsyncWebRequestResponse, result: String, statusText: String) -> Unit)?`	`error`
`complete`	`var ((data: AsyncWebRequestResponse, result: String) -> Unit)?`	`complete`

DragSettings

Properties

Property	Type	Native Name
`displayPanel`	`var Panel`	`displayPanel`
`offsetX`	`var Int`	`offsetX`
`offsetY`	`var Int`	`offsetY`
`removePositionBeforeDrop`	`var Boolean`	`removePositionBeforeDrop`