Enforce script essentials

Data Structures
class	Class
	Super root of all classes in Enforce script. More...
class	Managed
	TODO doc. More...
class	NonSerialized
	TODO doc. More...
class	ScriptModule
	Module containing compiled scripts. More...
class	EnScript
class	Obsolete
class	array< Class T >
class	set< Class T >
class	map< Class TKey, Class TValue >
	Associative array template usage: More...

Typedefs
typedef int[]	TypeID
	script representation for C++ RTTI types
typedef array< string >	TStringArray
typedef array< float >	TFloatArray
typedef array< int >	TIntArray
typedef array< bool >	TBoolArray
typedef array< Class >	TClassArray
typedef array< Managed >	TManagedArray
typedef array< ref Managed >	TManagedRefArray
typedef array< vector >	TVectorArray
typedef array< typename >	TTypenameArray
typedef set< string >	TStringSet
typedef set< float >	TFloatSet
typedef set< int >	TIntSet
typedef set< Class >	TClassSet
typedef set< Managed >	TManagedSet
typedef set< ref Managed >	TManagedRefSet
typedef set< typename >	TTypenameSet
typedef int	MapIterator
typedef map< int, float >	TIntFloatMap
typedef map< int, int >	TIntIntMap
typedef map< int, string >	TIntStringMap
typedef map< int, Class >	TIntClassMap
typedef map< int, Managed >	TIntManagedMap
typedef map< int, ref Managed >	TIntManagedRefMap
typedef map< int, typename >	TIntTypenameMap
typedef map< int, vector >	TIntVectorMap
typedef map< string, float >	TStringFloatMap
typedef map< string, int >	TStringIntMap
typedef map< string, string >	TStringStringMap
typedef map< string, Class >	TStringClassMap
typedef map< string, Managed >	TStringManagedMap
typedef map< string, ref Managed >	TStringManagedRefMap
typedef map< string, typename >	TStringTypenameMap
typedef map< string, vector >	TStringVectorMap
typedef map< Class, float >	TClassFloatMap
typedef map< Class, int >	TClassIntMap
typedef map< Class, string >	TClassStringMap
typedef map< Class, Class >	TClassClassMap
typedef map< Class, Managed >	TClassManagedMap
typedef map< Class, ref Managed >	TClassManagedRefMap
typedef map< Class, typename >	TClassTypenameMap
typedef map< Class, vector >	TClassVectorMap
typedef map< typename, float >	TTypeNameFloatMap
typedef map< typename, int >	TTypeNameIntMap
typedef map< typename, string >	TTypeNameStringMap
typedef map< typename, Class >	TTypeNameClassMap
typedef map< typename, Managed >	TTypeNameManagedMap
typedef map< typename, ref Managed >	TTypeNameManagedRefMap
typedef map< typename, typename >	TTypeNameTypenameMap
typedef map< typename, vector >	TTypeNameVectorMap
typedef map< Managed, float >	TManagedFloatMap
typedef map< Managed, int >	TManagedIntMap
typedef map< Managed, string >	TManagedStringMap
typedef map< Managed, Class >	TManagedClassMap
typedef map< Managed, Managed >	TManagedManagedMap
typedef map< Managed, ref Managed >	TManagedManagedRefMap
typedef map< Managed, typename >	TManagedTypenameMap
typedef map< Managed, vector >	TManagedVectorMap
typedef map< ref Managed, float >	TManagedRefFloatMap
typedef map< ref Managed, int >	TManagedRefIntMap
typedef map< ref Managed, string >	TManagedRefStringMap
typedef map< ref Managed, Class >	TManagedRefClassMap
typedef map< ref Managed, Managed >	TManagedRefManagedMap
typedef map< ref Managed, ref Managed >	TManagedRefManagedRefMap
typedef map< ref Managed, typename >	TManagedRefTypenameMap
typedef map< ref Managed, vector >	TManagedRefVectorMap

Functions
proto native external bool	IsInherited (typename type)
	Returns true when instance is of the type, or inherited one.
proto native owned external string	ClassName ()
	Returns name of class-type.
string	GetDebugName ()
proto native external	Type ()
	Returns typename of object's class.
proto static external	StaticType ()
	Returns typename of object's reference.
static	StaticGetType (typename t)
	Returns typename of class even without a variable or instance.
proto external string	ToString ()
static proto Class	Cast (Class from)
	Try to safely down-cast base class to child class.
static proto bool	CastTo (out Class to, Class from)
	Try to safely down-cast base class to child class.
private static proto bool	SafeCastType (Class type, out Class to, Class from)
	This function is for internal script usage.
private void	~ScriptModule ()
proto volatile int	Call (Class inst, string function, void parm)
proto volatile int	CallFunction (Class inst, string function, out void returnVal, void parm)
proto volatile int	CallFunctionParams (Class inst, string function, out void returnVal, Class parms)
proto native void	Release ()
static proto native ScriptModule	LoadScript (ScriptModule parentModule, string scriptFile, bool listing)
	Do load script and create ScriptModule for it.
private void	EnScript ()
private void	~EnScript ()
static proto int	GetClassVar (Class inst, string varname, int index, out void result)
	Dynamic read of variable value by its name.
static proto int	SetClassVar (Class inst, string varname, int index, void input)
	Dynamic write to variable by its name.
static proto int	SetVar (out void var, string value)
	Sets variable value by value in string.
static proto void	Watch (void var, int flags)
	Debug tool for watching certain variable. Invokes debugger whenever is variable used.
proto void	Sort (void param_array[], int num)
	Sorts static array of integers(ascendically) / floats(ascendically) / strings(alphabetically)
proto void	reversearray (void param_array)
proto void	copyarray (void destArray, void srcArray)
proto int	ParseStringEx (inout string input, string token)
	Parses one token from input string. Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.
proto int	ParseString (string input, out string tokens[])
	Parses string into array of tokens returns number of tokens.
proto native int	KillThread (Class owner, string name)
	Kills thread.
proto volatile void	Idle ()
proto owned string	ThreadFunction (Class owner, string name, int backtrace, out int linenumber)
	Debug function. Returns current function on stack of the thread.
string	String (string s)
	Helper for passing string expression to functions with void parameter. Example: Print(String("Hello " + var));.
void	Obsolete (string msg="")
Obsolete Managed	PrintString (string s)
	Helper for printing out string expression. Example: PrintString("Hello " + var);.
void	Obsolete (string msg="")
proto native int	Count ()
proto native void	Clear ()
proto void	Set (int n, T value)
proto int	Find (T value)
proto T	Get (int n)
proto int	Insert (T value)
proto int	InsertAt (T value, int index)
void	InsertAll (notnull array< T > from)
	Inserts all elements from array.
