Category:OSSL Functions

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Notecards)
(Deprecated)
 
(144 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== Current OSSL Functions Implemented  ==
+
<div style="background-color:#FFA500; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
 +
This information is relative to (almost) the last OpenSimulator Development version. In some cases it may not apply to older versions.
 +
</div>
  
'''!''' Partial Update OpenSim DEV 0.9.1
+
== OSSL function permissions ==
 +
Several OSSL functions have execution permission control to prevent abusive or dangerous use.
  
 +
This is controlled by files osslDefaultEnable.ini and osslEnable.ini, by default in folder bin/config-include<br>
 +
The use logic of these two files is identical to OpenSimDefaults.ini and OpenSim.ini
  
'''!''' Partial Update OpenSim DEV 0.9.0 #2c8c25a0 August 15, 2017
+
Older OpenSimulator versions only used file osslEnable.ini.<br>
 +
Some older OpenSimulator versions had checks for all OSSLfunctions.<br>
 +
That made no sense for many functions, so now many are always allowed wasting no time on useless checks.<br>
  
 +
For details about these permissions, please read file OpenSimDefaults.ini
  
'''!''' Partial Update December.10.2010 With commits of this date some functions have been corrected to use standard OSSL conventions. The previous functions are tagged as deprecated with their replacement shown. The deprecated functions will advise you with a message that they have been deprecated and to use the new os function name instead. Further updates are needed to complete the existing list of os functions.
+
= osslDefaultEnable.ini =
 +
This file contains the defaults for OSSL execution permissions set by OpenSimulator dev team.<br>
 +
Instead of changing defaults defined in code, the OpenSimulator dev team may decide to just make changes in this file.<br>
 +
This file was not present on older OpenSimulator versions.<br>
 +
If you need to change permissions, copy the respective entry to osslEnable.ini and modify there.<br>
  
 +
= osslEnable.ini =
 +
This file contains the local overrides for OSSL permissions.<br>
 +
It is read after osslDefaultEnable.ini, and any entry on it replaces the old one.<br>
 +
This file is not provided on code packages, an osslEnable.ini.example is.<br>
 +
At first time setup, you will need to copy the example file to osslEnable.ini and then edit it for your needs, using osslDefaults.ini as reference.<br>
 +
This was the only file used on older OpenSimulator versions.
  
Each of these functions may have threat level associated with it. See [[Threat level]] for more information and an overview of each function's level.
+
== Current OSSL Functions Implemented  ==
 
+
  
 
=== Avatars ===
 
=== Avatars ===
 
{{multicol}}
 
{{multicol}}
 +
*[[osAddAgentToGroup]]
 
*[[osAgentSaveAppearance]]
 
*[[osAgentSaveAppearance]]
 
*[[osAvatarName2Key]]
 
*[[osAvatarName2Key]]
Line 21: Line 39:
 
*[[osCauseDamage]]  
 
*[[osCauseDamage]]  
 
*[[osCauseHealing]]
 
*[[osCauseHealing]]
 +
*[[osDetectedCountry]]
 
*[[osDropAttachment]]
 
*[[osDropAttachment]]
 
*[[osDropAttachmentAt]]
 
*[[osDropAttachmentAt]]
Line 31: Line 50:
 
*[[osForceDropAttachmentAt]]
 
*[[osForceDropAttachmentAt]]
 
*[[osForceOtherSit]]
 
*[[osForceOtherSit]]
{{multicol-break}}
 
 
*[[osGetAgentIP]]  
 
*[[osGetAgentIP]]  
 
*[[osGetAgents]]
 
*[[osGetAgents]]
 +
{{multicol-break}}
 +
*[[osGetAgentCountry]] {{new}}
 
*[[osGetAvatarHomeURI]]
 
*[[osGetAvatarHomeURI]]
 
*[[osGetAvatarList]]  
 
*[[osGetAvatarList]]  
 
*[[osGetGender]]
 
*[[osGetGender]]
*[[osGetHealRate]] {{new}}
+
*[[osGetHealRate]]
 
*[[osGetHealth]]
 
*[[osGetHealth]]
 
*[[osGetNumberOfAttachments]]
 
*[[osGetNumberOfAttachments]]
 +
*[[osGrantScriptPermissions]]
 
*[[osInviteToGroup]]
 
*[[osInviteToGroup]]
 
*[[osKickAvatar]]
 
*[[osKickAvatar]]
 
*[[osOwnerSaveAppearance]]
 
*[[osOwnerSaveAppearance]]
*[[osSetHealRate]] {{new}}
+
*[[osRevokeScriptPermissions]]
*[[osSetHealth]] {{new}}
+
*[[osSetHealRate]]
*[[osSetOwnerSpeed]] {{new}}
+
*[[osSetHealth]]
 +
*[[osSetOwnerSpeed]]
 
*[[osSetSpeed]]
 
*[[osSetSpeed]]
 +
*[[osLocalTeleportAgent]] {{E}}
 
*[[osTeleportAgent]]  
 
*[[osTeleportAgent]]  
 
*[[osTeleportOwner]]  
 
*[[osTeleportOwner]]  
 +
*[[osReplaceAgentEnvironment]] {{new}}
 
{{multicol-end}}
 
{{multicol-end}}
  
Line 55: Line 79:
 
*[[osIsNpc]]
 
*[[osIsNpc]]
 
*[[osNpcCreate]]
 
*[[osNpcCreate]]
*[[osGetNpcList]] {{new}}
+
*[[osGetNpcList]]
 
*[[osNpcGetPos]]
 
*[[osNpcGetPos]]
 
*[[osNpcGetRot]]
 
*[[osNpcGetRot]]
Line 67: Line 91:
 
{{multicol-break}}
 
{{multicol-break}}
 
*[[osNpcSay]]
 
*[[osNpcSay]]
*[[osNpcSetProfileAbout]] {{new}}
+
*[[osNpcSayTo]]
*[[osNpcSetProfileImage]] {{new}}
+
*[[osNpcSetProfileAbout]]
 +
*[[osNpcSetProfileImage]]
 
*[[osNpcSetRot]]
 
*[[osNpcSetRot]]
 
*[[osNpcShout]]
 
*[[osNpcShout]]
Line 79: Line 104:
 
{{multicol-end}}
 
{{multicol-end}}
  
=== Prim Manipulation ===
+
=== Prim ===
 
{{multicol}}
 
{{multicol}}
*[[osClearInertia]] {{new}}
+
*[[osClearInertia]]
 +
*[[osClearObjectAnimations]] {{new}}
 +
*[[osDie]]
 
*[[osForceBreakAllLinks]]
 
*[[osForceBreakAllLinks]]
 
*[[osForceBreakLink]]  
 
*[[osForceBreakLink]]  
 
*[[osForceCreateLink]]
 
*[[osForceCreateLink]]
*[[osGetInertiaData]] {{new}}
+
*[[osGetInertiaData]]
 +
*[[osGetInventoryItemKey]]
 +
*[[osGetInventoryName]]
 
*[[osGetInventoryDesc]]
 
*[[osGetInventoryDesc]]
*[[osGetLinkNumber]] {{new}}
+
*[[osGetInventoryLastOwner]]
 +
*[[osGetLastChangedEventKey]]
 +
*[[osGetLinkNumber]]
 
*[[osGetLinkPrimitiveParams]]  
 
*[[osGetLinkPrimitiveParams]]  
 
*[[osGetPrimitiveParams]]  
 
*[[osGetPrimitiveParams]]  
 
*[[osGetRezzingObject]]
 
*[[osGetRezzingObject]]
 +
*[[osGetSitActiveRange]] {{new}}
 +
*[[osGetLinkSitActiveRange]] {{new}}
 
{{multicol-break}}
 
{{multicol-break}}
 +
*[[osGetStandTarget]] {{new}}
 +
*[[osGetLinkStandTarget]] {{new}}
 
*[[osListenRegex]]
 
*[[osListenRegex]]
 
*[[osMessageAttachments]]
 
*[[osMessageAttachments]]
 
*[[osMessageObject]]
 
*[[osMessageObject]]
*[[osSetInertia]] {{new}}
+
*[[osSetInertia]]
*[[osSetInertiaAsBox]] {{new}}
+
*[[osSetInertiaAsBox]]
*[[osSetInertiaAsCylinder]] {{new}}
+
*[[osSetInertiaAsCylinder]]
*[[osSetInertiaAsSphere]] {{new}}
+
*[[osSetInertiaAsSphere]]
 
*[[osSetPrimitiveParams]]  
 
*[[osSetPrimitiveParams]]  
 
*[[osSetProjectionParams]]
 
*[[osSetProjectionParams]]
*[[osTeleportObject]] {{new}}
+
*[[osSetSitActiveRange]] {{new}}
 +
*[[osSetLinkSitActiveRange]] {{new}}
 +
*[[osSetStandTarget]] {{new}}
 +
*[[osSetLinkStandTarget]] {{new}}
 +
*[[osTeleportObject]]
 +
*[[osVolumeDetect]]
 
{{multicol-end}}
 
{{multicol-end}}
  
=== Prim Drawing ===
+
=== Prim Drawing / Dynamic Texture ===
 
{{multicol}}
 
{{multicol}}
 
*[[osDrawEllipse]]
 
*[[osDrawEllipse]]
*[[osDrawFilledEllipse]] {{new}}
+
*[[osDrawFilledEllipse]]
 
*[[osDrawFilledPolygon]]
 
*[[osDrawFilledPolygon]]
 
*[[osDrawFilledRectangle]]
 
*[[osDrawFilledRectangle]]
Line 114: Line 154:
 
*[[osDrawPolygon]]
 
*[[osDrawPolygon]]
 
*[[osDrawRectangle]]
 
*[[osDrawRectangle]]
*[[osDrawResetTransform]] {{new}}
+
*[[osDrawResetTransform]]
*[[osDrawRotationTransform]] {{new}}
+
*[[osDrawRotationTransform]]
{{multicol-break}}
+
*[[osDrawScaleTransform]]
*[[osDrawScaleTransform]] {{new}}
+
 
*[[osDrawText]]
 
*[[osDrawText]]
*[[osDrawTranslationTransform]] {{new}}
+
*[[osDrawTranslationTransform]]
 
*[[osGetDrawStringSize]]
 
*[[osGetDrawStringSize]]
 +
{{multicol-break}}
 
*[[osMovePen]]
 
*[[osMovePen]]
 
*[[osSetFontName]]
 
*[[osSetFontName]]
Line 127: Line 167:
 
*[[osSetPenColor]]
 
*[[osSetPenColor]]
 
*[[osSetPenSize]]
 
*[[osSetPenSize]]
 +
*[[osSetDynamicTextureData]] {{new}}
 +
*[[osSetDynamicTextureDataFace]] {{new}}
 +
*[[osSetDynamicTextureDataBlend]] {{new}}
 +
*[[osSetDynamicTextureDataBlendFace]]
 +
*[[osSetDynamicTextureURL]] {{new}}
 +
*[[osSetDynamicTextureURLBlend]] {{new}}
 +
*[[osSetDynamicTextureURLBlendFace]] {{new}}
 
{{multicol-end}}
 
{{multicol-end}}
 
=== Dynamic Texture ===
 
*[[osSetDynamicTextureData]]
 
*[[osSetDynamicTextureDataBlend]]
 
*[[osSetDynamicTextureDataBlendFace]]
 
*[[osSetDynamicTextureDataFace]] {{new}}
 
*[[osSetDynamicTextureURL]]
 
*[[osSetDynamicTextureURLBlend]]
 
*[[osSetDynamicTextureURLBlendFace]]
 
  
 
=== Notecard ===
 
=== Notecard ===
Line 145: Line 183:
  
 
=== Sound ===
 
=== Sound ===
*[[osAdjustSoundVolume]] {{new}}
+
{{multicol}}
*[[osCollisionSound]] {{new}}
+
*[[osAdjustSoundVolume]]
*[[osLoopSound]] {{new}}
+
*[[osCollisionSound]]
*[[osLoopSoundMaster]] {{new}}
+
*[[osLoopSound]]
*[[osLoopSoundSlave]] {{new}}
+
*[[osLoopSoundMaster]]
*[[osPlaySound]] {{new}}
+
*[[osLoopSoundSlave]]
*[[osPlaySoundSlave]] {{new}}
+
*[[osPlaySound]]
*[[osPreloadSound]] {{new}}
+
{{multicol-break}}
*[[osSetSoundRadius]] {{new}}
+
*[[osPlaySoundSlave]]
*[[osStopSound]] {{new}}
+
*[[osPreloadSound]]
*[[osTriggerSound]] {{new}}
+
*[[osSetSoundRadius]]
*[[osTriggerSoundLimited]] {{new}}
+
*[[osStopSound]]
 +
*[[osTriggerSound]]
 +
*[[osTriggerSoundLimited]]
 +
{{multicol-end}}
  
 
=== HTTP ===
 
=== HTTP ===
 
*[[osRequestSecureURL]]
 
*[[osRequestSecureURL]]
 
*[[osRequestURL]]
 
*[[osRequestURL]]
 +
*[[osSetContentType]]
  
=== Parcels ===
+
=== Parcel ===
 
*[[osParcelJoin]]  
 
*[[osParcelJoin]]  
 
*[[osParcelSubdivide]]  
 
*[[osParcelSubdivide]]  
 +
*[[osGetParcelDwell]]
 
*[[osSetParcelDetails]]
 
*[[osSetParcelDetails]]
  
=== Terrains ===
+
=== Terrain ===
 
*[[osGetTerrainHeight]]  
 
*[[osGetTerrainHeight]]  
 
*[[osSetTerrainHeight]]  
 
*[[osSetTerrainHeight]]  
Line 174: Line 217:
 
*[[osTerrainFlush]]
 
*[[osTerrainFlush]]
  
=== WindLights ===
+
=== Region / Parcel Environment ===
 
{{multicol}}
 
{{multicol}}
 
*[[osGetCurrentSunHour]]  
 
*[[osGetCurrentSunHour]]  
*[[osGetSunParam]]  
+
*[[osGetApparentTime]] {{new}}
 +
*[[osGetApparentTimeString]] {{new}}
 +
*[[osGetApparentRegionTime]] {{new}}
 +
*[[osGetApparentRegionTimeString]] {{new}}
 +
 
 
*[[osGetWindParam]]  
 
*[[osGetWindParam]]  
*[[osSetEstateSunSettings]]
 
*[[osSetRegionSunSettings]]
 
 
{{multicol-break}}
 
{{multicol-break}}
 
*[[osSetRegionWaterHeight]]  
 
*[[osSetRegionWaterHeight]]  
*[[osSetSunParam]]
 
 
*[[osSetWindParam]]
 
*[[osSetWindParam]]
*[[osWindActiveModelPluginName]]  
+
*[[osWindActiveModelPluginName]]
 +
*[[osReplaceParcelEnvironment]] {{new}}
 +
*[[osReplaceRegionEnvironment]] {{new}}
 +
*[[osResetEnvironment]] {{new}}
 
{{multicol-end}}
 
{{multicol-end}}
  
=== Grid Information ===
+
=== Grid / Region Information ===
 
{{multicol}}
 
{{multicol}}
 
*[[osCheckODE]]
 
*[[osCheckODE]]
Line 198: Line 245:
 
*[[osGetGridNick]]  
 
*[[osGetGridNick]]  
 
*[[osGetMapTexture]]  
 
*[[osGetMapTexture]]  
*[[osGetPhysicsEngineName]] {{new}}
+
*[[osGetPhysicsEngineName]]
 
*[[osGetPhysicsEngineType]]
 
*[[osGetPhysicsEngineType]]
 
{{multicol-break}}
 
{{multicol-break}}
Line 206: Line 253:
 
*[[osGetScriptEngineName]]  
 
*[[osGetScriptEngineName]]  
 
*[[osGetSimulatorMemory]]  
 
*[[osGetSimulatorMemory]]  
*[[osGetSimulatorMemoryKB]] {{new}}
+
*[[osGetSimulatorMemoryKB]]
 
*[[osGetSimulatorVersion]]  
 
*[[osGetSimulatorVersion]]  
 
*[[osLoadedCreationDate]]  
 
*[[osLoadedCreationDate]]  
Line 215: Line 262:
 
=== Administration ===
 
=== Administration ===
 
*[[osConsoleCommand]]  
 
*[[osConsoleCommand]]  
*[[osRegionNotice]] {{new}}
+
*[[osRegionNotice]]
 
*[[osRegionRestart]]  
 
*[[osRegionRestart]]  
 
*[[osSetParcelMediaURL]]  
 
*[[osSetParcelMediaURL]]  
 +
*[[osSetParcelMusicURL]] {{new}}
 
*[[osSetParcelSIPAddress]]
 
*[[osSetParcelSIPAddress]]
*[[osSetPrimFloatOnWater]]
 
  
=== Script Permissions (Pending Peer Review)===
+
=== Script ===
*[[osGrantScriptPermissions]]
+
*[[osResetAllScripts]]
*[[osRevokeScriptPermissions]]
+
 
 +
=== String Manipulation ===
 +
{{multicol}}
 +
* [[osFormatString]]
 +
* [[osMatchString]]
 +
* [[osRegexIsMatch]]
 +
* [[osReplaceString]]
 +
* [[osStringSubString]]
 +
* [[osStringStartsWith]]
 +
{{multicol-break}}
 +
* [[osStringEndsWith]]
 +
* [[osStringIndexOf]]
 +
* [[osStringLastIndexOf]]
 +
* [[osStringRemove]]
 +
* [[osStringReplace]]
 +
{{multicol-end}}
  
 
=== Misc ===
 
=== Misc ===
 
{{multicol}}
 
{{multicol}}
*[[osAngleBetween]] {{new}}
+
*[[osAngleBetween]]
*[[osApproxEquals]] {{new}}
+
*[[osApproxEquals]]
*[[osDie]] {{new}}
+
*[[osGetPSTWallclock]]
*[[osFormatString]]
+
 
*[[osIsUUID]]
 
*[[osIsUUID]]
 +
*[[osIsNotValidNumber]]
 
*[[osKey2Name]]  
 
*[[osKey2Name]]  
 
*[[osList2Double]]  
 
*[[osList2Double]]  
*[[osMatchString]]
 
 
*[[osMax]]
 
*[[osMax]]
 
*[[osMin]]
 
*[[osMin]]
 
{{multicol-break}}
 
{{multicol-break}}
*[[osReplaceString]]
+
*[[osRound]]
*[[osRegexIsMatch]]
+
*[[osSlerp]]
*[[osRound]] {{new}}
+
*[[osSetContentType]]
+
*[[osSetStateEvents]]  
+
 
*[[osUnixTimeToTimestamp]]  
 
*[[osUnixTimeToTimestamp]]  
*[[osVecDistSquare]] {{new}}
+
*[[osVecDistSquare]]
*[[osVecMagSquare]] {{new}}
+
*[[osVecMagSquare]]
*[[osVolumeDetect]] {{new}}
+
 
{{multicol-end}}
 
{{multicol-end}}
  
Line 258: Line 315:
 
*<strike>osWindParamGet</strike> - Use [[osGetWindParam]]
 
*<strike>osWindParamGet</strike> - Use [[osGetWindParam]]
 
*<strike>osWindParamSet</strike> - Use [[osSetWindParam]]
 
*<strike>osWindParamSet</strike> - Use [[osSetWindParam]]
 +
*[[osGetSunParam]]
 +
*[[osSetEstateSunSettings]]
 +
*[[osSetRegionSunSettings]]
 +
*[[osSetSunParam]]
 +
*[[osSetPrimFloatOnWater]]
  
 
== See Also  ==
 
== See Also  ==

Latest revision as of 00:58, 2 December 2020

This information is relative to (almost) the last OpenSimulator Development version. In some cases it may not apply to older versions.

Contents

[edit] OSSL function permissions

Several OSSL functions have execution permission control to prevent abusive or dangerous use.

This is controlled by files osslDefaultEnable.ini and osslEnable.ini, by default in folder bin/config-include
The use logic of these two files is identical to OpenSimDefaults.ini and OpenSim.ini

Older OpenSimulator versions only used file osslEnable.ini.
Some older OpenSimulator versions had checks for all OSSLfunctions.
That made no sense for many functions, so now many are always allowed wasting no time on useless checks.

For details about these permissions, please read file OpenSimDefaults.ini

[edit] osslDefaultEnable.ini

This file contains the defaults for OSSL execution permissions set by OpenSimulator dev team.
Instead of changing defaults defined in code, the OpenSimulator dev team may decide to just make changes in this file.
This file was not present on older OpenSimulator versions.
If you need to change permissions, copy the respective entry to osslEnable.ini and modify there.

[edit] osslEnable.ini

This file contains the local overrides for OSSL permissions.
It is read after osslDefaultEnable.ini, and any entry on it replaces the old one.
This file is not provided on code packages, an osslEnable.ini.example is.
At first time setup, you will need to copy the example file to osslEnable.ini and then edit it for your needs, using osslDefaults.ini as reference.
This was the only file used on older OpenSimulator versions.

[edit] Current OSSL Functions Implemented

[edit] Avatars

[edit] NPCs

[edit] Prim

[edit] Prim Drawing / Dynamic Texture

[edit] Notecard

[edit] Sound

[edit] HTTP

[edit] Parcel

[edit] Terrain

[edit] Region / Parcel Environment

[edit] Grid / Region Information

[edit] Administration

[edit] Script

[edit] String Manipulation

[edit] Misc

[edit] Deprecated

[edit] See Also

Pages in category "OSSL Functions"

The following 200 pages are in this category, out of 227 total.

(previous 200) (next 200)

L

O

O cont.

O cont.

(previous 200) (next 200)
Personal tools
General
About This Wiki