proto native void	Remove (int index)
proto native void	RemoveOrdered (int index)
proto native void	Resize (int newSize)
proto native void	Reserve (int newSize)
proto native void	Swap (notnull array< T > other)
proto native void	Sort (bool reverse=false)
proto int	Copy (notnull array< T > from)
proto int	Init (T init[])
void	RemoveItem (T value)
void	RemoveItemUnOrdered (T value)
bool	IsValidIndex (int index)
void	Debug ()
	Print all elements in array.
int	GetRandomIndex ()
	Returns a random index of array. If Count is 0, return index is -1 .
T	GetRandomElement ()
	Returns a random element of array.
void	SwapItems (int item1_index, int item2_index)
void	InsertArray (array< T > other)
void	Invert ()
int	MoveIndex (int curr_index, int move_number)
	Returns a index in array moved by specific number.
void	ShuffleArray ()
int	DifferentAtPosition (array< T > pOtherArray)
	Returns an index where 2 arrays start to differ from each other.
proto native int	Count ()
proto native void	Clear ()
proto int	Find (T value)
proto T	Get (int n)
proto int	Insert (T value)
proto int	InsertAt (T value, int index)
proto native void	Remove (int index)
proto int	Copy (set< T > from)
proto native void	Swap (set< T > other)
proto int	Init (T init[])
void	InsertSet (set< T > other)
void	RemoveItem (T value)
void	RemoveItems (set< T > other)
void	Debug ()
proto native int	Count ()
proto native void	Clear ()
proto TValue	Get (TKey key)
proto bool	Find (TKey key, out TValue val)
proto TValue	GetElement (int index)
proto TKey	GetKey (int i)
proto void	Set (TKey key, TValue value)
proto void	Remove (TKey key)
proto void	RemoveElement (int i)
proto bool	Contains (TKey key)
proto bool	Insert (TKey key, TValue value)
proto int	Copy (map< TKey, TValue > from)
array< TKey >	GetKeyArray ()
array< TValue >	GetValueArray ()
bool	ReplaceKey (TKey old_key, TKey new_key)
TKey	GetKeyByValue (TValue value)
bool	GetKeyByValueChecked (TValue value, out TKey key)
proto native MapIterator	Begin ()
proto native MapIterator	End ()
proto native MapIterator	Next (MapIterator it)
proto TKey	GetIteratorKey (MapIterator it)
proto TValue	GetIteratorElement (MapIterator it)

Variables
string	m_Msg
string	m_Msg
class array< Class T >	PrintString

Detailed Description

Note

float ftime; The deltaTime since last frame

float FLT_MAX; The maximum value for float

float FLT_MIN; The minimum value for float

Typedef Documentation

MapIterator

typedef int MapIterator

TBoolArray

typedef array<bool> TBoolArray

TClassArray

typedef array<Class> TClassArray

TClassClassMap

typedef map<Class, Class> TClassClassMap

TClassFloatMap

typedef map<Class, float> TClassFloatMap

TClassIntMap

typedef map<Class, int> TClassIntMap

TClassManagedMap

typedef map<Class, Managed> TClassManagedMap

TClassManagedRefMap

typedef map<Class, ref Managed> TClassManagedRefMap

TClassSet

typedef set<Class> TClassSet

TClassStringMap

typedef map<Class, string> TClassStringMap

TClassTypenameMap

typedef map<Class, typename> TClassTypenameMap

TClassVectorMap

typedef map<Class, vector> TClassVectorMap

TFloatArray

typedef array<float> TFloatArray

TFloatSet

typedef set<float> TFloatSet

TIntArray

typedef array<int> TIntArray

TIntClassMap

typedef map<int, Class> TIntClassMap

TIntFloatMap

typedef map<int, float> TIntFloatMap

TIntIntMap

typedef map<int, int> TIntIntMap

TIntManagedMap

typedef map<int, Managed> TIntManagedMap

TIntManagedRefMap

typedef map<int, ref Managed> TIntManagedRefMap

TIntSet

typedef set<int> TIntSet

TIntStringMap

typedef map<int, string> TIntStringMap

TIntTypenameMap

typedef map<int, typename> TIntTypenameMap

TIntVectorMap

typedef map<int, vector> TIntVectorMap

TManagedArray

typedef array<Managed> TManagedArray

TManagedClassMap

typedef map<Managed, Class> TManagedClassMap

TManagedFloatMap

typedef map<Managed, float> TManagedFloatMap

TManagedIntMap

typedef map<Managed, int> TManagedIntMap

TManagedManagedMap

typedef map<Managed, Managed> TManagedManagedMap

TManagedManagedRefMap

typedef map<Managed, ref Managed> TManagedManagedRefMap

TManagedRefArray

typedef array<ref Managed> TManagedRefArray

TManagedRefClassMap

typedef map<ref Managed, Class> TManagedRefClassMap

TManagedRefFloatMap

typedef map<ref Managed, float> TManagedRefFloatMap

TManagedRefIntMap

typedef map<ref Managed, int> TManagedRefIntMap

TManagedRefManagedMap

typedef map<ref Managed, Managed> TManagedRefManagedMap

TManagedRefManagedRefMap

typedef map<ref Managed, ref Managed> TManagedRefManagedRefMap

TManagedRefSet

typedef set<ref Managed> TManagedRefSet

TManagedRefStringMap

typedef map<ref Managed, string> TManagedRefStringMap

TManagedRefTypenameMap

typedef map<ref Managed, typename> TManagedRefTypenameMap

TManagedRefVectorMap

typedef map<ref Managed, vector> TManagedRefVectorMap

TManagedSet

typedef set<Managed> TManagedSet

TManagedStringMap

typedef map<Managed, string> TManagedStringMap

TManagedTypenameMap

typedef map<Managed, typename> TManagedTypenameMap

TManagedVectorMap

typedef map<Managed, vector> TManagedVectorMap

TStringArray

typedef array<string> TStringArray

TStringClassMap

typedef map<string, Class> TStringClassMap

TStringFloatMap

typedef map<string, float> TStringFloatMap

TStringIntMap

typedef map<string, int> TStringIntMap

TStringManagedMap

typedef map<string, Managed> TStringManagedMap

TStringManagedRefMap

typedef map<string, ref Managed> TStringManagedRefMap

TStringSet

typedef set<string> TStringSet

TStringStringMap

typedef map<string, string> TStringStringMap

TStringTypenameMap

typedef map<string, typename> TStringTypenameMap

TStringVectorMap

typedef map<string, vector> TStringVectorMap

TTypenameArray

typedef array<typename> TTypenameArray

TTypeNameClassMap

typedef map<typename, Class> TTypeNameClassMap

TTypeNameFloatMap

typedef map<typename, float> TTypeNameFloatMap

TTypeNameIntMap

typedef map<typename, int> TTypeNameIntMap

TTypeNameManagedMap

typedef map<typename, Managed> TTypeNameManagedMap

TTypeNameManagedRefMap

typedef map<typename, ref Managed> TTypeNameManagedRefMap

TTypenameSet

typedef set<typename> TTypenameSet

TTypeNameStringMap

typedef map<typename, string> TTypeNameStringMap

TTypeNameTypenameMap

typedef map<typename, typename> TTypeNameTypenameMap

TTypeNameVectorMap

typedef map<typename, vector> TTypeNameVectorMap

TVectorArray

typedef array<vector> TVectorArray

TypeID

typedef int [] TypeID

script representation for C++ RTTI types

Function Documentation

Begin()

proto native MapIterator Begin ( )

private

Call()

proto volatile int Call ( Class  inst, string  function, void  parm  )

private

dynamic call of function when inst == NULL, it's global function call, otherwise it's method of class returns true, when success The call creates new thread, so it's legal to use sleep/wait

Referenced by UIScriptedMenu::Init(), and EnProfilerTests::TestFuncCountData().

CallFunction()

proto volatile int CallFunction ( Class  inst, string  function, out void  returnVal, void  parm  )

private

dynamic call of function when inst == NULL, it's global function call, otherwise it's method of class returns true, when success The call do not create new thread!!!!

Referenced by CallQueueContext::CallParams(), ComponentEnergyManager::DeviceUpdate(), ComponentEnergyManager::Event_OnInit(), DayZCreature::ModCommandHandlerBefore(), PluginBase::OnKeyPress(), PluginBase::OnMouse(), OnMouseButtonUp(), UniversalTemperatureSource::OnTimer(), TimerBase::OnTimer(), array::Run(), SetControlType(), ComponentEnergyManager::SwitchOff(), ComponentEnergyManager::SwitchOn(), TestCleanup(), EnProfilerTests::TestFuncCountData(), AnimationTimer::Tick(), UpdataControllerInput(), and Update().

CallFunctionParams()

proto volatile int CallFunctionParams ( Class  inst, string  function, out void  returnVal, Class  parms  )

private

Referenced by CallQueueContext::CallParams(), WidgetEventHandler::OnChildAdd(), WidgetEventHandler::OnChildRemove(), WidgetEventHandler::OnClick(), WidgetEventHandler::OnDoubleClick(), WidgetEventHandler::OnDrag(), WidgetEventHandler::OnDraggingOver(), WidgetEventHandler::OnDrop(), WidgetEventHandler::OnDropReceived(), WidgetEventHandler::OnFocus(), WidgetEventHandler::OnFocusLost(), WidgetEventHandler::OnMouseButtonDown(), WidgetEventHandler::OnMouseButtonUp(), WidgetEventHandler::OnMouseEnter(), WidgetEventHandler::OnMouseLeave(), WidgetEventHandler::OnMouseWheel(), UniversalTemperatureSource::OnTimer(), TimerBase::OnTimer(), and EnProfilerTests::TestFuncCountData().

Cast()

static proto Class Cast ( Class  from )

staticprivate

Try to safely down-cast base class to child class.

Returns

down-casted 'from' pointer when cast is successfull (classes are related), or null if casting is invalid

// assume that Man inheites from Object
Object obj = g_Game.GetPlayer();
Man player = Man.Cast(obj);
 
if (player)
{
    // horay!
}

CastTo()

static proto bool CastTo ( out Class  to, Class  from  )

staticprivate

Try to safely down-cast base class to child class.

Returns

bool true when 'from' is not null and cast successfull, false when casting is not valid or 'from' is null

// assume that Man inheites from Object
Object obj = g_Game.GetPlayer();
Man player;
 
if (Class.CastTo(player, obj))
{
    // horay!
}

Referenced by AbortWeaponEvent(), ActionCarHornBase::ActionCondition(), ActionBuryBody::ActionCondition(), ActionCoverHeadTarget::ActionCondition(), ActionDigGardenPlot::ActionCondition(), ActionDigInStash::ActionCondition(), ActionCondition(), ActionDisinfectPlant::ActionCondition(), ActionEatFruit::ActionCondition(), ActionFillGeneratorTank::ActionCondition(), ActionFillObject::ActionCondition(), ActionGagTarget::ActionCondition(), ActionLockDoors::ActionCondition(), ActionRefuelTorch::ActionCondition(), ActionRepairShelter::ActionCondition(), ActionRepairTent::ActionCondition(), ActionRepairTentPart::ActionCondition(), ActionShaveTarget::ActionCondition(), ActionUncoverHeadTarget::ActionCondition(), ActionUngagTarget::ActionCondition(), ActionUnlockShippingContainer::ActionCondition(), ActionUnlockDoors::ActionCondition(), ActionViewBinoculars::ActionCondition(), ActionViewOptics::ActionCondition(), ActionDefibrilateBase::ActionCondition(), ActionCloseDoors::ActionCondition(), ActionEnterLadder::ActionCondition(), ActionGetInTransport::ActionCondition(), ActionHarvestCrops::ActionCondition(), ActionOpenDoors::ActionCondition(), ActionPickupChicken::ActionCondition(), ActionRemovePlant::ActionCondition(), ActionRemoveSeed::ActionCondition(), ActionAnimateCarSelection::ActionCondition(), ActionAnimateSeats::ActionCondition(), ActionCarDoors::ActionCondition(), ActionCarDoorsOutside::ActionCondition(), ActionSwitchLights::ActionCondition(), ActionClapBearTrapWithThisItem::ActionCondition(), ActionOpen::ActionCondition(), ActionToggleNVMode::ActionCondition(), ActionZoomIn::ActionCondition(), ActionZoomOut::ActionCondition(), ActionSwitchSeats::ActionCondition(), ActionWorldCraft::ActionConditionContinue(), CatchingContextTrapsBase::AdjustBaitItemChance(), UIScriptedMenu::Apply(), ApplyDrynessToItemEx(), ActionGetOutTransport::ApplyJumpOutDmg(), ApplyWetnessToItem(), ManBase::BrokenLegForceProne(), ButtonHighlight(), ButtonNormal(), CAContinuousEmptyMagazine::CalcAndSetQuantity(), CAContinuousTransferQuantity::CalcAndSetQuantity(), PluginBase::CalculateHealth(), ManBase::CalculateVisibilityForAI(), DayZPlayer::CameraHandler(), WeaponManager::CanAttachMagazine(), DayZPlayer::CanClimb(), Attachments::CanCombineAmmo(), VicinitySlotsContainer::CanCombineAmmo(), AttachmentCategoriesContainer::CanDisplayAnyCategory(), RecipeBase::CanDo(), ActionEmptyMagazine::CanEmpty(), ItemBase::CanLoadAttachment(), ActionLoadMagazine::CanLoadMagazine(), UIScriptedMenu::CanOpenMenu(), CanPlayEmote(), ItemBase::CanReceiveAttachment(), WeaponManager::CanSwapMagazine(), TrapBase::CauseVictimToStartLimping(), ScriptedWidgetEventHandler::CheckForActionWidgetOverrides(), ManBase::CheckForBurlap(), ManBase::CheckForGag(), ScriptedWidgetEventHandler::ColorRed(), ScriptedWidgetEventHandler::ColorWhite(), ConnectionLost::ConnectionLost(), BreakLongWoodenStick::CopyOldPropertiesToNew(), UnboxLambda::CopyOldPropertiesToNew(), CopyOldPropertiesToNew(), TorchLambda::CopyOldPropertiesToNew(), ActionFishingNewCB::CreateActionComponent(), ActionFishingNew::CreateAndSetupActionCallback(), CreateAndSetupActionCallback(), ActionRepositionPluggedItem::CreateAndSetupActionCallback(), ActionTakeArrowToHands::CreateAndSetupActionCallback(), ActionTakeHybridAttachmentToHands::CreateAndSetupActionCallback(), ActionTakeItemToHands::CreateAndSetupActionCallback(), ActionTakeMaterialToHands::CreateAndSetupActionCallback(), AnimatedActionBase::CreateAndSetupActionCallback(), MissionBase::CreateCharacter(), PlayerSpawnHandler::CreateChildItem(), CreateDamageTriggerEx(), CreateEmoteCallback(), CreateOrgan(), Car::CreateSoundForAnimationSource(), Hologram::CreateTrigger(), CreateTrigger(), Car::DamageCrew(), DamageDealtEffect::DamageDealtEffect(), DayZIntroScene::DayZIntroScene(), DayZPlayerCameraBase::DayZPlayerCameraIronsights(), DayZPlayerImplementAiming::DayZPlayerImplementAiming(), InventoryActionHandler::DeactiveAction(), DeferredWeaponFailed(), ActionDefibrilateBase::DefibrillateServer(), StaminaHandler::DepleteStaminaEx(), CatchingContextFishingBase::DeserializeData(), CatchingContextTrapsBase::DeserializeData(), ActionDismantlePart::DismantleCondition(), Hud::DisplayBadge(), Hud::DisplayNotifier(), Hud::DisplayPresence(), Hud::DisplayStance(), Hud::DisplayTendencyNormal(), RecipeBase::Do(), ClosableContainer::DraggingOverHeader(), WeaponDebug::DrawLineOfFireCameraHybrid(), WeaponDebug::DrawLineOfFireMuzzleToHit(), ManBase::DropAllItems(), ActionDeployBase::DropDuringPlacing(), ManBase::EEItemIntoHands(), Mask_Base::EEItemLocationChanged(), ManBase::EEItemOutOfHands(), InventoryItemSuper::EEKilled(), EffectRadial(), Trigger::EOnEnter(), Trigger::EOnLeave(), AreaDamageTriggerBase::EOnTouch(), Hologram::EvaluateCollision(), ActionFishingNew::EvaluateFishingResult(), VicinityItemManager::ExcludeFromContainer_Phase1(), VicinityItemManager::ExcludeFromContainer_Phase2(), VicinityItemManager::ExcludeFromContainer_Phase3(), CAContinuousCraft::Execute(), CAContinuousFertilizeGardenSlot::Execute(), CAContinuousMineWood::Execute(), CAContinuousRepeatStartEngine::Execute(), CAContinuousTransferQuantity::Execute(), CAContinuousWaterPlant::Execute(), FlashbangEffect::FlashbangEffect(), FloatingCrossHair(), GameplayEffectsDataImage(), GenerateResult(), CatchingContextFishingRodAction::GenerateResult(), GestureMenuItem(), ActionTargetsCursor::GetActionManager(), ScriptedWidgetEventHandler::GetActionManager(), GetActionManager(), FishingRod_Base_New::GetActionWidgetOverride(), ActionMountBarbedWire::GetBarbedWire(), CarScript::GetCarDoorsState(), HandsContainer::GetCombinationFlags(), ItemManager::GetCombinationFlags(), ScriptedWidgetEventHandler::GetCrosshairPosition(), ActionTargetsCursor::GetItemHealth(), QuantityConversions::GetItemQuantity(), QuantityConversions::GetItemQuantity(), ActionTargetsCursor::GetItemQuantity(), QuantityConversions::GetItemQuantityMax(), QuantityConversions::GetItemQuantityText(), GetLocalProperties(), GetMeleeTarget(), CAContinuousMineRock::GetMiningData(), CAContinuousMineWood::GetMiningData(), InventoryItem::GetNumberOfItems(), ActionHarvestCrops::GetPlantSlot(), ActionTargetsCursor::GetPlayer(), ScriptedWidgetEventHandler::GetPlayer(), GetPlayer(), DeveloperTeleport::GetPlayerRootForTeleporting(), ScriptedWidgetEventHandler::GetRadioFrequency(), Managed::GetRequester(), ActionWorldCraft::GetText(), CGame::GetUserFOVFromConfig(), WeaponDebug::GetWeaponInHands(), BotGuardBase::GuardCondition(), HandEventBase(), DayZPlayer::HandleDeath(), BaseBuildingBase::HandleDropAttachment(), HandleDropCartridge(), Car::HandleEngineSound(), HandleInventory(), PlayerSpawnHandler::HandleNewItem(), HandlePlayerBody(), HandleStoreCartridge(), HandleWeaponEvents(), DayZPlayer::HandleWeapons(), QuantityConversions::HasItemQuantity(), UIScriptedMenu::Init(), Init(), ScriptedWidgetEventHandler::Init(), Hud::Init(), Hud::InitBadgesAndNotifiers(), PPEMatClassParameterCommandData::InitDefaults(), IsAuthoritative(), IsEntityBehindEntityInAngle(), EntityAI::IsIgnoredObject(), HumanCommandVehicle::IsObjectIgnoredOnGettingOut(), IsOwner(), IsProxy(), VONManager::IsVoiceThresholdMinimum(), IsWearingBurlap(), ActionUncoverHeadTarget::IsWearingBurlap(), ActionUngagSelf::IsWearingGag(), ActionUngagTarget::IsWearingGag(), ManBase::IsWearingSplint(), ItemBase::ItemFall(), LoadingScreen(), ActionLockDoors::LockDoor(), UIScriptedMenu::MarkSelected(), DayZCreature::ModCommandHandlerBefore(), ModifierBase(), ActionWorldCraft::OnActionInfoUpdate(), ActionContinuousBase::OnAnimationEvent(), AKS74U::OnDebugSpawn(), Aug_Base::OnDebugSpawn(), Weapon_Base::OnDebugSpawn(), B95_base::OnDebugSpawn(), CZ550_Base::OnDebugSpawn(), RifleSingleShot_Base::OnDebugSpawn(), Mosin9130_Base::OnDebugSpawn(), Repeater::OnDebugSpawn(), Winchester70_Base::OnDebugSpawn(), Izh43Shotgun_Base::OnDebugSpawn(), Mp133Shotgun_Base::OnDebugSpawn(), VSS_Base::OnDebugSpawn(), CivilianBelt::OnDebugSpawn(), HelmetBase::OnDebugSpawn(), HipPack_ColorBase::OnDebugSpawn(), MilitaryBelt::OnDebugSpawn(), PlateCarrierVest::OnDebugSpawn(), FishingRod_Base_New::OnDebugSpawn(), Container_Base::OnDebugSpawn(), ItemBase::OnDebugSpawn(), CarScript::OnDebugSpawn(), AttachmentCategoriesRow::OnDropReceivedFromHeader(), ActionFishingNew::OnEnd(), ActionViewOptics::OnEndAnimationLoopClient(), ActionViewOptics::OnEndAnimationLoopServer(), ActionViewOptics::OnEndClient(), ActionContinuousBase::OnEndInput(), ActionFishingNew::OnEndInput(), ActionViewOptics::OnEndServer(), ActionCollectBloodSelf::OnEndServer(), ActionCollectBloodTarget::OnEndServer(), ActionCollectSampleSelf::OnEndServer(), ActionCollectSampleTarget::OnEndServer(), ActionAnimateCarSelection::OnEndServer(), ActionZoomIn::OnEndServer(), ActionZoomOut::OnEndServer(), WeaponStateBase::OnEntry(), WeaponStartAction::OnEntry(), WeaponFire::OnEntry(), OnEntry(), CGame::OnEvent(), OnEvent(), MissionBase::OnEvent(), ActionAttachWheels::OnExecuteClient(), ActionEmptyMagazine::OnExecuteServer(), ActionLoadMagazine::OnExecuteServer(), ActionRefuelTorch::OnExecuteServer(), ActionSwitchLights::OnExecuteServer(), ActionAttachWheels::OnExecuteServer(), ActionClapBearTrapWithThisItem::OnExecuteServer(), WeaponStartAction::OnExit(), ActionFishingNew::OnFinishProgress(), ActionFillObject::OnFinishProgressClient(), ActionDefibrilateSelf::OnFinishProgressClient(), ActionDefibrilateTarget::OnFinishProgressClient(), ActionBreakLongWoodenStick::OnFinishProgressServer(), ActionCoverHeadSelf::OnFinishProgressServer(), ActionCoverHeadTarget::OnFinishProgressServer(), OnFinishProgressServer(), ActionFillObject::OnFinishProgressServer(), ActionGagSelf::OnFinishProgressServer(), ActionGagTarget::OnFinishProgressServer(), ActionRepairPart::OnFinishProgressServer(), ActionRepairShelter::OnFinishProgressServer(), ActionRepairTent::OnFinishProgressServer(), ActionShaveTarget::OnFinishProgressServer(), ActionStripCarrierVest::OnFinishProgressServer(), ActionUngagSelf::OnFinishProgressServer(), ActionUngagTarget::OnFinishProgressServer(), ActionWorldCraft::OnFinishProgressServer(), ActionDefibrilateSelf::OnFinishProgressServer(), Barrel_ColorBase::OnFreezeStateChangeServer(), OnFreezeStateChangeServer(), SymptomBase::OnInit(), ItemBase::OnInventoryEnter(), Weapon::OnItemLocationChanged(), Icon::OnPerformCombination(), HandsContainer::OnPerformCombination(), EntityPlacementCallback::OnQuery(), ManBase::OnQuickBarSingleUse(), TrapBase::OnServerSteppedOn(), EntityPlacementCallback::OnSetup(), OnShow(), CAContinuousRepeatFishing::OnSignalEnd(), ActionFishingNew::OnSignalEnd(), CAContinuousRepeatFishing::OnSignalStart(), ActionFishingNew::OnSignalStart(), ActionSwitchSeats::OnStart(), ActionViewOptics::OnStartAnimationLoopClient(), ActionViewOptics::OnStartAnimationLoopServer(), ActionCloseDoors::OnStartServer(), ActionGetOutTransport::OnStartServer(), ActionOpenDoors::OnStartServer(), ActionPullBodyFromTransport::OnStartServer(), ActionAnimateCarSelection::OnStartServer(), PPERequester_GameplayBase::OnStop(), InventoryItem::OnStoreLoad(), UngagSelfLambda::OnSuccess(), WeaponStartAction::OnUpdate(), OnUpdate(), WeaponFireMultiMuzzle::OnUpdate(), WeaponStateBase::OnUpdate(), Car::OnVehicleJumpOutServer(), ItemOptics::OnWasAttached(), HeadGear_Base::OnWasAttached(), ItemBase::OnWasAttached(), ItemOptics::OnWasDetached(), ItemBase::OnWasDetached(), Icon::PerformCombination(), Hologram::PlaceEntity(), ManBase::PredictiveSwapEntities(), ProcessItemHierarchyRecursive(), DayZPlayer::ProcessWeaponEvent(), RandomizeSignalValues(), ActionFishingNew::ReadFromContext(), VicinityItemManager::RefreshVicinityItems(), GameplayEffectsData::RegisterData(), PPEClassBase::RegisterParameterColorEx(), PPEClassBase::RegisterParameterScalarFloatEx(), ManBase::ReloadWeapon(), ManBase::RemoveAllItems(), ItemBase::RemoveCookingAudioVisuals(), RemoveSplint(), ActionRepairTent::RepairDamageTransfer(), CatchingResultBase::RollChanceSeeded(), RollNextResultChance(), SelectStoreCartridge(), ActionBase::SendMessageToClient(), InventoryActionHandler::SetAction(), ActionTargetsCursor::SetActionWidget(), ScriptedWidgetEventHandler::SetActionWidget(), Weapon_Base::SetAttachmentsHealth(), ManBase::SetContaminatedEffectEx(), DayZIntroScenePC::SetInitPostprocesses(), DayZIntroSceneXbox::SetInitPostprocesses(), ActionTargetsCursor::SetInteractActionIcon(), ScriptedWidgetEventHandler::SetInteractActionIcon(), ScriptedWidgetEventHandler::SetItemDesc(), ActionTargetsCursor::SetItemDesc(), ActionTargetsCursor::SetItemHealth(), ScriptedWidgetEventHandler::SetItemHealth(), ActionTargetsCursor::SetItemQuantity(), ScriptedWidgetEventHandler::SetItemQuantity(), ScriptedWidgetEventHandler::SetRadioFrequency(), Hud::SetStamina(), CAContinuousCraft::Setup(), CAContinuousDisinfectPlant::Setup(), CAContinuousEmptyMagazine::Setup(), CAContinuousFertilizeGardenSlot::Setup(), CAContinuousFill::Setup(), CAContinuousFish::Setup(), CAContinuousLoadMagazine::Setup(), CAContinuousTransferQuantity::Setup(), CAContinuousWaterPlant::Setup(), CAContinuousWaterSlot::Setup(), ActionFishingNew::SetupAction(), ActionWorldCraft::SetupAction(), ScriptedWidgetEventHandler::SetValue(), Hud::SetWalkieTalkieText(), ScriptedWidgetEventHandler::SetWeaponModeAndZeroing(), ScriptedWidgetEventHandler::SetWeaponQuantity(), SoftSkillManagerDebug(), ActionSortAmmoPile::SortAmmo(), Car::SpawnAdditionalItems(), CarchingResultFishingAction::SpawnAndSetup(), CatchingResultTrapBase::SpawnAndSetup(), PlayerSpawnHandler::SpawnComplexChildrenItems(), PluginBase::SpawnEntityOnCursorDir(), PluginBase::SpawnEntityOnGroundPatternGrid(), PluginBase::SpawnEntityOnGroundPos(), PlayerSpawnHandler::SpawnSimpleChildrenItems(), ActionEnterLadder::Start(), StopCooling(), SwitchPreset(), SyncAnimState(), HandsContainer::TakeAsAttachment(), ClosableContainer::TakeAsAttachment(), DeveloperTeleport::TeleportAtCursor(), DeveloperTeleport::TeleportAtCursorEx(), ScriptedWidgetEventHandler::TextMapUpdateWidget(), PluginDayzPlayerDebug_Weapons::Tick(), TransferEntityVariables(), ActionUnlockShippingContainer::TranslateLockSelectionIntoDoorIdx(), DayZPlayer::TriggerPullPlayerOutOfVehicle(), Managed::TrySpawnNextDrop(), ActionUncoverHeadBase::UncoverHead(), ActionUnlockShippingContainer::UnlockDoor(), ActionUnlockDoors::UnlockDoor(), GameplayEffectsData::Update(), Hud::UpdateBloodName(), UIScriptedMenu::UpdateItemInfoQuantity(), MissionBase::UpdatePlayersStats(), UniversalTemperatureSourceLambdaBaseImpl::UpdateVicinityTemperatureRecursive(), UniversalTemperatureSourceLambdaBaseImpl::WarmAndCoolItemsInVicinity(), ActionFishingNew::WriteToContext(), ActionMountBarbedWire::WriteToContext(), ActionRepairCarPart::WriteToContext(), ActionRepairPart::WriteToContext(), ActionRepairTent::WriteToContext(), ActionRepairTentPart::WriteToContext(), and ActionRepairVehiclePartBase::WriteToContext().

ClassName()

proto native owned external string ClassName ( )

private

Returns name of class-type.

Parameters

inst

Class

Returns

string class-type

Man player = g_Game.GetPlayer();
string className = player.ClassName();
Print(className);
 
>> className = 'Man'

Referenced by Class::GetDebugName().

Clear() [1/3]

proto native void Clear ( )

private

Destroyes all elements of the array and sets the Count to 0. The underlying memory of the array is not freed.

Clear() [2/3]

proto native void Clear ( )

private

Clear() [3/3]

proto native void Clear ( )

private

Clears the hash map.

Contains()

proto bool Contains ( TKey  key )

private

Returns if map contains element with given key.

Copy() [1/3]

proto int Copy ( map< TKey, TValue >  from )

private

Copy() [2/3]

proto int Copy ( notnull array< T >  from )

private

Copes contents of from array to this array.

Returns

How many elements were copied

Copy() [3/3]

proto int Copy ( set< T >  from )

private

copyarray()

proto void copyarray	(	void	destArray,
		void	srcArray
	)

Count() [1/3]

proto native int Count ( )

private

O(1) complexity.

Returns

Number of elements of the array

Count() [2/3]

proto native int Count ( )

private

Count() [3/3]

proto native int Count ( )

private

Returns

The number of elements in the hashmap.

Debug() [1/2]

void Debug ( )

inlineprivate

Print all elements in array.

Returns

void

my_array.Debug();
 
>> "One"
>> "Two"
>> "Three"

References Count, Get(), and Print().

Debug() [2/2]

void Debug ( )

inlineprivate

References Count, Get(), and Print().

DifferentAtPosition()

int DifferentAtPosition ( array< T >  pOtherArray )

inlineprivate

Returns an index where 2 arrays start to differ from each other.

Returns

int Index from where arrays differ

array<int> arr1 = {0,1,2,3};
array<int> arr2 = {0,1,3,2};
int differsAt = arr1.DifferentAtPosition(arr2);
Print(differsAt);
 
>> 2

References Count, ErrorEx, and Get().

End()

proto native MapIterator End ( )

private

EnScript()

private void EnScript ( )

inlineprivate

Find() [1/3]

proto int Find ( T  value )

private

Tries to find the first occurance of given value in the array.

Returns

Index of the first occurance of value if found, -1 otherwise

Find() [2/3]

proto int Find ( T  value )

private

Tries to find the first occurance of given value in the set.

Returns

Index of the first occurance of value if found, -1 otherwise

Find() [3/3]

proto bool Find ( TKey  key, out TValue  val  )

private

Search for an element with the given key.

Parameters

key	The key of the element to find
val	result is stored to val

Returns

returns True if given key exist.

Get() [1/3]

proto T Get ( int  n )

private

Returns

Element at the index n

Get() [2/3]

proto T Get ( int  n )

private

Get() [3/3]

proto TValue Get ( TKey  key )

private

Search for an element with the given key.

Parameters

key	The key of the element to find

Returns

Pointer to element data if found, NULL otherwise.

GetClassVar()

static proto int GetClassVar ( Class  inst, string  varname, int  index, out void  result  )

staticprivate

Dynamic read of variable value by its name.

Parameters

	inst	When inst == NULL, it's for global variable, otherwise it's class member
	index	Is index when variable is array
[out]	result	Variable must be of the same type!

Returns

int true when success

float count = 0;
 
bool success = EnScript.GetClassVar(myClass, "m_Counter", 0, count);
Print(count);
Print(success);
 
>> count = 5
>> success = 1

GetDebugName()

string GetDebugName ( )

inlineprivate

References Class::ClassName().

GetElement()

proto TValue GetElement ( int  index )

private

Return the i:th element in the map. Note: This operation is O(n) complexity. Use with care!

Parameters

index

The position of the element in the map

Returns

The element on the i:th position

GetIteratorElement()

proto TValue GetIteratorElement ( MapIterator  it )

private

GetIteratorKey()

proto TKey GetIteratorKey ( MapIterator  it )

private

GetKey()

proto TKey GetKey ( int  i )

private

Return the i:th element key in the map. Note: This operation is O(n) complexity. Use with care!

Parameters

i	The position of the element key in the map

Returns

Return key of i-th element

GetKeyArray()

array< TKey > GetKeyArray ( )

inlineprivate

References Count.

GetKeyByValue()

TKey GetKeyByValue ( TValue  value )

inlineprivate

References Count, and GetElement().

GetKeyByValueChecked()

bool GetKeyByValueChecked ( TValue  value, out TKey  key  )

inlineprivate

References Count, and GetElement().

GetRandomElement()

T GetRandomElement ( )

inlineprivate

Returns a random element of array.

Returns

int Random element of array

Print( my_array.GetRandomElement() );
 
>> "Three"

References Get().

GetRandomIndex()

int GetRandomIndex ( )

inlineprivate

Returns a random index of array. If Count is 0, return index is -1 .

Returns

int Random index of array

Print( my_array.GetRandomIndex() );
 
>> 2

References Count, and Math::RandomInt().

GetValueArray()

array< TValue > GetValueArray ( )

inlineprivate

References Count, and GetElement().

Idle()

proto volatile void Idle

(

)

Yiels execution to other threads and then it continues. Obsolete...

Init() [1/2]

proto int Init ( T  init[] )

private

Init() [2/2]

proto int Init ( T  init[] )

private

Insert() [1/3]

proto int Insert ( T  value )

private

Inserts element at the end of array.

Parameters

value

Element to be inserted

Returns

Position at which element is inserted

Insert() [2/3]

proto int Insert ( T  value )

private

Inserts element at the end of array.

Parameters

value

Element to be inserted

Returns

Position at which element is inserted

Insert() [3/3]

proto bool Insert ( TKey  key, TValue  value  )

private

Insert new element into hash map.

Parameters

key	Key of element to be inserted.
value	Data of element to be inserted.

InsertAll()

void InsertAll ( notnull array< T >  from )

inlineprivate

Inserts all elements from array.

Parameters

from

array<T> array from which all elements will be added TStringArray arr1 = new TStringArray; arr1.Insert( "Dave" ); arr1.Insert( "Mark" ); arr1.Insert( "John" ); TStringArray arr2 = new TStringArray; arr2.Insert( "Sarah" ); arr2.Insert( "Cate" ); arr1.InsertAll(arr2); for ( int i = 0; i < arr1.Count(); i++ ) { Print( arr1.Get(i) ); } delete arr2; delete arr1; >> "Dave" >> "Mark" >> "John" >> "Sarah" >> "Cate"

InsertArray()

void InsertArray ( array< T >  other )

inlineprivate

InsertAt() [1/2]

proto int InsertAt ( T  value, int  index  )

private

Inserts element at certain position and moves all elements behind this position by one.

Parameters

value	Element to be inserted
index	Position at which element is inserted. Must be less than Array::GetCardinality()

Returns

Number of elements after insertion

InsertAt() [2/2]

proto int InsertAt ( T  value, int  index  )

private

Inserts element at certain position and moves all elements behind this position by one.

Parameters

value	Element to be inserted
index	Position at which element is inserted. Must be less than Array::GetCardinality()

Returns

Number of elements after insertion

InsertSet()

void InsertSet ( set< T >  other )

inlineprivate

Invert()

void Invert ( )

inlineprivate

References Count, Get(), and Set().

IsInherited()

proto native external bool IsInherited ( typename type  )

private

Returns true when instance is of the type, or inherited one.

Parameters

type	Class type

Returns

bool true when 'clType' is the same as 'type', or inherited one.

if (inst && inst.IsInherited(Widget))
{
    Print("inst is inherited from Widget class!");      
}

IsValidIndex()

bool IsValidIndex ( int  index )

inlineprivate

References Count.

KillThread()

proto native int KillThread	(	Class	owner,
		string	name
	)

Kills thread.

Parameters

owner	Can be NULL for global threads.
name	Name of the first function on stack

Returns

int ???

???

LoadScript()

static proto native ScriptModule LoadScript ( ScriptModule  parentModule, string  scriptFile, bool  listing  )

staticprivate

Do load script and create ScriptModule for it.

Parameters

parentModule	Module
scriptFile	Script path
listing	??

Returns

ScriptModule Loaded scripted module

???

MoveIndex()

int MoveIndex ( int  curr_index, int  move_number  )

inlineprivate

Returns a index in array moved by specific number.

Returns

int Moved index in this array

Print( "Count: "+ my_array.Count() );
Print( "Moved 1:"+ my_array.MoveIndex(2, 1) );
Print( "Moved 3:"+ my_array.MoveIndex(2, 2) );
 
>> "Count: 4"
>> "Moved index 2 by 1: 3";
>> "Moved index 2 by 2: 0";

References Count.

Next()

proto native MapIterator Next ( MapIterator  it )

private

Obsolete() [1/2]

void Obsolete ( string  msg = "" )

inlineprivate

References Obsolete::m_Msg.

Obsolete() [2/2]

void Obsolete

(

string

msg = ""

)

ParseString()

proto int ParseString	(	string	input,
		out string	tokens[]
	)

Parses string into array of tokens returns number of tokens.

Parameters

	input	string String for parse
[out]	tokens	array[] Parsed string in array

Returns

int Number of tokens

string token[2];
int result = ParseString("Hello World", token);
 
for( int i = 0; i < 2; i++ )
{
    Print(token[i]);
}
 
>> 'Hello'
>> 'World'

ParseStringEx()

proto int ParseStringEx	(	inout string	input,
		string	token
	)

Parses one token from input string. Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.

Parameters

[in,out]	input	string String for parse\ Output is without founded token
[out]	token	string Founded string token

Returns

int Type of token

Token types:
 0 - error, no token
 1 - defined token (special characters etc. . / * )
 2 - quoted string. Quotes are removed -> TODO
 3 - alphabetic string
 4 - number
 5 - end of line -> TODO

string input = "Hello*World";
string token1;
string token2;
 
int result1 = ParseStringEx(input, token1);
int result2 = ParseStringEx(input, token2);
 
Print( String( "Token1 = '" + token1 + "' Type = " + result1.ToString() ) );
Print( String( "Token2 = '" + token2 + "' Type = " + result2.ToString() ) );
Print( input );
 
>> 'Toke1 = 'Hello' Type = 3'
>> 'Toke1 = '*' Type = 1'

PrintString()

Obsolete Managed PrintString

(

string

s

)

Helper for printing out string expression. Example: PrintString("Hello " + var);.

Release()

proto native void Release ( )

private

Remove() [1/3]

proto native void Remove ( int  index )

private

Removes element from array. The empty position is replaced by last element, so removal is quite fast but do not retain order.

Parameters

index

Index of element to be removed

Remove() [2/3]

proto native void Remove ( int  index )

private

Removes element from array, but retain all elements ordered.

Parameters

index

Index of element to be removed

Remove() [3/3]

proto void Remove ( TKey  key )

private

Removes element with given key.

RemoveElement()

proto void RemoveElement ( int  i )

private

Removes i:th element with given key. Note: This operation is O(n) complexity. Use with care!

Parameters

i	The position of the element key in the map

RemoveItem() [1/2]

void RemoveItem ( T  value )

inlineprivate

RemoveItem() [2/2]

void RemoveItem ( T  value )

inlineprivate

References Remove().

RemoveItems()

void RemoveItems ( set< T >  other )

inlineprivate

RemoveItemUnOrdered()

void RemoveItemUnOrdered ( T  value )

inlineprivate

References Remove().

RemoveOrdered()

proto native void RemoveOrdered ( int  index )

private

Removes element from array, but retain all elements ordered. It's slower than Remove

Parameters

index

Index of element to be removed

ReplaceKey()

bool ReplaceKey ( TKey  old_key, TKey  new_key  )

inlineprivate

References Get(), Remove(), and Set().

Reserve()

proto native void Reserve ( int  newSize )

private

Resizes the array to given size internally. Is used for optimization purposes when the approx. size is known beforehand

Resize()

proto native void Resize ( int  newSize )

private

Resizes the array to given size. If the newSize is lower than current Count overflowing objects are destroyed. If the newSize is higher than current Count missing elements are initialized to zero (null).

reversearray()

proto void reversearray

(

void

param_array

)

SafeCastType()

private static proto bool SafeCastType ( Class  type, out Class  to, Class  from  )

staticprivate

This function is for internal script usage.

Set() [1/2]

proto void Set ( int  n, T  value  )

private

Sets n-th element to given value.

Set() [2/2]

proto void Set ( TKey  key, TValue  value  )

private

Sets value of element with given key. If element with key not exists, it is created. Note: creating new elements is faster using Insert function.

SetClassVar()

static proto int SetClassVar ( Class  inst, string  varname, int  index, void  input  )

staticprivate

Dynamic write to variable by its name.

Parameters

inst	when inst == NULL, it's for global variable, otherwise it's class member
varname
index	Is index when variable is array
input	Input variable must be of the same type!

Returns

int Returns true(1) when success

Print(myClass.m_Counter);
 
>> m_Counter = 0
 
bool success = EnScript.SetClassVar(myClass, "m_Counter", 0, 5.0);
 
Print(myClass.m_Counter);
Print(success);
 
>> m_Counter = 5
>> success = 1

SetVar()

static proto int SetVar ( out void  var, string  value  )

staticprivate

Sets variable value by value in string.

Parameters

[out]	var
	value

Returns

int

???

ShuffleArray()

void ShuffleArray ( )

inlineprivate

References Count.

Sort() [1/2]

proto native void Sort ( bool  reverse = false )

private

Sorts elements of array, depends on underlaying type.

Sort() [2/2]

proto void Sort	(	void	param_array[],
		int	num
	)

Sorts static array of integers(ascendically) / floats(ascendically) / strings(alphabetically)

Parameters

param_array	array Array to sort
num	int How many items will be sorted in array

Returns

void

string  arrStr[3] = {"Dog", "Car", "Apple"};
Sort(arrStr, 2)
for ( int x = 0; x < 3; x++ )
{
    Print( arrStr[x] );
}
 
>> 'Car'
>> 'Dog'
>> 'Apple'

Referenced by ActionConstructor::ConstructActions(), and EmoteConstructor::ConstructEmotes().

StaticGetType()

static StaticGetType ( typename t  )

inlinestaticprivate

Returns typename of class even without a variable or instance.

Returns

typename class-type

typename eAITypename = StaticGetType(EntityAI);

StaticType()

proto static external StaticType ( )

staticprivate

Returns typename of object's reference.

Returns

typename class-type

EntityAI e;
Print(e.StaticType());
 
>> 'EntityAI'

String()

string String

(

string

s

)

Helper for passing string expression to functions with void parameter. Example: Print(String("Hello " + var));.

Referenced by ScriptConsoleEnfScriptTab::Add(), ScriptConsoleOutputTab::Add(), CalculateLinePointFade(), Hud::DisplayNotifier(), Hud::DisplayTendencyNormal(), Hud::DisplayTendencyTemp(), Hud::InitBadgesAndNotifiers(), ScriptedWidgetEventHandler::Remove(), and ScriptedWidgetEventHandler::Show().

Swap() [1/2]

proto native void Swap ( notnull array< T >  other )

private

Swaps the contents of this and other arrays. Does not involve copying of the elements.

Swap() [2/2]

proto native void Swap ( set< T >  other )

private

SwapItems()

void SwapItems ( int  item1_index, int  item2_index  )

inlineprivate

References Get(), and Set().

ThreadFunction()

proto owned string ThreadFunction	(	Class	owner,
		string	name,
		int	backtrace,
		out int	linenumber
	)

Debug function. Returns current function on stack of the thread.

Parameters

owner	Can be NULL for global threads
name	Name of the first function on stack
backtrace	???
linenumber	???

Returns

string ???

???

ToString()

proto external string ToString ( )

private

Type()

proto native external Type ( )

private

Returns typename of object's class.

Returns

typename class-type

Man player = g_Game.GetPlayer();
typename type = player.Type();
Print(type.ToString());
 
>> 'Man'

Watch()

static proto void Watch ( void  var, int  flags  )

staticprivate

Debug tool for watching certain variable. Invokes debugger whenever is variable used.

Parameters

var	Certain variable for watching
flags	= 1 means it will break even when not modified

Returns

void

~EnScript()

private void ~EnScript ( )

inlineprivate

~ScriptModule()

private void ~ScriptModule ( )

private

Variable Documentation

m_Msg [1/2]

string m_Msg

private

Referenced by Obsolete::Obsolete().

m_Msg [2/2]

string m_Msg

PrintString

class array< Class T > PrintString

Referenced by RecoilBase::ApplyMouseOffset(), StatDebugObject::Debug(), RemotePlayerDamageDebug::Debug(), DebugDamage(), WeaponDebug::DrawLineOfFireCameraHybrid(), PluginRecipesManagerBase::GenerateHumanReadableRecipeList(), GetPlugin(), PluginFileHandler::LoadConfigFile(), ScriptedWidgetEventHandler::OnDoubleClick(), ScriptedWidgetEventHandler::OnDrag(), ScriptedWidgetEventHandler::OnDraggingOver(), ScriptedWidgetEventHandler::OnDrop(), ScriptedWidgetEventHandler::OnDropReceived(), ScriptedWidgetEventHandler::OnMouseButtonDown(), ScriptedWidgetEventHandler::OnMouseButtonUp(), ScriptedWidgetEventHandler::OnMouseEnter(), OnRPC(), PluginBase::OnSpawnErrorReport(), PluginRecipesManagerBase::PrintCache(), PluginBase::PrintedDebug(), PrintElements(), HandsContainer::ShowActionMenuCombine(), ManBase::ShowUnconsciousScreen(), and RecoilBase::Update().